Skip Navigation Links | |
Exit Print View | |
Oracle Java CAPS TCP/IP JCA Adapter User's Guide Java CAPS Documentation |
TCP/IP JCA Adapters Contrasted With TCP/IP eWay Adapters
Installing the TCP/IP JCA Adapter
Installing the Design-Time *.nbm Files for the TCP/IP JCA Adapter
To Install the NetBeans Modules for the TCP/IP JCA Adapter
Setting Up the Runtime Environment for the TCP/IP JCA Adapter
To Install the Global RAR for the TCP/IP JCA Adapter
To Add a Connector Connection Pool for the TCP/IP JCA Adapter
To Add a Connector Resource for the TCP/IP JCA Adapter
Configuring the TCP/IP JCA Adapter
Configuring Runtime Properties of a TCP/IP JCA Adapter Pool
To Configure a TCP/IP JCA Adapter Pool
Configuring Design-time Properties of an Individual TCP/IP JCA Adapter Component
To Configure a TCP/IP JCA Adapter Instance
Using the TCP/IP JCA Adapter in an EJB Project
Designing an EJB Module to Use TCP/IP JCA Adapter Code
To Create an EJB Module Project
To Add a TCP/IP JCA Adapter to an EJB Project
To Use TCP/IP-Specific Sample Code
Configuration Settings for the TCP/IP JCA Adapter
TCPIP Outbound Settings -- Client Connection Establishment
This section lists and describes message envelope types and their structures, as well as associated parameters. For all envelope types except MarkedAndFixed, the data is the same as the payload.
Specifies the following two-block structure:
a variable number of bytes of data payload, followed by
a single-byte “store until” character
The “store until” character is not part of the payload; it signals that the data stream has ended.
Specifies the following three-block structure:
a single-byte “ignore until” character, followed by
a variable number of bytes of data payload, followed by
a single-byte “store until” character.
The “ignore until” and “store until” characters are not part of the payload; they signal that the data stream is about to begin and has ended.
Specifies the following one-block structure:
a fixed number of bytes of data payload
The number of bytes of data in the block is specified by the setting of the “bytes to read” parameter.
Specifies the following two-block structure:
a two-part Length block consisting of a Numeric Representation part and a Width-of-Length part, followed by
a fixed number of bytes of data payload
The number of bytes of data in the block is specified by the setting of the “bytes to read” parameter.
Specifies the following four-block structure:
a single-byte “ignore until” character, followed by
a variable number of bytes of data payload, followed by
a single-byte “store until” character, followed by
a fixed number of final bytes to read.
The “ignore until” and “store until” characters are not part of the payload; they signal that the variable-length data stream is about to begin and has ended. The number of bytes of data in the final block is specified by the setting of the “bytes to read” parameter.
Specifies the following one-block structure:
an expected or variable number of bytes of data payload
The connection is closed after the entire (unenveloped) message is sent. If the number of bytes has not been prearranged, then the receiver knows the entire message has been sent because the connection is closed.
Can specify any type of structure, depending on the “custom enveloped class name” and “customer defined property” parameters.
For optimum performance, use the method receiveEnvelopedMsg() with custom messages that are enveloped. This method uses the envelope as its ending condition, whereas other receiving methods — receiveBytes() and receiveString() — use a time-out as their ending condition.
The following parameters support the message structures listed above.
Used only by the Custom message structure, which requires this parameter.
Specifies the Java class name to be used. Must be a fully qualified class name, such as “com.abc.MyClass”. The class must implement interfaces com.stc.connector.tcpip.ext.msg.EnvelopedMsgReceiver and com.stc.connector.tcpip.ext.msg.EnvelopedMsgSender.
Used only by the Custom message structure.
Specifies a list of user-defined parameters. You can parse this information, such as delimiters, into your customized envelope message implementation.
Default: 1
Specifies the number of bytes of data in a FixedLength message or at the end of a MarkedAndFixed message.
Default: 1
Used only by the LengthPrefixed message structure, which requires this parameter.
Specifies the number of “digits” to be used to represent the Length field. Values depend on the Numeric Representation parameter, as follows:
Width can be set from 1 through 10.
Width can be set from 1 through 8.
Width can be set from 1 through 16.
Width must be set to 2.
Width must be set to 4.
Default: Decimal
Used only by the LengthPrefixed message structure, which requires this parameter.
Specifies whether the number is represented in decimal, octal, hexadecimal, network-short, or network-long.
Default: 11 (in other words, ASCII character number hexadecimal 0B).
The “ignore until” character is not part of the data payload; it signals that the variable-length data stream is about to begin (in a BeginEndMarked or MarkedAndFixed message).
Default: 65 (in other words, ASCII character number hexadecimal 41).
The “store until” character is not part of the data payload; it signals that the variable-length data stream has ended (in an EndMarked, BeginEndMarked, or MarkedAndFixed message).