The outbound TCP/IP adapter properties determine the adapters behavior for output operations. The outbound TCP/IP Adapter Connectivity Map properties are organized into the following sections:
The General Outbound Settings properties provides a general TCP/IP outbound configuration information. This section contains the top-level parameters as displayed in the table.
Table 119 Connectivity Map - General Outbound Settings
Where to Go Next
TCPIP Outbound Settings — TCP/IP Adapter Outbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The TCPIP Outbound Settings properties presents the java Socket options. For more information, see the JDK Javadoc.. The TCP/IP Outbound Settings properties contain the top-level parameters as displayed in the table.
For complete information on options referred to by these base settings, for example, SO_KEEPALIVE, see the appropriate Sun Microsystems Java documentation.
Where to Go Next
TCPIP Outbound Settings - Connection Establishment — TCP/IP Adapter Outbound.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The Client Connection Establishment properties define some of the configuration parameters used to control the connection establishment.
This section of the TCP/IP Outbound Adapter Connectivity Map properties contains the top-level parameters as displayed in the table.
This section is used only when the Connection Type is set as Client.
Name |
Description |
Required Value |
---|---|---|
Specifies the length of time (in milliseconds) the adapter waits before attempting to connect to the external system. |
A number indicating the amount of time (in milliseconds) the adapter waits before attempting to connect. The configured default is 0. |
|
Specifies whether the adapter always attempts to create a new connection when a connection establishment request is received.
|
Select True or False. The configured default is False. |
|
Specifies whether to attempt to re-connect automatically when the adapter gets a matching connection from a container, even though this connection is not valid due to various reasons: for example, the external side of the connection is closed/reset due to the external application's logic. This property only takes effect when the Integration Server has an existing connection in its connection pool, not during an initial triggering when the pool is empty.
|
Select True or False. The configured default is True. |
|
Specifies the maximum number of times the adapter attempts to connect to a specific external TCP/IP destination (host/port) before giving up. |
An integer indicating the number of times the adapter attempts to connect. |
|
Specifies the amount of time (in milliseconds) the adapter waits between attempts to connect to a specific external TCP/IP destination (host/port). |
An integer indicating the amount of time (in milliseconds) the adapter waits between attempts to connect. The configured default is 30000 (or 30 seconds). |
Where to Go Next
TCPIP Outbound Settings - Server Port Binding.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
The Server Port Binding section defines the configuration parameters used for controlling the server port binding. This parameter is used only when the Connection Type is set as Server. The TCP/IP Outbound Settings — Server Port Binding properties contain the top-level parameters as displayed in the table.
Table 122 Connectivity Map - TCPIP Outbound Settings - Server Port Binding
Name |
Description |
Required Value |
---|---|---|
Specifies the maximum number of times the adapter attempts to bind to the specified TCP/IP port on the localhost. |
An integer indicating the number of bind attempts to the specified TCP/IP port on the localhost. |
|
Specifies the amount of time (in milliseconds) the adapter waits between attempts to bind to the specified TCP/IP port on the localhost. |
An integer indicating the amount of time in milliseconds that the adapter attempts to bind to the specified TCP/IP port. The configured default is 30000 (30 seconds). |
Where to Go Next
TCPIP Outbound Settings - Envelope Message.
Related Topics
About Configuring Java CAPS Adapter Connectivity Map Properties
Configuring Java CAPS Project Components for Communication Adapters
Configuring Java CAPS Environment Components for Communications Adapters
These properties are the envelope message format settings for the Outbound adapter. These properties operate in the same way as those for the inbound adapter
This section explains the envelope message format properties for the server. These properties are all associated with TCP/IP enveloping. This section of the Outbound TCP/IP adapter Connectivity Map properties contains the top-level parameters as displayed in the table.
Table 123 Connectivity Map - TCPIP Outbound Settings - Envelope Message
Name |
Description |
Required Value |
||
---|---|---|---|---|
Specifies the envelope type. The envelope type defines where a message starts and stops. |
Enter one of the following properties denoting the envelope type:
The default is BeginEndMarked. |
|||
BeginEndMarked is supported by the properties. Bytes to Read, Ignore Until Char Value, and Store Until Char Value. |
||||
EndMarked is supported by the property Store Until Char Value. |
||||
FixedLength is supported by the properties Bytes to Read. |
||||
LengthPrefixed is supported by the property Width of Length and Numeric Representation. |
||||
MarkedAndFixed is supported by the property Bytes to Read, Ignore Until Char Value, and Store Until Value. |
||||
PerActiveConnection is supported by the property PerActiveConnection. |
||||
Custom is supported by the properties Custom Enveloped Class Name and Custom Defined Property. For optimum performance, use the method receiveEnvelopedMsg() with any enveloped messages. This method uses the envelope as its ending condition, while the other receiving methods, receiveBytes() and receiveString(), use a time-out as their ending condition. Note – For all envelope types, except MarkedAndFixed, the data is just the payload. See MarkedAndFixed for an explanation of how the data is handled by that envelope type. |
||||
Specifies the Java class name to be used when the Envelope Type property is set to Custom. If you are using a custom envelope you have created, using a Java Class, you can import the Java JAR file containing the class into any desired Collaboration, using the Collaboration Editor's file import feature. The class name should be a full qualified class name, such as com.abc.MyClass. The class must implement interfaces
and
For more details, see Customized Enveloping. |
A full Java class name. A full qualified class name, or None if Custom is not the Envelope Type. The configured default is None. |
|||
Used when the Envelope Type value is set to Custom. Specifies a list of user-defined parameters. You can parse this information, such as delimiters, into your customized envelope message implementation. |
A text string. |
|||
Used with the following Envelope Types:
Specifies the number of bytes to read. It is assumed that all Events received by the adapter have the same length. |
An integer indicating the number of bytes. The configured default is 1. |
|||
Used for Envelope Type value LengthPrefixed. Specifies the width of the envelope length. In other words, it dictates the number of digits to be used to represent the length field. |
An integer, the range is 1 to 10. This property must be set to 2 for Network short and 4 for Network long. The configured default value is 1. |
|||
Used for Envelope Type value LengthPrefixed. Specifies how the number representation of the prefixed length is expressed. This value is expressed in one of the following formats:
|
Select one of the following:
The configured default is Decimal. |
|||
Used for the Envelope Types BeginEndMarked and MarkedAndFixed. Specifies the value for the ignore-until (same as begin block) character. All incoming characters are ignored until this character is encountered. |
A decimal ASCII number. The allowed range is 1 to 127. The configured default is 11. |
|||
Used for Envelope Types BeginEndMarked, EndMarked, and MarkedAndFixed. Specifies the character in the End Block or Marker position of the envelope. All incoming characters are stored until this character is encountered. |
A decimal ASCII number. The allowed range is 1 to 127. The configured default is 12. |