org.idoox.transport.jms
Interface JMSConfig

All Superinterfaces:
TransportConfig

public interface JMSConfig
extends TransportConfig

A config interface for JMS transport.

Component:
J2EE-JMS-Transport

Nested Class Summary
static interface JMSConfig.DestConfig
           
static interface JMSConfig.ReductionConfig
          Configuration of the Reduction
 
Method Summary
 java.lang.String getBaseContext()
          Gets the BaseContext value
 long getClientTimeout()
          Gets the client timeout
 java.lang.String getDeliveryMode()
          Gets the delivery mode.
 JMSConfig.DestConfig[] getDestinations()
          Gets information about configuration of destinations
 java.lang.String getDurableId()
          Gets durable id.
 java.lang.String getJMSDestFactoryName()
          Gets the JMSDestFactoryName value
 java.lang.String getJMSDestName()
          Gets the JMSDestName value
 int getMaxThreads()
          Gets a maximal number of serving threads each one for one accepted connection.
 int getMessageExpiration()
          Gets JMS message time to live
 int getMessagePriority()
          Gets JMS message priority
 int getMinThreads()
          Gets a minimal number of waiting threads for new incoming connection.
 java.lang.String getPassword()
          Gets the password to be used when creating session
 JMSConfig.ReductionConfig[] getReductions()
          Gets name of the class, which implements org.systinet.transport.jms.Reduction
 java.lang.String getServerID()
          Gets the server selector value.
 java.lang.String getType()
          Gets type of transport.
 java.lang.String getUsername()
          Gets the username to be used when creating session
 JMSConfig.DestConfig newDestination()
           
 JMSConfig.ReductionConfig newReduction()
           
 void setBaseContext(java.lang.String baseContext)
          Sets baseContext
 void setClientTimeout(long timeout)
          Sets the client timeout int ms
 void setDeliveryMode(java.lang.String deliveryMode)
          Sets the delivery mode.
 void setDestinations(JMSConfig.DestConfig[] configs)
          Sets information about configuration of destinations
 void setDurableId(java.lang.String id)
          Sets the identifier of the durable topic subscription.
 void setJMSDestFactoryName(java.lang.String name)
          Sets the new JMSDestFactoryName value
 void setJMSDestName(java.lang.String name)
          Sets the new JMSDestName value
 void setMaxThreads(int maxThreads)
          Sets a maximal number of serving threads each one for one accepted connection.
 void setMessageExpiration(int timeout)
          Sets JMS message timeout
 void setMessagePriority(int priority)
          Sets JMS message priority ( 0 - 9 )
 void setMinThreads(int minThreads)
          Sets a minimal number of waiting threads for new incoming connection.
 void setPassword(java.lang.String password)
          Sets the password to be used when creating session
 void setReductions(JMSConfig.ReductionConfig[] reductions)
          Gets name of the class, which implements org.systinet.transport.jms.Reduction
 void setServerID(java.lang.String selector)
          Sets the server selector value.
 void setType(java.lang.String type)
          Sets the type of transport.
 void setUsername(java.lang.String username)
          Sets the username to be used when creating session
 
Methods inherited from interface org.idoox.transport.config.TransportConfig
getClassName, getClassSpaceName, getDefaultServer, getName, getPreload, getScheme, setClassName, setClassSpaceName, setDefaultServer, setName, setPreload, setScheme
 

Method Detail

setJMSDestName

public void setJMSDestName(java.lang.String name)
Sets the new JMSDestName value

Parameters:
name -

getJMSDestName

public java.lang.String getJMSDestName()
Gets the JMSDestName value

Returns:
value

setJMSDestFactoryName

public void setJMSDestFactoryName(java.lang.String name)
Sets the new JMSDestFactoryName value

Parameters:
name -

getJMSDestFactoryName

public java.lang.String getJMSDestFactoryName()
Gets the JMSDestFactoryName value

Returns:
value

setBaseContext

