webMethods Broker API for JMS
Version 9.5.1.0.171 091713

com.webmethods.jms
Class WmJMSConfig

java.lang.Object
  extended by com.webmethods.jms.WmJMSConfig

public class WmJMSConfig
extends java.lang.Object

Defines System properties and methods used to configure webMethods JMS.


Field Summary
static java.lang.String AUTO_QUEUE_CREATE
          The System property enabling or disabling automatic queue creation.
static java.lang.String BROKER_IDLE_SOCKET_TIMEOUT
          The System property defining the number of seconds to wait for a response from the Broker on an idle socket.
static java.lang.String BROKER_KEEP_ALIVE_ATTEMPTS
          The System property defining the number of times the Broker will attempt a keep-alive before disconnecting the JMS client.
static java.lang.String BROKER_KEEP_ALIVE_INTERVAL
          The System property defining how often, in seconds, a keep-alive is sent from the Broker to the JMS client.
static java.lang.String BROKER_KEEP_ALIVE_TIMEOUT
          The System property defining the number of seconds the Broker will wait for activity from the JMS client.
static java.lang.String BROKER_SOCKET_TIMEOUT_POST_CONNECTION_CLOSE
          The System property defining the number of seconds to wait for a response from the Broker on the corresponding socket, after JMS Connection close has been called.
static java.lang.String BROKER_TIMEOUT
          The System property defining the maximum number of seconds to wait for a response from the Broker.
static java.lang.String CLIENT_ID_SHARING
          The System property enabling or disabling the sharing of client identifiers.
static java.lang.String COMPRESSION_THRESHOLD
          The System property defining the message producer's default compression threshold.
static java.lang.String CONFIG_FILENAME
          The configuration file name.
static java.lang.String CONFIRM_DELIVERY
          This System property enables or disables message delivery confirmation for persistent messages.
static java.lang.String DEFAULT_BROKER_HOST
          The default Broker host; defined as "localhost" .
static int DEFAULT_BROKER_PORT
          The default Broker port; defined as 6849 .
static java.lang.String DEFAULT_DELIVERY_MODE
          The System property defining the message producer's default delivery mode.
static java.lang.String DEFAULT_PRIORITY
          The System property defining the message producer's default priority.
static boolean DEFAULT_SOCKET_KEEP_ALIVE_ENABLED
           
static boolean DEFAULT_SSL_FIPS_MODE_ENABLED
           
static java.lang.String DEFAULT_TIME_TO_LIVE
          The System property defining the message producer's default time to live.
static java.lang.String DISABLE_MESSAGE_DESTINATION
          This System property enables or disables message destinations being sent with a message.
static java.lang.String DISABLE_MESSAGE_ID
          This System property enables or disables message IDs being sent in a message.
static java.lang.String DISABLE_MESSAGE_TIMESTAMP
          This System property enables or disables message timestamps being sent in a message.
static java.lang.String JMS_CLUSTER_1PC_TRANSACTION_LOG_FILE
          The System property containing the destination file name of the JMS Clustering 1PC transaction logging data.
static java.lang.String KEEP_ALIVE_ATTEMPTS_BEFORE_DECLARING_CONNECTION_DROPPED
          The System property defining how many times the ping could time out before declaring the connection as dropped.
static java.lang.String KEEP_ALIVE_INTERVAL
          The System property defining how often, in seconds, a keep-alive is sent from the JMS client to the Broker.
static java.lang.String MAX_RECEIVE
          The System property defining the maximum number of messages to be sent from the Broker to a consumer at one time.
static java.lang.String MESSAGE_TRANSPORT_MAX_CACHE_SIZE
          The System property defining the message transport's maximum size of a structure that will be cached.
static java.lang.String PASSWORD
          The System property to set the default password to be used with the connection.
static java.lang.String RECONNECT_ATTEMPTS
          The System property defining the number of times to attempt to reconnect to a Broker.
static java.lang.String RECONNECT_DELAY
          The System property defining the maximum amount of time, in seconds, to delay before attempting to reconnect to a Broker.
static java.lang.String SOCKET_AUTO_FLUSH_DELAY
          The System property defining the number of milliseconds to trigger auto-flushing to the socket.
static java.lang.String SOCKET_AUTO_FLUSH_SIZE
          The System property defining the number of bytes to trigger auto-flushing to the socket.
static java.lang.String SOCKET_CONNECT_TIMEOUT
          The System property defining how long, in seconds, to wait for a socket connection to be created.
static java.lang.String SOCKET_KEEP_ALIVE_ENABLED
          The System property to Enable/disable the Socket Keep Alive.
static java.lang.String SOCKET_LINGER
          The System property to enable or disable lingering upon socket close.
static java.lang.String SOCKET_LINGER_TIMEOUT
          The System property defining the number of seconds to linger if socket linger is enabled.
static java.lang.String SOCKET_RECV_BUFFER_SIZE
          The System property defining the size of the inbound socket buffer in bytes.
static java.lang.String SOCKET_SEND_BUFFER_SIZE
          The System property defining the size of the outbound socket buffer in bytes.
static java.lang.String SOCKET_TCP_NO_DELAY
          The System property to enable or disable Nagle's algorithm on the socket.
static java.lang.String SOCKET_TIMEOUT
           
static java.lang.String SSL_CIPHERSUITES
          The System property to set the default SSL ciphersuites to be used with the connection.
static java.lang.String SSL_FIPS_MODE
          The System property defining whether to use SSL FIPS Mode with the connection.
static java.lang.String SSL_KEYSTORE
          The System property to set the default SSL keystore to be used with the connection.
static java.lang.String SSL_KEYSTORETYPE
          The System property to set the default SSL keystore type to be used with the connection.
static java.lang.String SSL_PROVIDER
          The System property to set the default SSL provider to be used with the connection.
static java.lang.String SSL_TRUSTSTORE
          The System property to set the default SSL truststore to be used with the connection.
static java.lang.String SSL_TRUSTSTORETYPE
          The System property to set the default SSL truststore type to be used with the connection.
static java.lang.String USERNAME
          The System property to set the default username to be used with the connection.
 
Method Summary
static boolean getAutoQueueCreate()
          Get whether automatic queue creation is enabled or disabled.
static int getBrokerKeepAliveAttempts()
          Get the Broker's keep-alive attempts.
static int getBrokerKeepAliveInterval()
          Get the Broker's keep-alive interval.
static int getBrokerKeepAliveTimeout()
          Get the Broker's keep-alive response timeout.
static int getBrokerTimeout()
          Get the Broker timeout.
static int getBrokerTimeoutOnIdleSocket()
          Get the Broker timeout in seconds on idle socket.
static int getBrokerTimeoutPostConnectionClose()
          Gets the Broker timeout in seconds post JMS Connection.close()
static boolean getClientIDSharing()
          Get whether client identifier sharing is enabled or disabled.
