java.lang.Object
- org.objectweb.joram.client.jms.FactoryParameters

All Implemented Interfaces:

Serializable, Cloneable
```
public class FactoryParameters
extends Object
implements Serializable, Cloneable
```
A FactoryParameters instance holds a <XA>ConnectionFactory configuration parameters, it allows to configure the related ConnectionFactory.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`boolean`	`asyncSend`	Determines whether the persistent produced messages are asynchronously sent (without acknowledge) or not.
`String`	`clientID`	The clientID used by connection
`int`	`cnxPendingTimer`	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 approximatively more than 3* cnxPendingTimer, the connection is considered as dead and processed as required.
`int`	`compressedMinSize`	This attribute defines the minimum size beyond which the message body is compressed.
`int`	`compressionLevel`	This attribute defines the compression level (0-9) used when the message body is compressed.
`int`	`connectingTimer`	Duration in seconds during which connecting is attempted (connecting might take time if the server is temporarily not reachable).
`private String`	`host`	Name of host hosting the server to create connections with.
`boolean`	`implicitAck`	Determines whether the messages consumed are implicitly acknowledged or not.
`List<MessageInterceptor>`	`inInterceptors`	List of Message interceptors while receiving a message.
`private static String`	`INTERCEPTOR_CLASS_NAME_SEPARATOR`
`private static org.objectweb.util.monolog.api.Logger`	`logger`
`String`	`messageIdPrefix`	This attribute allows to customize the JMS MessageID adding the specified string.
`boolean`	`multiThreadSync`	Determines whether client threads which are using the same connection are synchronized in order to group together the requests they send.
`int`	`multiThreadSyncDelay`	The maximum time the threads hang if 'multiThreadSync' is true.
`int`	`multiThreadSyncThreshold`	The maximum numbers of threads that hang if 'multiThreadSync' is true.
`boolean`	`noAckedQueue`	Set this attribute to true to increase performance.
`List<MessageInterceptor>`	`outInterceptors`	List of Message interceptors while sending a message.
`String`	`outLocalAddress`	This is the local IP address on which the TCP connection is activated.
`int`	`outLocalPort`	This is the local IP address port on which the TCP connection is activated
`private int`	`port`	Port to be used for accessing the server.
`int`	`queueMessageReadMax`	The maximum number of messages that can be read at once from a queue.
`private static long`	`serialVersionUID`	define serialVersionUID for interoperability
`String`	`socketFactory`	Allows to define a specific factory for socket in order to by-pass compatibility problem between JDK version.
`int`	`SoLinger`	Enable SO_LINGER with the specified linger time in seconds, if the value is less than 0 then it disables SO_LINGER.
`int`	`SoTimeout`	Enable/disable SO_TIMEOUT with the specified timeout in milliseconds.
`boolean`	`TcpNoDelay`	Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm), default value is true.
`int`	`topicAckBufferMax`	The maximum number of acknowledgements that can be buffered in Session.DUPS_OK_ACKNOWLEDGE mode when listening to a topic.
`int`	`topicActivationThreshold`	This threshold is the minimum messages number below which the subscription is activated.
`int`	`topicPassivationThreshold`	This threshold is the maximum messages number over which the subscription is passivated.
`int`	`txPendingTimer`	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".
`private String`	`url`	url needed to connect to joram HA

Constructor Summary

Constructors
Constructor	Description
`FactoryParameters()`	Constructs an empty `FactoryParameters`.
`FactoryParameters(String url)`	Constructs a `FactoryParameters` instance.
`FactoryParameters(String host, int port)`	Constructs a `FactoryParameters` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addInInterceptor(String pInterceptorClassName)`
`private void`	`addInterceptor(String pInterceptorClassName, List<MessageInterceptor> pInterceptors)`
`void`	`addOutInterceptor(String pInterceptorClassName)`
`Object`	`clone()`
`Hashtable<String,Object>`	`code(Hashtable<String,Object> h, String prefix)`
`void`	`decode(Hashtable<String,Object> h, String prefix)`
`void`	`fromReference(Reference ref, String prefix)`
`String`	`getHost()`	Returns the name of host hosting the server to create connections with.
`private String`	`getListInInterceptorClassName()`
`private String`	`getListInterceptorClassName(List<MessageInterceptor> pInterceptors)`
`private String`	`getListOutInterceptorClassName()`
`String`	`getMessageIdPrefix()`	Gets the prefix to add to the JMS MessageID of connection created from this factory.
`int`	`getPort()`	Returns the port to be used for accessing the server.
`String`	`getUrl()`	Returns the url to be used for accessing the server.
`boolean`	`removeInInterceptor(String pInterceptorClassName)`
`boolean`	`removeInterceptor(String pInterceptorClassName, List<MessageInterceptor> pInterceptors)`
`boolean`	`removeOutInterceptor(String pInterceptorClassName)`
`private void`	`setListInInterceptorClassName(String pListInterceptorClassName)`
`private void`	`setListInterceptorClassName(String pListInterceptorClassName, List<MessageInterceptor> pInterceptors)`
`private void`	`setListOutInterceptorClassName(String pListInterceptorClassName)`
`void`	`setMessageIdPrefix(String messageIdPrefix)`	Setsthe prefix to add to the JMS MessageID of connection created from this factory.
`void`	`setParameters(Properties properties)`
`void`	`toReference(Reference ref, String prefix)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    define serialVersionUID for interoperability
    
    See Also:
    
    Constant Field Values
  - logger
