Connector-specific configuration property descriptions

The following is a list of definitions of the above properties.

ServerConfiguration

The set of properties used by the TCP/IP connector for event or inbound processing. In this case, the connector functions as a TCP server and listens for requests on the defined port. Only one server can be defined per connector.

Port

The local port on which the connector listens.

TransportProtocol

The transport protocol this listener implements. For this release, the only available value is "tcp". More values, such as secure TCP/IP, may be added in future releases.

MaxRequestProcessors

Sets the maximum number of threads to run concurrently for handling incoming requests on the defined port.

MaxRequestPoolSize

Sets the maximum number of incoming requests that are cached to be processed simultaneously. At any given moment, the connector can process at most (MaxRequestProcessors + MaxRequestPoolSize) requests.

ServerQueueLength

Sets the length of the server socket queue for incoming connection requests. This value specifies how many incoming requests can be stored at one time before the host starts refusing connections.

Note: The maximum queue length is operating-system-dependent.

ReceiveBufferSize

Sets the suggested network I/O buffer size. This value serves as a hint to the underlying platform's networking code. Increasing buffer size can increase the performance of network I/O for high-volume connections, while decreasing it can help reduce the backlog of incoming data.

SendBufferSize

Sets the suggested network I/O buffer size. This value serves as a hint to the underlying platform's networking code. Increasing buffer size can increase the performance of network I/O for high-volume connections, while decreasing it can help reduce the backlog of incoming data.

KeepAlive

Heartbeat probe. Periodically sends an empty data packet with its current sequence, acknowledgment, and window numbers.

SocketTimeOut

Sets base timeout blocking in milliseconds for the socket. With this option set to a non-zero timeout, a call to read() for this socket will block for only this amount of time. If the timeout expires, a java.io.InterruptedIOException is raised, though the socket is still valid. The option must be enabled prior to entering the blocking operation to have effect. A timeout of zero is interpreted as an infinite timeout.

RetryInterval

Sets the suggested interval the connector in TCP server mode will wait before retrying an operation that has failed. Such situations may include errors that take place while accepting the connection, opening streams for read/write, reading or writing to these streams, and so on.

NumberofRetries

Sets the suggested number of retries the server will make in the error conditions described in RetryInterval.

EnableBase64Encoding

Specifies whether Base64 encoding is enabled or disabled. If the event data that comes into the adapter needs to be Base64-encoded, set this property to true. The data could be Base-64 encoded to preserve the byte values of incoming event data.

ClientConfiguration

The set of properties used by the TCP/IP connector for Service Call Request or outbound processing. In this case, the connector functions as a TCP client and initiates connections with remote hosts defined in the configuration. Multiple clients can be defined per connector.

Clients

This is a hierarchical property that functions only to hold children that define client configurations.

Client1

Specifies the name of the client. Correlates with the ASI specified in the Configuration Meta Object.

Host

Sets the address of the remote host.

Port

Sets the port number of the remote host to which the client needs to connect.

TransportProtocol

Sets the supported transport protocol. For this release, "tcp" is the only available value.

ReceiveBufferSize

Sets the suggested network I/O buffer size. This value serves as a hint to the underlying platform's networking code. Increasing buffer size can increase the performance of network I/O for high-volume connections, while decreasing it can help reduce the backlog of incoming data.

SendBufferSize

Sets the suggested network I/O buffer size. This value serves as a hint to the underlying platform's networking code. Increasing buffer size can increase the performance of network I/O for high-volume connections, while decreasing it can help reduce the backlog of incoming data.

KeepAlive

Heartbeat probe. Periodically sends an empty data packet with its current sequence, acknowledgment, and window numbers.

SocketTimeout

Sets timeout blocking in milliseconds for this socket. When this is set to a non-zero value, a read() call on the InputStream associated with this socket will block for only this amount of time. If the timeout expires, a java.io.InterruptedIOException is raised, though the socket is still valid. The option must be enabled prior to entering the blocking operation to have effect. A timeout of zero is interpreted as an infinite timeout.

MaxAttemptsToRead

Sets the maximum number of times the connector will read from the socket once it starts receiving data. This property allows for the reception of acknowledgment data that is sent in more than one stream. This approach differs from event processing because it is assumed that the amount of data received in an acknowledgment will be small.

RetryInterval

Sets the suggested interval the connector in TCP client mode will wait before retrying an operation that has failed. Such situations may include errors that take place while opening streams for read/write, reading or writing to these streams, and so on.

NumberofRetries

Sets the suggested number of retries the connector in TCP client mode will make in the error conditions described in RetryInterval.

EnableBase64Decoding

Specifies whether Base64 decoding is enabled or disabled. If the request data needs to be Base64-decoded before it is sent to the remote TCP/IP server, set this property to true.

ConnectionPoolingOn

Indicates whether connection pooling is switched on when the adapter connects to the remote TCP/IP server during request processing. If this property is set to false, a new connection is opened for each request.

ConnectionPoolSize

Indicates the number of connections to be created in the connection pool. ConnectionPoolingOn must be set to true for this property to have any effect.

Client2

The name of the next client configuration.

ConfigurationMetaObject

The meta-object that holds static configuration information. See the description of BIA_Static_MO in General meta-objects.

ServiceRegistrationMO

The top-level meta-object that holds service information. See the description of BIA_MO_Service in General meta-objects.

DataHandlerMimeType

Sets the expected MIME type of the incoming data. Used to specify the appropriate data handler.

ErrorClassName

The error class that should be invoked by the adapter when an error occurs during event or request processing. The value of ErrorClassName is the fully qualified name of the class (for example, com.ibm.adapters.protocol.util.TestErrorClass). See Appendix C. Error handling for detailed information.

DataHandlerMetaObjectName

The top-level meta-object that holds data-handler configuration information other than that contained in the service object. See the description of BIA_MO_DataHandler_Default in General meta-objects.

Copyright IBM Corporation 1997, 2005. All Rights Reserved.