static int getCompressionThreshold()
          Get the default compression threshold for message producers.
static boolean getConfirmDelivery()
          Get whether message delivery confirmation is enabled.
static int getDefaultDeliveryMode()
          Get the message producer's default delivery mode.
static int getDefaultPriority()
          Get the message producer's default priority.
static long getDefaultTimeToLive()
          Get the message producer's default time to live.
static boolean getDisableMessageDestination()
          Get whether message destinations are sent.
static boolean getDisableMessageID()
          Get whether message IDs are sent.
static boolean getDisableMessageTimestamp()
          Get whether message timestamps are sent.
static int getKeepAliveAttemptsBeforeDeclaringConnectionDead()
          Get the KeepAlive attempts which need to fail with no response before declaring the connection as broken.
static int getKeepAliveInterval()
          Get the keep-alive interval.
static int getMaxReceive()
          Get the maximum number of messages to be sent from the Broker to a consumer at one time.
static int getMessageTransportMaxCacheSize()
          Get the messsage transport's maximum size for caching structures.
static java.lang.String getPassword()
          Get the password.
static java.util.Properties getProperties()
          Get all properties.
static java.lang.String getProperty(java.lang.String name)
          Get a property.
static boolean getProperty(java.lang.String name, boolean defaultValue)
          Get a boolean property.
static int getProperty(java.lang.String name, int defaultValue)
          Get an integer property.
static long getProperty(java.lang.String name, long defaultValue)
          Get a long property.
static java.lang.String getProperty(java.lang.String name, java.lang.String defaultValue)
          Get a property.
static int getReconnectAttempts()
          Get the reconnect attempts.
static int getReconnectDelay()
          Get the reconnect delay.
static long getSocketAutoFlushDelay()
          Get the socket auto-flush delay.
static int getSocketAutoFlushSize()
          Get the socket auto-flush size.
static int getSocketConnectTimeout()
          Get the socket connect timeout.
static boolean getSocketKeepAliveEnabled()
           
static boolean getSocketLinger()
          Get the socket linger state.
static int getSocketLingerTimeout()
          Get the socket linger timeout.
static int getSocketRecvBufferSize()
          Get the inbound socket buffer size.
static int getSocketSendBufferSize()
          Get the outbound socket buffer size.
static boolean getSocketTcpNoDelay()
          Get the socket setting of Nagle's algorithm.
static int getSoTimeout()
          Get the socket connect timeout.
static java.lang.String getSSLCipherSuites()
          Get the SSL CipherSuites list, separated by comma
static java.lang.String getSSLKeystore()
          Get the SSL keystore.
static java.lang.String getSSLKeystoreType()
          Get the SSL keystore type.
static java.lang.String getSSLProvider()
          Get the SSL Provider.
static java.lang.String getSSLTruststore()
          Get the SSL Truststore.
static java.lang.String getSSLTruststoreType()
          Get the SSL Truststore type.
static java.lang.String getUsername()
          Get the username.
static boolean isSSLFIPSModeEnabled()
          Get true if the SSL FIPS Mode is enabled.
static void setAutoQueueCreate(boolean autoQueueCreate)
          Enable or disable automatic queue creation.
static void setBrokerKeepAliveAttempts(int brokerKeepAliveAttempts)
          Set the Broker's keep-alive attempts.
static void setBrokerKeepAliveInterval(int brokerKeepAliveInterval)
          Set the Broker's keep-alive interval.
static void setBrokerKeepAliveTimeout(int brokerKeepAliveTimeout)
          Set the Broker's keep-alive response timeout.
static void setBrokerTimeout(int brokerTimeout)
          Set the Broker timeout.
static void setBrokerTimeoutOnIdleSocket(int brokerTimeoutOnIdleSocket)
          Set the Broker idle socket timeout in seconds.
static void setBrokerTimeoutPostConnectionClose(int brokerTimeoutPostConnectionClose)
          Sets the Broker timeout in seconds post JMS Connection.close()
static void setClientIDSharing(boolean clientIDSharing)
          Enable or disable client identifier sharing.
static void setCompressionThreshold(int compressionThreshold)
          Set the default compression threshold for message producers.
static void setConfirmDelivery(boolean confirmDelivery)
          Set whether message delivery confirmation is enabled.
static void setDefaultDeliveryMode(int defaultDeliveryMode)
          Set the message producer's default delivery mode.
static void setDefaultPriority(int defaultPriority)
          Set the message producer's default priority.
static void setDefaultTimeToLive(int defaultTimeToLive)
          Set the message producer's default time to live.
static void setDisableMessageDestination(boolean disableMessageDestination)
          Set whether message destinations are sent.
static void setDisableMessageID(boolean disableMessageID)
          Set whether message IDs are sent.
static void setDisableMessageTimestamp(boolean disableMessageTimestamp)
          Set whether message timestamps are sent.
static void setJMSCluster1PCTxLogDestination(java.lang.String txLogdestination)
          Set the file name where the JMS Cluster 1PC Logging is recorded.
static void setKeepAliveAttemptsBeforeDeclaringConnectionDead(int keepAliveInterval)
          Set the KeepAlive attempts which need to fail with no response before declaring the connection as broken.
static void setKeepAliveInterval(int keepAliveInterval)
          Set the keep-alive interval.
static void setMaxReceive(int maxReceive)
          Set the maximum number of messages to be sent from the Broker to a consumer at one time.
static void setMessageTransportMaxCacheSize(int size)
          Set the messsage transport's maximum size for caching structures.
static void setPassword(java.lang.String password)
          Set the password.
static void setProperty(java.lang.String name, boolean value)
          Set a boolean property.
static void setProperty(java.lang.String name, int value)
          Set an integer property.
static void setProperty(java.lang.String name, java.lang.String value)
          Set a property.
static void setReconnectAttempts(int reconnectAttempts)
          Set the reconnect attempts.
static void setReconnectDelay(int reconnectDelay)
          Set the reconnect delay.
static void setSocketAutoFlushDelay(int socketAutoFlushDelay)
          Set the socket auto-flush delay.
static void setSocketAutoFlushSize(int socketAutoFlushSize)
          Set the socket auto-flush size.
static void setSocketConnectTimeout(int socketConnectTimeout)
          Set the socket connect timeout.
static void setSocketKeepAliveEnabled(boolean enabled)
           
static void setSocketLinger(boolean socketLinger)
          Set the socket linger state.
static void setSocketLingerTimeout(int socketLingerTimeout)
          Set the socket linger timeout.
static void setSocketRecvBufferSize(int socketRecvBufferSize)
          Set the inbound socket buffer size.
static void setSocketSendBufferSize(int socketSendBufferSize)
          Set the outbound socket buffer size.
static void setSocketTcpNoDelay(boolean socketTcpNoDelay)
          Enable or disable the Nagle's algorithm on the socket.
