org.objectweb.joram.client.jms.FactoryParameters

org.objectweb.joram.client.jms.FactoryParameters Class Reference

List of all members.

Public Member Functions

 FactoryParameters (String host, int port)
 FactoryParameters (String url)
 FactoryParameters ()
String getHost ()
int getPort ()
String getUrl ()
void toReference (Reference ref, String prefix)
void fromReference (Reference ref, String prefix)
Hashtable code (Hashtable h, String prefix)
void decode (Hashtable h, String prefix)
String toString ()

Public Attributes

boolean TcpNoDelay = true
int SoLinger = -1
int SoTimeout = 0
int connectingTimer = 0
int txPendingTimer = 0
int cnxPendingTimer = 0
String socketFactory = SocketFactory.DefaultFactory
boolean asyncSend = false
int queueMessageReadMax = 1
int topicAckBufferMax = 0
boolean multiThreadSync = false
int multiThreadSyncDelay = 1
int multiThreadSyncThreshold = 10
int topicPassivationThreshold = Integer.MAX_VALUE
int topicActivationThreshold = 0
String outLocalAddress = null
int outLocalPort = 0

Detailed Description

A FactoryParameters instance holds a <XA>ConnectionFactory configuration parameters.

Definition at line 38 of file FactoryParameters.java.

Constructor & Destructor Documentation

org.objectweb.joram.client.jms.FactoryParameters.FactoryParameters ( String  host,
int  port 
)

Constructs a FactoryParameters instance.

Parameters:
host Name of host hosting the server to create connections with.
port Port to be used for accessing the server.

Definition at line 179 of file FactoryParameters.java.

org.objectweb.joram.client.jms.FactoryParameters.FactoryParameters ( String  url  ) 

Constructs a FactoryParameters instance.

Parameters:
url joram ha url

Definition at line 189 of file FactoryParameters.java.

org.objectweb.joram.client.jms.FactoryParameters.FactoryParameters (  ) 

Constructs an empty FactoryParameters.

Definition at line 198 of file FactoryParameters.java.

Member Function Documentation

String org.objectweb.joram.client.jms.FactoryParameters.getHost (  ) 

Returns the name of host hosting the server to create connections with.

Returns:
The name of host hosting the server.

Definition at line 206 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.admin.ClusterConnectionFactory.addConnectionFactory(), org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), org.objectweb.joram.client.jms.XATopicConnectionFactory.toString(), org.objectweb.joram.client.jms.XAQueueConnectionFactory.toString(), org.objectweb.joram.client.jms.XAConnectionFactory.toString(), org.objectweb.joram.client.jms.TopicConnectionFactory.toString(), org.objectweb.joram.client.jms.QueueConnectionFactory.toString(), and org.objectweb.joram.client.jms.ConnectionFactory.toString().

int org.objectweb.joram.client.jms.FactoryParameters.getPort (  ) 

Returns the port to be used for accessing the server.

Returns:
The port to be used for accessing the server.

Definition at line 215 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), org.objectweb.joram.client.jms.XATopicConnectionFactory.toString(), org.objectweb.joram.client.jms.XAQueueConnectionFactory.toString(), org.objectweb.joram.client.jms.XAConnectionFactory.toString(), org.objectweb.joram.client.jms.TopicConnectionFactory.toString(), org.objectweb.joram.client.jms.QueueConnectionFactory.toString(), and org.objectweb.joram.client.jms.ConnectionFactory.toString().

String org.objectweb.joram.client.jms.FactoryParameters.getUrl (  ) 

Returns the url to be used for accessing the server.

Returns:
The url to be used for accessing the server.

Definition at line 224 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.ha.tcp.HATcpConnectionFactory.createConnection(), org.objectweb.joram.client.jms.ha.tcp.XAHATcpConnectionFactory.createXAConnection(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), org.objectweb.joram.client.jms.ha.tcp.TopicHATcpConnectionFactory.toString(), and org.objectweb.joram.client.jms.ha.tcp.QueueHATcpConnectionFactory.toString().

Member Data Documentation

boolean org.objectweb.joram.client.jms.FactoryParameters.TcpNoDelay = true

Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm), default value is true.

Definition at line 58 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), and org.objectweb.joram.client.jms.FactoryParameters.toReference().

int org.objectweb.joram.client.jms.FactoryParameters.SoLinger = -1

Enable SO_LINGER with the specified linger time in seconds, if the value is less than 0 then it disables SO_LINGER. Default value is -1.

Definition at line 63 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), and org.objectweb.joram.client.jms.FactoryParameters.toReference().

int org.objectweb.joram.client.jms.FactoryParameters.SoTimeout = 0

Enable/disable SO_TIMEOUT with the specified timeout in milliseconds. The timeout must be > 0. A timeout of zero is interpreted as an infinite timeout. Default value is 0.

Definition at line 69 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), and org.objectweb.joram.client.jms.FactoryParameters.toReference().

int org.objectweb.joram.client.jms.FactoryParameters.connectingTimer = 0

Duration in seconds during which connecting is attempted (connecting might take time if the server is temporarily not reachable); the 0 value is set for connecting only once and aborting if connecting failed.