public void setBaseContext(java.lang.String baseContext)
Sets baseContext

Parameters:
baseContext - new BaseContext value

getBaseContext

public java.lang.String getBaseContext()
Gets the BaseContext value

Returns:
value

getType

public java.lang.String getType()
Gets type of transport. Either "topic" or "queue"

Returns:
- the transport type

setType

public void setType(java.lang.String type)
Sets the type of transport. Either "topic" or "queue"

Parameters:
type - - the type

getDurableId

public java.lang.String getDurableId()
Gets durable id. If set, the topic subscriber will be durable and identified by this string. In case of point-to-point communication over JMS queue it has no sense.

Returns:
the durable id

setDurableId

public void setDurableId(java.lang.String id)
Sets the identifier of the durable topic subscription.

Parameters:
id - the identifier

getServerID

public java.lang.String getServerID()
Gets the server selector value.

Returns:
selector - the selector value

setServerID

public void setServerID(java.lang.String selector)
Sets the server selector value.

Parameters:
selector - - the selector value

setMessageExpiration

public void setMessageExpiration(int timeout)
Sets JMS message timeout

Parameters:
timeout - - the value of time to live

getMessageExpiration

public int getMessageExpiration()
Gets JMS message time to live

Returns:
- the value

getMessagePriority

public int getMessagePriority()
Gets JMS message priority

Returns:
- the value

setMessagePriority

public void setMessagePriority(int priority)
Sets JMS message priority ( 0 - 9 )

Parameters:
priority - - the value of priority

setClientTimeout

public void setClientTimeout(long timeout)
Sets the client timeout int ms

Parameters:
timeout - - time to wait for the massage

getClientTimeout

public long getClientTimeout()
Gets the client timeout

Returns:
- the timeout value

getReductions

public JMSConfig.ReductionConfig[] getReductions()
Gets name of the class, which implements org.systinet.transport.jms.Reduction

Returns:
the name of the reduction classes

setReductions

public void setReductions(JMSConfig.ReductionConfig[] reductions)
Gets name of the class, which implements org.systinet.transport.jms.Reduction

Parameters:
reductions - sets names of all possible reductions

newReduction

public JMSConfig.ReductionConfig newReduction()

getDestinations

public JMSConfig.DestConfig[] getDestinations()
Gets information about configuration of destinations

Returns:
an array of destination configurations

setDestinations

public void setDestinations(JMSConfig.DestConfig[] configs)
Sets information about configuration of destinations

Parameters:
configs - array of destination configurations

newDestination

public JMSConfig.DestConfig newDestination()

getUsername

public java.lang.String getUsername()
Gets the username to be used when creating session

Returns:
the username

setUsername

public void setUsername(java.lang.String username)
Sets the username to be used when creating session

Parameters:
username - the username

getPassword

public java.lang.String getPassword()
Gets the password to be used when creating session

Returns:
the password

setPassword

public void setPassword(java.lang.String password)
Sets the password to be used when creating session

Parameters:
password - the password

getDeliveryMode

public java.lang.String getDeliveryMode()
Gets the delivery mode. Either "persistent" or "non-persistent"

Returns:
the delivery mode string

setDeliveryMode

public void setDeliveryMode(java.lang.String deliveryMode)
Sets the delivery mode. Either "persistent" or "non-persistent"

Parameters:
deliveryMode - - the delivery mode

getMaxThreads

public int getMaxThreads()
Gets a maximal number of serving threads each one for one accepted connection.

Returns:
a maximal number of threads

setMaxThreads

public void setMaxThreads(int maxThreads)
Sets a maximal number of serving threads each one for one accepted connection.

Parameters:
maxThreads - a maximal number of threads

getMinThreads

public int getMinThreads()
Gets a minimal number of waiting threads for new incoming connection.

Returns:
a minimal number of threads

setMinThreads

public void setMinThreads(int minThreads)
Sets a minimal number of waiting threads for new incoming connection.

Parameters:
minThreads - a minimal number of threads