```
private static org.objectweb.util.monolog.api.Logger logger
```
  - host
```
private String host
```
    Name of host hosting the server to create connections with.
  - port
```
private int port
```
    Port to be used for accessing the server.
  - url
```
private String url
```
    url needed to connect to joram HA
  - clientID
```
public String clientID
```
    The clientID used by connection
  - TcpNoDelay
```
public boolean TcpNoDelay
```
    Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm), default value is true.
  - SoLinger
```
public int SoLinger
```
    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.
  - SoTimeout
```
public int SoTimeout
```
    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.
  - connectingTimer
```
public int connectingTimer
```
    Duration in seconds during which connecting is attempted (connecting might take time if the server is temporarily not reachable). A value of zero is interpreted as an infinite timeout. The connection will then block until established or a TCP error occurs.
    The default value is 30.
  - txPendingTimer
```
public int txPendingTimer
```
    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".
    The default value is 0 (no timer).
  - cnxPendingTimer
```
public int cnxPendingTimer
```
    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 approximatively more than 3* cnxPendingTimer, the connection is considered as dead and processed as required.
  - socketFactory
```
public String socketFactory
```
    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 SocketFactory13 for JDK prior to 1.4.
  - implicitAck
```
public boolean implicitAck
```
    Determines whether the messages consumed are implicitly acknowledged or not. When true messages are immediately removed from queue when delivered.
  - asyncSend
```
public boolean asyncSend
```
    Determines whether the persistent produced messages are asynchronously sent (without acknowledge) or not.
    Messages sent asynchronously may be lost if a failure occurs before the message is persisted on the server.
    Non persistent messages are always sent without acknowledgment.
    Default is false, persistent messages are sent with acknowledge.
  - queueMessageReadMax
```
public int queueMessageReadMax
```
    The maximum number of messages that can be read at once from a queue.
    Default is 1.
  - topicAckBufferMax
```
public int topicAckBufferMax
```
    The maximum number of acknowledgements that can be buffered in Session.DUPS_OK_ACKNOWLEDGE mode when listening to a topic.
    Default value is 10.
  - multiThreadSync
```
public boolean multiThreadSync
```
    Determines whether client threads which are using the same connection are synchronized in order to group together the requests they send.
  - multiThreadSyncDelay
```
public int multiThreadSyncDelay
```
    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.
  - multiThreadSyncThreshold
```
public int multiThreadSyncThreshold
```
    The maximum numbers of threads that hang if 'multiThreadSync' is true.
    Default value is 10 waiting threads.
  - topicPassivationThreshold
```
public int topicPassivationThreshold
```
    This threshold is the maximum messages number over which the subscription is passivated.
    Default is Integer.MAX_VALUE.
  - topicActivationThreshold
```
public int topicActivationThreshold
```
    This threshold is the minimum messages number below which the subscription is activated.
    Default value is 0.
  - outLocalAddress
```
public String outLocalAddress
```
    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.
  - outLocalPort
```
public int outLocalPort
```
    This is the local IP address port on which the TCP connection is activated
  - inInterceptors
```
public final List<MessageInterceptor> inInterceptors
```
    List of Message interceptors while receiving a message.
    These interceptors are called when Session#receive() is called.
    The execution follows the order of the elements within the list.
    This property is facultative. If set, then the MessageInterceptor handle callback method of the IN interceptors} are called.
  - outInterceptors
```
public final List<MessageInterceptor> outInterceptors
```
    List of Message interceptors while sending a message.
    These interceptors are called when Session#send() is called.
    The execution follows the order of the elements within the list.
    This property is facultative. If set, then the MessageInterceptor handle callback method of the OUT interceptors} are called.
  - compressedMinSize
```
public int compressedMinSize
```
    This attribute defines the minimum size beyond which the message body is compressed. The default value is 0 (no compression).
  - compressionLevel
```
public int compressionLevel
```
    This attribute defines the compression level (0-9) used when the message body is compressed. The default value is 1 (Deflater.BEST_SPEED).
  - noAckedQueue