static void setSoTimeout(int socketTimeout)
          Set the socket connect timeout.
static void setSSLCipherSuites(java.lang.String cipherSuites)
          Set the CipherSuites.
static void setSSLFIPSModeEnabled(boolean enable)
          Set to true if SSL FIPS Mode needs to be enabled.
static void setSSLKeystore(java.lang.String sslKeystore)
          Set the SSL keystore.
static void setSSLKeystoreType(java.lang.String sslKeystore)
          Set the SSL keystore type.
static void setSSLProvider(java.lang.String provider)
          Set the SSL Provider.
static void setSSLTruststore(java.lang.String sslTruststore)
          Set the SSL Truststore.
static void setSSLTruststoreType(java.lang.String sslTruststore)
          Set the SSL Truststore type.
static void setUsername(java.lang.String username)
          Set the username.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONFIG_FILENAME

public static final java.lang.String CONFIG_FILENAME
The configuration file name. Upon starting a webMethods JMS client, the configuration file will be read and its properties loaded, if it exists.

To override JMS provider-specific properties: 1. Create a properties file named wmjms.properties. 2. Add the properties that need to be overridden to that file. 3. Add the location of the file to the CLASSPATH.

The configuration file name is defined as "wmjms.properties".

See Also:
Constant Field Values

DEFAULT_BROKER_HOST

public static final java.lang.String DEFAULT_BROKER_HOST
The default Broker host; defined as "localhost" .

See Also:
Constant Field Values

DEFAULT_BROKER_PORT

public static final int DEFAULT_BROKER_PORT
The default Broker port; defined as 6849 .

See Also:
Constant Field Values

SOCKET_CONNECT_TIMEOUT

public static final java.lang.String SOCKET_CONNECT_TIMEOUT
The System property defining how long, in seconds, to wait for a socket connection to be created. A value of zero is interpreted as an infinite timeout.

This System property is defined as "com.webmethods.jms.socket.connectTimeout".

The default value is zero (infinite timeout).

See Also:
Constant Field Values

SOCKET_TIMEOUT

public static final java.lang.String SOCKET_TIMEOUT
See Also:
Constant Field Values

SOCKET_SEND_BUFFER_SIZE

public static final java.lang.String SOCKET_SEND_BUFFER_SIZE
The System property defining the size of the outbound socket buffer in bytes.

This System property is defined as "com.webmethods.jms.socket.sendBufferSize".

The default value is 65536 bytes.

See Also:
Constant Field Values

SOCKET_RECV_BUFFER_SIZE

public static final java.lang.String SOCKET_RECV_BUFFER_SIZE
The System property defining the size of the inbound socket buffer in bytes.

This System property is defined as "com.webmethods.jms.socket.recvBufferSize".

The default value is 65536 bytes.

See Also:
Constant Field Values

SOCKET_TCP_NO_DELAY

public static final java.lang.String SOCKET_TCP_NO_DELAY
The System property to enable or disable Nagle's algorithm on the socket.

This System property is defined as "com.webmethods.jms.socket.tcpNoDelay".

The default value is "true".

See Also:
Constant Field Values

SOCKET_LINGER

public static final java.lang.String SOCKET_LINGER
The System property to enable or disable lingering upon socket close.

This System property is defined as "com.webmethods.jms.socket.linger".

The default value is "false".

See Also:
Constant Field Values

SOCKET_LINGER_TIMEOUT

public static final java.lang.String SOCKET_LINGER_TIMEOUT
The System property defining the number of seconds to linger if socket linger is enabled.

This System property is defined as "com.webmethods.jms.socket.lingerTimeout".

The default value is 1 second.

See Also:
Constant Field Values

SOCKET_AUTO_FLUSH_SIZE

public static final java.lang.String SOCKET_AUTO_FLUSH_SIZE
The System property defining the number of bytes to trigger auto-flushing to the socket. Increasing this value will improve publisher performance but may increase latency.

This System property is defined as "com.webmethods.jms.socket.autoFlushSize".

The default value is 32768 bytes.

See Also:
SOCKET_AUTO_FLUSH_DELAY, Constant Field Values

SOCKET_AUTO_FLUSH_DELAY

public static final java.lang.String SOCKET_AUTO_FLUSH_DELAY
The System property defining the number of milliseconds to trigger auto-flushing to the socket. Increasing this value will improve publisher performance but may increase latency. A recommended value for a fast publisher is 250 milliseconds.

This System property is defined as "com.webmethods.jms.socket.autoFlushDelay".

The default value is 0 milliseconds (no delay).

See Also:
SOCKET_AUTO_FLUSH_SIZE, Constant Field Values

BROKER_TIMEOUT

public static final java.lang.String BROKER_TIMEOUT
The System property defining the maximum number of seconds to wait for a response from the Broker. If no response is received from the Broker within this timeout then the connection is assumed lost.

This System property is defined as "com.webmethods.jms.brokerTimeout".

The default value is 60 seconds.

See Also:
Constant Field Values

BROKER_IDLE_SOCKET_TIMEOUT

public static final java.lang.String BROKER_IDLE_SOCKET_TIMEOUT
The System property defining the number of seconds to wait for a response from the Broker on an idle socket. If no response is received from the Broker within this timeout then the connection is assumed lost.

This System property is defined as "com.webmethods.jms.brokerIdleSocketTimeout".

The default value is 60 seconds.

See Also:
Constant Field Values

BROKER_SOCKET_TIMEOUT_POST_CONNECTION_CLOSE

public static final java.lang.String BROKER_SOCKET_TIMEOUT_POST_CONNECTION_CLOSE
The System property defining the number of seconds to wait for a response from the Broker on the corresponding socket, after JMS Connection close has been called.

This System property is defined as "com.webmethods.jms.brokerTimeoutPostConnectionClose".

The default value is 30 seconds.

See Also:
Constant Field Values

KEEP_ALIVE_INTERVAL

public static final java.lang.String KEEP_ALIVE_INTERVAL
The System property defining how often, in seconds, a keep-alive is sent from the JMS client to the Broker. A value of 0 disables keep-alives.

This System property is defined as "com.webmethods.jms.keepAliveInterval".

The default value is 30 (disabled).

See Also:
Constant Field Values

KEEP_ALIVE_ATTEMPTS_BEFORE_DECLARING_CONNECTION_DROPPED

public static final java.lang.String KEEP_ALIVE_ATTEMPTS_BEFORE_DECLARING_CONNECTION_DROPPED
The System property defining how many times the ping could time out before declaring the connection as dropped. The default value is 2.

See Also:
Constant Field Values

RECONNECT_DELAY

public static final java.lang.String RECONNECT_DELAY
The System property defining the maximum amount of time, in seconds, to delay before attempting to reconnect to a Broker.

This System property is defined as "com.webmethods.jms.reconnectDelay".

The default value is 15 seconds.

See Also:
Constant Field Values

