Runtime components : Channels components : Java Client/Server Messaging APIs : Reference : Java C/S Messaging APIs external definitions
  
Java C/S Messaging APIs external definitions
The system configuration file (btt.xml) file for the server has the following fields in the channel handler definition for the C/S Messaging API. Each device type supported by the C/S Messaging API has a definition in the file.
Channel handler field tags for the Java C/S Messaging APIs
requestHandler
Specifies the device request handler to perform the integration with the application. Mandatory.
Default: com.ibm.btt.cs.java.JavaRequestHandler
presentationHandler
Specifies the device presentation handler to render the information to the client. Mandatory.
Default: com.ibm.btt.cs.java.JavaPresentationHandler
cookies
Specifies whether the session will be maintained by WebSphere Application Server (true) or by the toolkit internally (false.) Optional.
The default is false.
defaultProcessesTimeout
OPTIONAL. Specifies the default expiration time for the HTML processors. If the value is 0, the processors never expire. This value determines when the CSServer checks for expired processors. (Note: You can also configure the inactivity timeout per processor instance by setting a value in the processorTimeout attribute of the processor tag.) When it detects an expired processor, the CSServer fires a new CSProcessorInactivityEvent. The application must handle this event and perform whatever housekeeping process is required to free as much memory as possible. The fired event provides the identifier of the expired processor and the identifier of the session under which the processor was created. HtmlProcessorManager provides the required protocol to remove the information related to a specific processor from the processors table.
This tag has a default value of 0.
Example:
<kColl id="channelHandlers">
<kColl id="java">
<field id="requestHandler"
value="com.ibm.btt.cs.java.JavaRequestHandler"/>
<field id="presentationHandler"
value="com.ibm.btt.cs.java.JavaPresentationHandler"/>
<field id="cookies" value="true"/>
</kColl>
</kColl>
The system configuration file (btt.xml) file for the client can have the following attributes for the CSClient definition. Note that because the configuration information can vary for each client type, the startup applet may specify this information as parameters as an alternative to the definition.
CSClient tag attributes
serverName
The name of the CSServer to which the CSClient connects. This parameter includes the server address and the port number. The default is the server downloading the applet code.
Example: http://www.xxx.yyy.zzz:80
usedForEventNotification
Indicates whether the current client/server session is used in server-to-client event notifications. Possible values are:
true
false (default)
permanentConnectionForEvents
The type of connection established between the server and client for event notification. A permanent connection maintains a thread in the server to pass events to the client. A dynamic connection uses a socket that closes once the server has passed the event to the client. Possible values are:
true (default)
false
eventsPort
The port to which the client listens for events when the connection between the server and client is dynamic. The default value is 8082.
receiveReplyAfterSynchronousSendTimout
Indicates whether the Client/Server Mechanism sends a CSReplyEvent when the response to a timed out synchronous request arrives at the client. The CSReplyEvent contains the ID of the timed out request.
Possible values are:
true
false (default)
reconnectionAttempts
The maximum number of attempts to re-establish the connection.
The default is 20.
timeBetweenReconnection Attempts
When the session is down, the time between reconnection attempts, specified in milliseconds.
The default is 10000.
enableSSL
Enables this CSClient instance to work with SSL. Possible values are:
true
false (default)
SSLEnabler
Class implementing the interface SSLEnabler that provides SSL logic.
The default is: com.ibm.btt.cs.servlet.DSEJsseEnablerForIbm.
enabledCipherSuites
Set of cipher suites that the client wants to work with, separated by spaces. Check the JSSE documentation for naming conventions.
The default value is null, which means that the default cipher suites enabled by the provider will be used.
keyStoreType
The file type of the keystore and truststore files.
The default value is the javax.net.ssl.trustStoreType System property.
srvPublicKeyPath
Path of the file where the server public key is stored.
srvPublicKeyPw
Password to access the server public key file.
trustAlgorithm
Algorithm used to check the identity of the peer.
The default value is the Sun.ssl.trustmanager.type System property.
clientAuthentication
Enables this instance to work with client authentication. Possible values are:
true
false (default)
clientKeyPairPath
Path of the file where the client's public and private key pair are stored.
clientKeyPairPw
Password to access the client key pair path.
useProxy
Indicates if the client/server session has to be established through a proxy. The possible values are:
true
false (default)
proxyHost
If useProxy is true, this tag indicates the proxy name (IP address).
proxyPort
If useProxy is true, this tag indicates the proxy port number.
serverCredentials
Indicates whether the access to the server is protected with a user ID and password pair. The value is specified in the format: username:password
proxyCredentials
Indicates whether the access to the proxy is protected with a user ID and password pair. The value is specified in the format: username:password
defaultOperationTimeout
Indicates the timeout default value for the following methods:
sendAndWait(ClientOperation)
receive(ClientOperation, Integer)
receive(Context, Integer)
keepAliveConnection
Indicates if the keep-alive-connection procedure is to be used. Possible values are:
true (default): The connection is maintained between requests.
false: The connection is re-established for each request.
userAgent
Indicates the client type.
The default is CSClient.
runInSession
Indicates if the client requires that a session has been established prior to sending the request to the server.
The default is true.
setTcpNoDelay
Configures the behavior of the java.net.Socket class, which the Client/Server Mechanism uses to connect to the server.
The default value is true.
sendBufferSize
Configures the behavior of the java.net.Socket class, which the Client/Server Mechanism uses to connect to the server.
The default value is 0.
retryOnError
Determines whether the Client/Server Mechanism retries the request with a new HTTP connection if an exception is thrown while sending a request to the server.
The default value is false.
If the connection attempt fails again, the toolkit chains the original exception to the new exception with the appropriate error code (csS00 or csR00). See Exception codes for a description of these codes.
Go up to
Reference