```
public boolean noAckedQueue
```
    Set this attribute to true to increase performance. The default value is false (use the AckedQueue)
  - messageIdPrefix
```
public String messageIdPrefix
```
    This attribute allows to customize the JMS MessageID adding the specified string. This value is overloaded by the property org.objectweb.joram.client.jms.messageid.prefix if it defined. By default empty.
  - INTERCEPTOR_CLASS_NAME_SEPARATOR
```
private static final String INTERCEPTOR_CLASS_NAME_SEPARATOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FactoryParameters
```
public 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.
  - FactoryParameters
```
public FactoryParameters(String url)
```
    Constructs a FactoryParameters instance.
    
    Parameters:
    
    url - joram ha url
  - FactoryParameters
```
public FactoryParameters()
```
    Constructs an empty FactoryParameters.
- Method Detail
  - getHost
```
public String getHost()
```
    Returns the name of host hosting the server to create connections with.
    
    Returns:
    
    The name of host hosting the server.
  - getPort
```
public int getPort()
```
    Returns the port to be used for accessing the server.
    
    Returns:
    
    The port to be used for accessing the server.
  - getUrl
```
public String getUrl()
```
    Returns the url to be used for accessing the server.
    
    Returns:
    
    The url to be used for accessing the server.
  - getMessageIdPrefix
```
public String getMessageIdPrefix()
```
    Gets the prefix to add to the JMS MessageID of connection created from this factory.
    
    Returns:
    
    the prefix to add to the JMS MessageID.
  - setMessageIdPrefix
```
public void setMessageIdPrefix(String messageIdPrefix)
```
    Setsthe prefix to add to the JMS MessageID of connection created from this factory.
    
    Parameters:
    
    messageIdPrefix - the prefix to add to the JMS MessageID.
  - toReference
```
public void toReference(Reference ref,
                        String prefix)
```
  - fromReference
```
public void fromReference(Reference ref,
                          String prefix)
```
  - code
```
public Hashtable<String,Object> code(Hashtable<String,Object> h,
                                           String prefix)
```
  - decode
```
public void decode(Hashtable<String,Object> h,
                   String prefix)
```
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addInInterceptor
```
public void addInInterceptor(String pInterceptorClassName)
```
  - addOutInterceptor
```
public void addOutInterceptor(String pInterceptorClassName)
```
  - addInterceptor
```
private void addInterceptor(String pInterceptorClassName,
                            List<MessageInterceptor> pInterceptors)
```
  - removeInInterceptor
```
public boolean removeInInterceptor(String pInterceptorClassName)
```
  - removeOutInterceptor
```
public boolean removeOutInterceptor(String pInterceptorClassName)
```
  - removeInterceptor
```
public boolean removeInterceptor(String pInterceptorClassName,
                                 List<MessageInterceptor> pInterceptors)
```
  - getListInInterceptorClassName
```
private String getListInInterceptorClassName()
```
  - getListOutInterceptorClassName
```
private String getListOutInterceptorClassName()
```
  - getListInterceptorClassName
```
private String getListInterceptorClassName(List<MessageInterceptor> pInterceptors)
```
  - setListInInterceptorClassName
```
private void setListInInterceptorClassName(String pListInterceptorClassName)
```
  - setListOutInterceptorClassName
```
private void setListOutInterceptorClassName(String pListInterceptorClassName)
```
  - setListInterceptorClassName
```
private void setListInterceptorClassName(String pListInterceptorClassName,
                                         List<MessageInterceptor> pInterceptors)
```
  - setParameters
```
public void setParameters(Properties properties)
```

Class FactoryParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

logger

host

port

url

clientID

TcpNoDelay

SoLinger

SoTimeout

connectingTimer

txPendingTimer

cnxPendingTimer

socketFactory

implicitAck

asyncSend

queueMessageReadMax

topicAckBufferMax

multiThreadSync

multiThreadSyncDelay

multiThreadSyncThreshold

topicPassivationThreshold

topicActivationThreshold

outLocalAddress

outLocalPort

inInterceptors

outInterceptors

compressedMinSize

compressionLevel

noAckedQueue

messageIdPrefix

INTERCEPTOR_CLASS_NAME_SEPARATOR

Constructor Detail

FactoryParameters

FactoryParameters

FactoryParameters

Method Detail

getHost

getPort

getUrl

getMessageIdPrefix

setMessageIdPrefix

toReference

fromReference

code

decode

clone

toString

addInInterceptor

addOutInterceptor

addInterceptor

removeInInterceptor

removeOutInterceptor

removeInterceptor

getListInInterceptorClassName

getListOutInterceptorClassName

getListInterceptorClassName

setListInInterceptorClassName

setListOutInterceptorClassName

setListInterceptorClassName

setParameters