RECONNECT_ATTEMPTS

public static final java.lang.String RECONNECT_ATTEMPTS
The System property defining the number of times to attempt to reconnect to a Broker. A value of 0 disables reconnect attempts.

It is recommended that reconnect attempts be disabled when running within an application server so that distributed transactions can be recovered properly. An application server will register a connection exception listener and should handle reconnection properly for distributed transactions.

This System property is defined as "com.webmethods.jms.reconnectAttempts".

The default value is 0 (disabled).

See Also:
Constant Field Values

BROKER_KEEP_ALIVE_INTERVAL

public static final java.lang.String BROKER_KEEP_ALIVE_INTERVAL
The System property defining how often, in seconds, a keep-alive is sent from the Broker to the JMS client. When the JMS client receives a keep-alive from the Broker it will immediately respond to it with a keep-alive response.

A value of 0 disables the sending of keep-alives from the Broker to the JMS client.

This System property is defined as "com.webmethods.jms.broker.keepAliveInterval".

The default value is 0 (disabled).

See Also:
Constant Field Values

BROKER_KEEP_ALIVE_TIMEOUT

public static final java.lang.String BROKER_KEEP_ALIVE_TIMEOUT
The System property defining the number of seconds the Broker will wait for activity from the JMS client. This activity can be a response to a keep-alive sent from the Broker to the JMS client or any other traffic sent from the JMS client to the Broker. If the Broker does not see any activity from the JMS client within this timeout the Broker will disconnect the JMS client if the keep-alive attempts have been exhausted.

A value of 0 is equivalent to an infinite timeout.

This System property is defined as "com.webmethods.jms.broker.keepAliveTimeout".

The default value is 0 (disabled).

See Also:
Constant Field Values

BROKER_KEEP_ALIVE_ATTEMPTS

public static final java.lang.String BROKER_KEEP_ALIVE_ATTEMPTS
The System property defining the number of times the Broker will attempt a keep-alive before disconnecting the JMS client.

This System property is defined as "com.webMethods.jms.broker.keepAliveAttempts".

The default value is 1 attempt.

See Also:
Constant Field Values

CONFIRM_DELIVERY

public static final java.lang.String CONFIRM_DELIVERY
This System property enables or disables message delivery confirmation for persistent messages.

This System property is defined as "com.webmethods.jms.confirmDelivery".

The default value is "true".

See Also:
Constant Field Values

DISABLE_MESSAGE_DESTINATION

public static final java.lang.String DISABLE_MESSAGE_DESTINATION
This System property enables or disables message destinations being sent with a message. This may be used as an optimization to reduce the overhead associated with sending the message's destination.

This System property is defined as "com.webmethods.jms.disableMessageDestination".

The default value is "false".

See Also:
Constant Field Values

DISABLE_MESSAGE_ID

public static final java.lang.String DISABLE_MESSAGE_ID
This System property enables or disables message IDs being sent in a message. This may be used as an optimization to reduce the overhead associated with sending the message's ID. This System property has the equivalent functionality of MessageProducer.setDisableMessageID(boolean).

This System property is defined as "com.webmethods.jms.disableMessageID".

The default value is "false".

See Also:
MessageProducer.setDisableMessageID(boolean), Constant Field Values

DISABLE_MESSAGE_TIMESTAMP

public static final java.lang.String DISABLE_MESSAGE_TIMESTAMP
This System property enables or disables message timestamps being sent in a message. This may be used as an optimization to reduce the overhead associated with sending the message's timestamp. This System property has the equivalent functionality of MessageProducer.setDisableMessageTimestamp(boolean).

This System property is defined as "com.webmethods.jms.disableMessageTimestamp".

The default value is "false".

See Also:
MessageProducer.setDisableMessageTimestamp(boolean), Constant Field Values

MAX_RECEIVE

public static final java.lang.String MAX_RECEIVE
The System property defining the maximum number of messages to be sent from the Broker to a consumer at one time.

This System property is defined as "com.webmethods.jms.maxReceive".

The default value is 160.

See Also:
WmMessageConsumer.setMaxReceive(int), Constant Field Values

DEFAULT_DELIVERY_MODE

public static final java.lang.String DEFAULT_DELIVERY_MODE
The System property defining the message producer's default delivery mode.

This System property is defined as "com.webmethods.jms.defaultDeliveryMode".

The default value is Message.DEFAULT_DELIVERY_MODE.

See Also:
MessageProducer.setDeliveryMode(int), Constant Field Values

DEFAULT_PRIORITY

public static final java.lang.String DEFAULT_PRIORITY
The System property defining the message producer's default priority.

This System property is defined as "com.webmethods.jms.defaultPriority".

The default value is Message.DEFAULT_PRIORITY.

See Also:
MessageProducer.setPriority(int), Constant Field Values

DEFAULT_TIME_TO_LIVE

public static final java.lang.String DEFAULT_TIME_TO_LIVE
The System property defining the message producer's default time to live.

This System property is defined as "com.webmethods.jms.defaultTimeToLive".

The default value is Message.DEFAULT_TIME_TO_LIVE.

See Also:
MessageProducer.setTimeToLive(long), Constant Field Values

COMPRESSION_THRESHOLD

public static final java.lang.String COMPRESSION_THRESHOLD
The System property defining the message producer's default compression threshold.

This System property is defined as "com.webmethods.jms.compressionThreshold".

The default value is -1 (no compression).

See Also:
Constant Field Values

AUTO_QUEUE_CREATE

public static final java.lang.String AUTO_QUEUE_CREATE
The System property enabling or disabling automatic queue creation. When disabled, if a queue receiver or browser attempts to connect to a non-existent queue then an InvalidDestinationException will be thrown. When enabled, the queue will automatically be created.

This System property is defined as "com.webmethods.jms.autoQueueCreate".

The default value is "false".

See Also:
Constant Field Values

CLIENT_ID_SHARING

public static final java.lang.String CLIENT_ID_SHARING
The System property enabling or disabling the sharing of client identifiers. JMS prohibits clients from sharing client identifiers. This propery can be used to allow clients to share the same client identifier. This is required when creating shared-state durable subscribers.

This System property is defined as "com.webmethods.jms.clientIDSharing".

The default value is "false".

See Also:
Constant Field Values

USERNAME

public static final java.lang.String USERNAME
The System property to set the default username to be used with the connection.

This System property is defined as "com.webmethods.jms.username".

The default value is null.

See Also:
Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD
The System property to set the default password to be used with the connection.

This System property is defined as "com.webmethods.jms.password".

The default value is null.

See Also:
Constant Field Values

SSL_KEYSTORE

public static final java.lang.String SSL_KEYSTORE
The System property to set the default SSL keystore to be used with the connection.

This System property is defined as "com.webmethods.jms.ssl.keystore".

The default value is null.

See Also:
Constant Field Values

SSL_KEYSTORETYPE