Definition at line 75 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.tcp.ReliableTcpClient.connect(), org.objectweb.joram.client.jms.tcp.ReliableTcpClient.createSocket(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.tcp.ReliableTcpClient.init(), org.objectweb.joram.client.connector.ManagedConnectionFactoryImpl.setParameters(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

int org.objectweb.joram.client.jms.FactoryParameters.txPendingTimer = 0

Duration in seconds during which a JMS transacted (non XA) session might be pending; above that duration the session is rolled back and closed; the 0 value means "no timer".

Definition at line 81 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.Connection.getTxPendingTimer(), org.objectweb.joram.client.connector.ManagedConnectionFactoryImpl.setParameters(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

int org.objectweb.joram.client.jms.FactoryParameters.cnxPendingTimer = 0

Period in milliseconds between two ping requests sent by the client connection to the server; if the server does not receive any ping request during more than 2 * cnxPendingTimer, the connection is considered as dead and processed as required.

Definition at line 88 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.Connection.Connection(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.tcp.ReliableTcpClient.init(), org.objectweb.joram.client.jms.soap.QueueSoapConnectionFactory.QueueSoapConnectionFactory(), org.objectweb.joram.client.connector.ManagedConnectionFactoryImpl.setParameters(), org.objectweb.joram.client.jms.soap.SoapConnectionFactory.SoapConnectionFactory(), org.objectweb.joram.client.jms.soap.TopicSoapConnectionFactory.TopicSoapConnectionFactory(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

String org.objectweb.joram.client.jms.FactoryParameters.socketFactory = SocketFactory.DefaultFactory

Allows to define a specific factory for socket in order to by-pass compatibility problem between JDK version. Currently there is two factories, The default factory one for JDK since 1.4, and "fr.dyade.aaa.util.SocketFactory13" for JDK prior to 1.4.

Definition at line 96 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.tcp.ReliableTcpClient.createSocket(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), and org.objectweb.joram.client.jms.FactoryParameters.toReference().

boolean org.objectweb.joram.client.jms.FactoryParameters.asyncSend = false

Determines whether the produced messages are asynchronously sent or not (without or with acknowledgement)

Default is false (with ack).

Definition at line 104 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.Connection.getAsyncSend(), org.objectweb.joram.client.connector.ManagedConnectionFactoryImpl.setParameters(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

int org.objectweb.joram.client.jms.FactoryParameters.queueMessageReadMax = 1

The maximum number of messages that can be read at once from a queue.

Default is 1.

Definition at line 111 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.Connection.getQueueMessageReadMax(), and org.objectweb.joram.client.jms.FactoryParameters.toReference().

int org.objectweb.joram.client.jms.FactoryParameters.topicAckBufferMax = 0

The maximum number of acknowledgements that can be buffered in Session.DUPS_OK_ACKNOWLEDGE mode when listening to a topic.

Default is 0.

Definition at line 119 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.Connection.getTopicAckBufferMax(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

boolean org.objectweb.joram.client.jms.FactoryParameters.multiThreadSync = false

Determines whether client threads which are using the same connection are synchronized in order to group together the requests they send.

Definition at line 125 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.Connection.Connection(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.connector.ManagedConnectionFactoryImpl.setParameters(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

int org.objectweb.joram.client.jms.FactoryParameters.multiThreadSyncDelay = 1

The maximum time the threads hang if 'multiThreadSync' is true.

Either they wake up (wait time out) or they are notified (by the first waken up thread).

Default value is 1ms.

Definition at line 135 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.Connection.Connection(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.connector.ManagedConnectionFactoryImpl.setParameters(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

int org.objectweb.joram.client.jms.FactoryParameters.multiThreadSyncThreshold = 10

The maximum numbers of threads that hang if 'multiThreadSync' is true.

Default value is 10 waiting threads.

Definition at line 142 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.Connection.Connection(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

int org.objectweb.joram.client.jms.FactoryParameters.topicPassivationThreshold = Integer.MAX_VALUE

This threshold is the maximum messages number over which the subscription is passivated.

Default is Integer.MAX_VALUE.

Definition at line 150 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.Connection.getTopicPassivationThreshold(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

int org.objectweb.joram.client.jms.FactoryParameters.topicActivationThreshold = 0

This threshold is the minimum messages number below which the subscription is activated.

Default value is 0.

Definition at line 158 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.Connection.getTopicActivationThreshold(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

String org.objectweb.joram.client.jms.FactoryParameters.outLocalAddress = null

This is the local IP address on which the TCP connection is activated.

The value can either be a machine name, such as "java.sun.com", or a textual representation of its IP address.

Definition at line 166 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.tcp.ReliableTcpClient.createSocket(), org.objectweb.joram.client.jms.tcp.ReliableSSLTcpClient.createSocket(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.Connection.getOutLocalAddress(), org.objectweb.joram.client.connector.ManagedConnectionFactoryImpl.setParameters(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

int org.objectweb.joram.client.jms.FactoryParameters.outLocalPort = 0

This is the local IP address port on which the TCP connection is activated

Definition at line 171 of file FactoryParameters.java.

Referenced by org.objectweb.joram.client.jms.FactoryParameters.code(), org.objectweb.joram.client.jms.tcp.ReliableTcpClient.createSocket(), org.objectweb.joram.client.jms.tcp.ReliableSSLTcpClient.createSocket(), org.objectweb.joram.client.jms.FactoryParameters.decode(), org.objectweb.joram.client.jms.FactoryParameters.fromReference(), org.objectweb.joram.client.jms.Connection.getOutLocalPort(), org.objectweb.joram.client.connector.ManagedConnectionFactoryImpl.setParameters(), org.objectweb.joram.client.jms.FactoryParameters.toReference(), and org.objectweb.joram.client.jms.FactoryParameters.toString().

The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:17:51 2008 for joram by  doxygen 1.5.0