public static final java.lang.String SSL_KEYSTORETYPE
The System property to set the default SSL keystore type to be used with the connection.

This System property is defined as "com.webmethods.jms.ssl.keystoretype".

The default value is null.

See Also:
Constant Field Values

SSL_TRUSTSTORE

public static final java.lang.String SSL_TRUSTSTORE
The System property to set the default SSL truststore to be used with the connection.

This System property is defined as "com.webmethods.jms.ssl.truststore".

The default value is null.

See Also:
Constant Field Values

SSL_TRUSTSTORETYPE

public static final java.lang.String SSL_TRUSTSTORETYPE
The System property to set the default SSL truststore type to be used with the connection.

This System property is defined as "com.webmethods.jms.ssl.truststoretype".

The default value is null.

See Also:
Constant Field Values

SSL_PROVIDER

public static final java.lang.String SSL_PROVIDER
The System property to set the default SSL provider to be used with the connection.

This System property is defined as "com.webmethods.jms.ssl.provider".

The default value is null.

See Also:
Constant Field Values

SSL_CIPHERSUITES

public static final java.lang.String SSL_CIPHERSUITES
The System property to set the default SSL ciphersuites to be used with the connection.

This System property is defined as "com.webmethods.jms.ssl.ciphersuites".

The default value is from the provider.

See Also:
Constant Field Values

SSL_FIPS_MODE

public static final java.lang.String SSL_FIPS_MODE
The System property defining whether to use SSL FIPS Mode with the connection.

This System property is defined as "com.webmethods.jms.ssl.fipsmode".

The default value is false.

See Also:
Constant Field Values

MESSAGE_TRANSPORT_MAX_CACHE_SIZE

public static final java.lang.String MESSAGE_TRANSPORT_MAX_CACHE_SIZE
The System property defining the message transport's maximum size of a structure that will be cached.

This System property is defined as "com.webmethods.jms.transport.maxCacheSize".

The default value is 2048.

See Also:
Constant Field Values

JMS_CLUSTER_1PC_TRANSACTION_LOG_FILE

public static final java.lang.String JMS_CLUSTER_1PC_TRANSACTION_LOG_FILE
The System property containing the destination file name of the JMS Clustering 1PC transaction logging data. In order to support manual recovery of transactions that might have failed during the prepare or the commit phase of a 1PC transaction logging, we record the transaction information durably to disk in the cluster transaction log.

This System property is defined as "com.webmethods.jms.cluster.log1PC".

The transaction logging is disabled if the value is not specified.

See Also:
Constant Field Values

SOCKET_KEEP_ALIVE_ENABLED

public static final java.lang.String SOCKET_KEEP_ALIVE_ENABLED
The System property to Enable/disable the Socket Keep Alive. Since TCP/IP sends no packets except when there is traffic, without Socket.setKeepAlive( true ), it has no way of noticing a disconnect until you start trying to send traffic again. Java has the Socket.setKeepAlive( true ) method to ask TCP/IP to handle heartbeat probing without any data packets or application programming.

This System property is enabled - whether or not to have socket keep alive turned on.

The default value is false( no socket keep alive).

See Also:
Constant Field Values

DEFAULT_SOCKET_KEEP_ALIVE_ENABLED

public static final boolean DEFAULT_SOCKET_KEEP_ALIVE_ENABLED
See Also:
Constant Field Values

DEFAULT_SSL_FIPS_MODE_ENABLED

public static final boolean DEFAULT_SSL_FIPS_MODE_ENABLED
See Also:
Constant Field Values
Method Detail

getSocketConnectTimeout

public static int getSocketConnectTimeout()
Get the socket connect timeout.

Returns:
the socket connect timeout in seconds
See Also:
SOCKET_CONNECT_TIMEOUT, setSocketConnectTimeout(int)

setSocketConnectTimeout

public static void setSocketConnectTimeout(int socketConnectTimeout)
Set the socket connect timeout.

Parameters:
socketConnectTimeout - the socket connect timeout in seconds
See Also:
SOCKET_CONNECT_TIMEOUT, getSocketConnectTimeout()

getSoTimeout

public static int getSoTimeout()
Get the socket connect timeout.

Returns:
the socket connect timeout in seconds
See Also:
SOCKET_TIMEOUT, setSoTimeout(int)

setSoTimeout

public static void setSoTimeout(int socketTimeout)
Set the socket connect timeout.

Parameters:
socketTimeout - the socket connect timeout in seconds
See Also:
SOCKET_TIMEOUT, getSoTimeout()

getSocketSendBufferSize

public static int getSocketSendBufferSize()
Get the outbound socket buffer size.

Returns:
the outbound socket buffer size
See Also:
SOCKET_SEND_BUFFER_SIZE, setSocketSendBufferSize(int)

setSocketSendBufferSize

public static void setSocketSendBufferSize(int socketSendBufferSize)
Set the outbound socket buffer size.

Parameters:
socketSendBufferSize - the outbound socket buffer size
See Also:
SOCKET_SEND_BUFFER_SIZE, getSocketSendBufferSize()

getSocketRecvBufferSize

public static int getSocketRecvBufferSize()
Get the inbound socket buffer size.

Returns:
the inbound socket buffer size
See Also:
SOCKET_RECV_BUFFER_SIZE, setSocketRecvBufferSize(int)

setSocketRecvBufferSize

public static void setSocketRecvBufferSize(int socketRecvBufferSize)
Set the inbound socket buffer size.

Parameters:
socketRecvBufferSize - the inbound socket buffer size
See Also:
SOCKET_RECV_BUFFER_SIZE, getSocketRecvBufferSize()

getSocketTcpNoDelay

public static boolean getSocketTcpNoDelay()
Get the socket setting of Nagle's algorithm.

Returns:
true if Nagle's algorithm is disabled
See Also:
SOCKET_TCP_NO_DELAY, setSocketTcpNoDelay(boolean)

setSocketTcpNoDelay

public static void setSocketTcpNoDelay(boolean socketTcpNoDelay)
Enable or disable the Nagle's algorithm on the socket.

Parameters:
socketTcpNoDelay - true to disable Nagle's algorithm
See Also:
SOCKET_TCP_NO_DELAY, getSocketTcpNoDelay()

getSocketLinger

public static boolean getSocketLinger()
Get the socket linger state.

Returns:
true if socket linger is enabled
See Also:
SOCKET_LINGER, setSocketLinger(boolean)

setSocketLinger

public static void setSocketLinger(boolean socketLinger)
Set the socket linger state.

Parameters:
socketLinger - true to enable socket linger
See Also:
SOCKET_LINGER, getSocketLinger()

getSocketLingerTimeout

public static int getSocketLingerTimeout()
Get the socket linger timeout.

Returns:
the socket linger timeout
See Also:
SOCKET_LINGER_TIMEOUT, setSocketLingerTimeout(int)

setSocketLingerTimeout

public static void setSocketLingerTimeout(int socketLingerTimeout)
Set the socket linger timeout.

Parameters:
socketLingerTimeout - the socket linger timeout
See Also:
SOCKET_LINGER_TIMEOUT, getSocketLingerTimeout()

getSocketAutoFlushSize

public static int getSocketAutoFlushSize()
Get the socket auto-flush size.

Returns:
the socket auto-flush size
See Also:
SOCKET_AUTO_FLUSH_SIZE, setSocketAutoFlushSize(int)

setSocketAutoFlushSize

public static void setSocketAutoFlushSize(int socketAutoFlushSize)
Set the socket auto-flush size.

Parameters:
socketAutoFlushSize - the socket auto-flush size
See Also:
SOCKET_AUTO_FLUSH_SIZE, getSocketAutoFlushSize()

getSocketAutoFlushDelay

public static long getSocketAutoFlushDelay()
Get the socket auto-flush delay.

Returns:
the socket auto-flush delay
See Also:
SOCKET_AUTO_FLUSH_DELAY, setSocketAutoFlushDelay(int)

setSocketAutoFlushDelay

public static void setSocketAutoFlushDelay(int socketAutoFlushDelay)
Set the socket auto-flush delay.

Parameters:
socketAutoFlushDelay - the socket auto-flush delay
See Also:
SOCKET_AUTO_FLUSH_DELAY, getSocketAutoFlushDelay()

getBrokerTimeout

public static int getBrokerTimeout()
Get the Broker timeout.

Returns:
the connection's Broker timeout in seconds
See Also:
BROKER_TIMEOUT, setBrokerTimeout(int)

setBrokerTimeout

public static void setBrokerTimeout(int brokerTimeout)
Set the Broker timeout.

Parameters:
brokerTimeout - the connection's Broker timeout in seconds
See Also:
BROKER_TIMEOUT, getBrokerTimeout()

getBrokerTimeoutOnIdleSocket

public static int getBrokerTimeoutOnIdleSocket()
Get the Broker timeout in seconds on idle socket.

Returns:
the connection's timeout on idle socket.
See Also:
BROKER_IDLE_SOCKET_TIMEOUT, setBrokerTimeoutOnIdleSocket(int)

setBrokerTimeoutOnIdleSocket

public static void setBrokerTimeoutOnIdleSocket(int brokerTimeoutOnIdleSocket)
Set the Broker idle socket timeout in seconds.

Parameters:
brokerTimeoutOnIdleSocket - the connection's timeout on idle socket in seconds.
See Also:
BROKER_IDLE_SOCKET_TIMEOUT, getBrokerTimeoutOnIdleSocket()

getBrokerTimeoutPostConnectionClose

public static int getBrokerTimeoutPostConnectionClose()
Gets the Broker timeout in seconds post JMS Connection.close()

Returns:
the connection's timeout post JMS Connection.close()
See Also:
BROKER_SOCKET_TIMEOUT_POST_CONNECTION_CLOSE, setBrokerTimeoutPostConnectionClose(int)

setBrokerTimeoutPostConnectionClose

public static void setBrokerTimeoutPostConnectionClose(int brokerTimeoutPostConnectionClose)
Sets the Broker timeout in seconds post JMS Connection.close()

See Also:
BROKER_SOCKET_TIMEOUT_POST_CONNECTION_CLOSE, setBrokerTimeoutPostConnectionClose(int)

getKeepAliveInterval

public static int getKeepAliveInterval()
Get the keep-alive interval.

Returns:
the connection's keep-alive interval in seconds
See Also:
KEEP_ALIVE_INTERVAL, setKeepAliveInterval(int)

setKeepAliveInterval

public static void setKeepAliveInterval(int keepAliveInterval)
Set the keep-alive interval.

Parameters:
keepAliveInterval - the connection's keep-alive interval in seconds
See Also:
KEEP_ALIVE_INTERVAL, getKeepAliveInterval()

getKeepAliveAttemptsBeforeDeclaringConnectionDead

public static int getKeepAliveAttemptsBeforeDeclaringConnectionDead()
Get the KeepAlive attempts which need to fail with no response before declaring the connection as broken.

Returns:
number of keep alive attempts

setKeepAliveAttemptsBeforeDeclaringConnectionDead

public static void setKeepAliveAttemptsBeforeDeclaringConnectionDead(int keepAliveInterval)
Set the KeepAlive attempts which need to fail with no response before declaring the connection as broken.

Parameters:
keepAliveInterval - the connection's keep-alive attempts.
See Also:
KEEP_ALIVE_ATTEMPTS_BEFORE_DECLARING_CONNECTION_DROPPED, getKeepAliveAttemptsBeforeDeclaringConnectionDead()

getReconnectDelay

public static int getReconnectDelay()
Get the reconnect delay.

Returns:
the connection's reconnect delay in seconds
See Also:
RECONNECT_DELAY, setReconnectDelay(int)

setReconnectDelay

public static void setReconnectDelay(int reconnectDelay)
Set the reconnect delay.

Parameters:
reconnectDelay - the connection's reconnect delay in seconds
See Also:
RECONNECT_DELAY, getReconnectDelay()

getReconnectAttempts

public static int getReconnectAttempts()
Get the reconnect attempts.

Returns:
the connection's reconnect attempts
See Also:
RECONNECT_ATTEMPTS, setReconnectAttempts(int)

setReconnectAttempts

public static void setReconnectAttempts(int reconnectAttempts)
Set the reconnect attempts.

Parameters:
reconnectAttempts - the connection's reconnect attempts
See Also:
RECONNECT_ATTEMPTS, getReconnectAttempts()

getBrokerKeepAliveInterval

public static int getBrokerKeepAliveInterval()
Get the Broker's keep-alive interval.

Returns:
the Broker's keep-alive interval in seconds
See Also:
BROKER_KEEP_ALIVE_INTERVAL, setBrokerKeepAliveInterval(int)

setBrokerKeepAliveInterval

public static void setBrokerKeepAliveInterval(int brokerKeepAliveInterval)
Set the Broker's keep-alive interval.

Parameters:
brokerKeepAliveInterval - the Broker's keep-alive interval in seconds
See Also:
BROKER_KEEP_ALIVE_INTERVAL, getBrokerKeepAliveInterval()

getBrokerKeepAliveTimeout

public static int getBrokerKeepAliveTimeout()
Get the Broker's keep-alive response timeout.

Returns:
the Broker's keep-alive response timeout in seconds
See Also:
BROKER_KEEP_ALIVE_TIMEOUT, setBrokerKeepAliveTimeout(int)

setBrokerKeepAliveTimeout

public static void setBrokerKeepAliveTimeout(int brokerKeepAliveTimeout)
Set the Broker's keep-alive response timeout.

Parameters:
brokerKeepAliveTimeout - the Broker's keep-alive response timeout in seconds
See Also:
BROKER_KEEP_ALIVE_TIMEOUT, getBrokerKeepAliveTimeout()

getBrokerKeepAliveAttempts

public static int getBrokerKeepAliveAttempts()
Get the Broker's keep-alive attempts.

Returns:
the Broker's keep-alive attempts
See Also:
BROKER_KEEP_ALIVE_ATTEMPTS, setBrokerKeepAliveAttempts(int)

setBrokerKeepAliveAttempts

public static void setBrokerKeepAliveAttempts(int brokerKeepAliveAttempts)
Set the Broker's keep-alive attempts.

Parameters:
brokerKeepAliveAttempts - the Broker's keep-alive attempts
See Also:
BROKER_KEEP_ALIVE_ATTEMPTS, getBrokerKeepAliveAttempts()

getMaxReceive

public static int getMaxReceive()
Get the maximum number of messages to be sent from the Broker to a consumer at one time.

Returns:
the maximum number of message to be sent from the Broker to a destination at one time
See Also:
MAX_RECEIVE, setMaxReceive(int)

setMaxReceive

public static void setMaxReceive(int maxReceive)
Set the maximum number of messages to be sent from the Broker to a consumer at one time.

Parameters:
maxReceive - the maximum number of messages to be sent from the Broker to a consumer at one time
See Also:
MAX_RECEIVE, getMaxReceive()

getMessageTransportMaxCacheSize

public static int getMessageTransportMaxCacheSize()
Get the messsage transport's maximum size for caching structures.

Returns:
the maximum size
See Also:
MESSAGE_TRANSPORT_MAX_CACHE_SIZE, setMessageTransportMaxCacheSize(int)

setMessageTransportMaxCacheSize

public static void setMessageTransportMaxCacheSize(int size)
Set the messsage transport's maximum size for caching structures.

Parameters:
size - the maximum size
See Also:
MESSAGE_TRANSPORT_MAX_CACHE_SIZE, getMessageTransportMaxCacheSize()

getConfirmDelivery

public static boolean getConfirmDelivery()
Get whether message delivery confirmation is enabled.

Returns:
whether message delivery confirmation is enabled
See Also:
CONFIRM_DELIVERY, setConfirmDelivery(boolean)

setConfirmDelivery

public static void setConfirmDelivery(boolean confirmDelivery)
Set whether message delivery confirmation is enabled.

Parameters:
confirmDelivery - whether message delivery confirmation is enabled
See Also:
CONFIRM_DELIVERY, getConfirmDelivery()

getDisableMessageDestination

public static boolean getDisableMessageDestination()
Get whether message destinations are sent.

Returns:
whether message destinations are sent
See Also:
DISABLE_MESSAGE_DESTINATION, setDisableMessageDestination(boolean)

setDisableMessageDestination

public static void setDisableMessageDestination(boolean disableMessageDestination)
Set whether message destinations are sent.

Parameters:
disableMessageDestination - whether message destinations are sent
See Also:
DISABLE_MESSAGE_DESTINATION, getDisableMessageDestination()

getDisableMessageID

public static boolean getDisableMessageID()
Get whether message IDs are sent.

Returns:
whether message IDs are sent
See Also:
DISABLE_MESSAGE_ID, setDisableMessageID(boolean)

setDisableMessageID

public static void setDisableMessageID(boolean disableMessageID)
Set whether message IDs are sent.

Parameters:
disableMessageID - whether message IDs are sent
See Also:
DISABLE_MESSAGE_ID, getDisableMessageID()

getDisableMessageTimestamp

public static boolean getDisableMessageTimestamp()
Get whether message timestamps are sent.

Returns:
whether message timestamps are sent
See Also:
DISABLE_MESSAGE_TIMESTAMP, setDisableMessageTimestamp(boolean)

setDisableMessageTimestamp

public static void setDisableMessageTimestamp(boolean disableMessageTimestamp)
Set whether message timestamps are sent.

Parameters:
disableMessageTimestamp - whether timestamps are sent in messages
See Also:
DISABLE_MESSAGE_TIMESTAMP, getDisableMessageTimestamp()

getDefaultDeliveryMode

public static int getDefaultDeliveryMode()
Get the message producer's default delivery mode.

Returns:
the message producer's default delivery mode
See Also:
DEFAULT_DELIVERY_MODE, setDefaultDeliveryMode(int)

setDefaultDeliveryMode

public static void setDefaultDeliveryMode(int defaultDeliveryMode)
Set the message producer's default delivery mode.

Parameters:
defaultDeliveryMode - the message producer's default delivery mode
See Also:
DEFAULT_DELIVERY_MODE, getDefaultDeliveryMode()

getDefaultPriority

public static int getDefaultPriority()
Get the message producer's default priority.

Returns:
the message producer's default priority
See Also:
DEFAULT_PRIORITY, setDefaultPriority(int)

setDefaultPriority

public static void setDefaultPriority(int defaultPriority)
Set the message producer's default priority.

Parameters:
defaultPriority - the message producer's default priority
See Also:
DEFAULT_PRIORITY, getDefaultPriority()

getDefaultTimeToLive

public static long getDefaultTimeToLive()
Get the message producer's default time to live.

Returns:
the message producer's default time to live
See Also:
DEFAULT_TIME_TO_LIVE, setDefaultTimeToLive(int)

setDefaultTimeToLive

public static void setDefaultTimeToLive(int defaultTimeToLive)
Set the message producer's default time to live.

Parameters:
defaultTimeToLive - the message producer's default time to live
See Also:
DEFAULT_TIME_TO_LIVE, getDefaultTimeToLive()

getAutoQueueCreate

public static boolean getAutoQueueCreate()
Get whether automatic queue creation is enabled or disabled.

Returns:
true if automatic queue creation is enabled.
See Also:
AUTO_QUEUE_CREATE, setAutoQueueCreate(boolean)

setAutoQueueCreate

public static void setAutoQueueCreate(boolean autoQueueCreate)
Enable or disable automatic queue creation.

Parameters:
autoQueueCreate - true to enable automatic queue creation
See Also:
AUTO_QUEUE_CREATE, getAutoQueueCreate()

getClientIDSharing

public static boolean getClientIDSharing()
Get whether client identifier sharing is enabled or disabled.

Returns:
true if client identifier sharing is enabled.
See Also:
CLIENT_ID_SHARING, setClientIDSharing(boolean)

setClientIDSharing

public static void setClientIDSharing(boolean clientIDSharing)
Enable or disable client identifier sharing.

Parameters:
clientIDSharing - true to enable client identifier sharing
See Also:
CLIENT_ID_SHARING, getClientIDSharing()

getCompressionThreshold

public static int getCompressionThreshold()
Get the default compression threshold for message producers.

Returns:
The default compression threshold.
See Also:
setCompressionThreshold(int), WmMessageProducer.setCompressionThreshold(int), WmMessageProducer.getCompressionThreshold()

setCompressionThreshold

public static void setCompressionThreshold(int compressionThreshold)
Set the default compression threshold for message producers.

Parameters:
compressionThreshold - The default compression threshold.
See Also:
getCompressionThreshold(), WmMessageProducer.setCompressionThreshold(int), WmMessageProducer.getCompressionThreshold()

getSSLKeystore

public static java.lang.String getSSLKeystore()
Get the SSL keystore.

Returns:
the SSL keystore
See Also:
SSL_KEYSTORE, setSSLKeystore(java.lang.String)

setSSLKeystore

public static void setSSLKeystore(java.lang.String sslKeystore)
Set the SSL keystore.

Parameters:
sslKeystore - the SSL keystore
See Also:
SSL_KEYSTORE, getSSLKeystore()

setSSLTruststore

public static void setSSLTruststore(java.lang.String sslTruststore)
Set the SSL Truststore.

Parameters:
sslTruststore - the SSL Truststore
See Also:
SSL_TRUSTSTORE, getSSLTruststore()

getSSLTruststore

public static java.lang.String getSSLTruststore()
Get the SSL Truststore.

Returns:
the SSL Truststore
See Also:
SSL_TRUSTSTORE, setSSLTruststore(java.lang.String)

setSSLTruststoreType

public static void setSSLTruststoreType(java.lang.String sslTruststore)
Set the SSL Truststore type.

Parameters:
sslTruststore - the SSL Truststore type
See Also:
SSL_TRUSTSTORETYPE, getSSLTruststoreType()

getSSLTruststoreType

public static java.lang.String getSSLTruststoreType()
Get the SSL Truststore type.

Returns:
the SSL Truststore type
See Also:
SSL_TRUSTSTORETYPE, setSSLTruststoreType(java.lang.String)

getSSLKeystoreType

public static java.lang.String getSSLKeystoreType()
Get the SSL keystore type.

Returns:
the SSL keystore type
See Also:
SSL_KEYSTORETYPE, setSSLKeystoreType(java.lang.String)

setSSLKeystoreType

public static void setSSLKeystoreType(java.lang.String sslKeystore)
Set the SSL keystore type.

Parameters:
sslKeystore - the SSL keystore type
See Also:
SSL_KEYSTORETYPE, getSSLKeystoreType()

setSSLProvider

public static void setSSLProvider(java.lang.String provider)
Set the SSL Provider.

Parameters:
provider - the SSL Provider
See Also:
SSL_PROVIDER, getSSLProvider()

getSSLProvider

public static java.lang.String getSSLProvider()
Get the SSL Provider.

Returns:
the SSL Provider
See Also:
SSL_PROVIDER, setSSLProvider(java.lang.String)

setSSLCipherSuites

public static void setSSLCipherSuites(java.lang.String cipherSuites)
Set the CipherSuites.

Parameters:
cipherSuites - the SSL CipherSuites list, separated by comma. ex: SSL_RSA_WITH_3DES_EDE_CBC_SHA,SSL_RSA_WITH_RC4_128_SHA
See Also:
SSL_CIPHERSUITES, getSSLCipherSuites()

getSSLCipherSuites

public static java.lang.String getSSLCipherSuites()
Get the SSL CipherSuites list, separated by comma

Returns:
the SSL CipherSuites
See Also:
SSL_CIPHERSUITES, setSSLCipherSuites(java.lang.String)

setSSLFIPSModeEnabled

public static void setSSLFIPSModeEnabled(boolean enable)
Set to true if SSL FIPS Mode needs to be enabled. Set to false if SSL FIPS Mode needs to be disabled.

Parameters:
enable - boolean.
See Also:
SSL_FIPS_MODE, isSSLFIPSModeEnabled()

isSSLFIPSModeEnabled

public static boolean isSSLFIPSModeEnabled()
Get true if the SSL FIPS Mode is enabled. Get false if it is not.

Returns:
boolean representing if the SSL FIPS is enabled.
See Also:
SSL_FIPS_MODE, setSSLFIPSModeEnabled(boolean)

getUsername

public static java.lang.String getUsername()
Get the username.

Returns:
the username
See Also:
USERNAME, setUsername(java.lang.String)

setUsername

public static void setUsername(java.lang.String username)
Set the username.

Parameters:
username - the username
See Also:
USERNAME, getUsername()

getPassword

public static java.lang.String getPassword()
Get the password.

Returns:
the password
See Also:
PASSWORD, setPassword(java.lang.String)

setPassword

public static void setPassword(java.lang.String password)
Set the password.

Parameters:
password - the password
See Also:
PASSWORD, getPassword()

setProperty

public static void setProperty(java.lang.String name,
                               java.lang.String value)
Set a property.

Parameters:
name - The name of the property to set.
value - The property value to set.

setProperty

public static void setProperty(java.lang.String name,
                               int value)
Set an integer property.

Parameters:
name - The name of the property to set.
value - The property value to set.

setProperty

public static void setProperty(java.lang.String name,
                               boolean value)
Set a boolean property.

Parameters:
name - The name of the property to set.
value - The property value to set.

getProperty

public static java.lang.String getProperty(java.lang.String name)
Get a property.

Parameters:
name - The name of the property to get.
Returns:
The property value.

getProperty

public static java.lang.String getProperty(java.lang.String name,
                                           java.lang.String defaultValue)
Get a property.

Parameters:
name - The name of the property to get.
defaultValue - The value to return if the property is not found.
Returns:
The property value.

getProperty

public static boolean getProperty(java.lang.String name,
                                  boolean defaultValue)
Get a boolean property.

Parameters:
name - The name of the property to get.
defaultValue - The value to return if the property is not found.
Returns:
The property value.

getProperty

public static int getProperty(java.lang.String name,
                              int defaultValue)
Get an integer property.

Parameters:
name - The name of the property to get.
defaultValue - The value to return if the property is not found.
Returns:
The property value.

getProperty

public static long getProperty(java.lang.String name,
                               long defaultValue)
Get a long property.

Parameters:
name - The name of the property to get.
defaultValue - The value to return if the property is not found.
Returns:
The property value.

getProperties

public static java.util.Properties getProperties()
Get all properties.

Returns:
all the properties

setJMSCluster1PCTxLogDestination

public static void setJMSCluster1PCTxLogDestination(java.lang.String txLogdestination)
Set the file name where the JMS Cluster 1PC Logging is recorded.

Parameters:
txLogdestination - the file name

getSocketKeepAliveEnabled

public static boolean getSocketKeepAliveEnabled()

setSocketKeepAliveEnabled

public static void setSocketKeepAliveEnabled(boolean enabled)

webMethods Broker API for JMS
Version 9.5.1.0.171 091713


Copyright © 2001 - 2013 Software AG Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or their suppliers.