org.apache.qpid.configuration

Class ClientProperties

java.lang.Object

org.apache.qpid.configuration.ClientProperties

public class ClientProperties
extends Object

This class centralized the Qpid client properties.

See Also:

CommonProperties

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDR_SYNTAX_SUPPORTED_IN_0_8
static String	AMQP_VERSION
static String	CONNECTION_OPTION_COMPRESS_MESSAGES System property to set a default value for a connection option 'compress_messages'
static String	CONNECTION_OPTION_MESSAGE_COMPRESSION_THRESHOLD_SIZE System property to set a default value for a connection option 'message_compression_threshold_size'
static String	CONNECTION_OPTION_SSL_VERIFY_HOST_NAME System property to set a default value for a connection option 'ssl_verify_hostname'
static String	DAEMON_DISPATCHER System property to enable allow dispatcher thread to be run as a daemon thread
static boolean	DEFAULT_ADDR_SYNTAX_0_8_SUPPORT
static int	DEFAULT_CLOSE_TIMEOUT A default timeout value for close operations
static boolean	DEFAULT_CONNECTION_OPTION_COMPRESS_MESSAGES
static boolean	DEFAULT_CONNECTION_OPTION_SSL_VERIFY_HOST_NAME
static long	DEFAULT_FLOW_CONTROL_WAIT_FAILURE Default time (in millis) to wait before failing when sending and the client has been flow controlled by the broker.
static long	DEFAULT_FLOW_CONTROL_WAIT_NOTIFY_PERIOD Default time (in millis) between log notifications that a send is waiting because the client was flow controlled by the broker.
static int	DEFAULT_MAX_CACHED_ADDR_OPTION_STRINGS
static int	DEFAULT_MESSAGE_COMPRESSION_THRESHOLD_SIZE
static int	DEFAULT_SYNC_OPERATION_TIMEOUT A default timeout value for synchronous operations
static String	DEST_SYNTAX This value will be used to determine the default destination syntax type.
static String	IGNORE_SET_CLIENTID_PROP_NAME Currently with Qpid it is not possible to change the client ID.
static String	MAX_PREFETCH_DEFAULT
static String	MAX_PREFETCH_PROP_NAME This property is currently used within the 0.10 code path only The maximum number of pre-fetched messages per destination This property is used for all the connection unless it is overwritten by the connectionURL type: long
static String	PROCESS_NAME Used to name the process utilising the Qpid client, to override the default value is used in the ConnectionStartOk reply to the broker.
static String	QPID_BIND_QUEUES_PROP_NAME System property to control whether the client will bind queues during consumer creation when using BindingURLs.
static String	QPID_CLOSE_TIMEOUT System properties to change the default timeout used whilst closing connections and underlying sessions.
static String	QPID_DECLARE_EXCHANGES_PROP_NAME System property to control whether the client will declare exchanges during producer/consumer creation when using BindingURLs.
static String	QPID_DECLARE_QUEUES_PROP_NAME System property to control whether the client will declare queues during consumer creation when using BindingURLs.
static String	QPID_FLOW_CONTROL_WAIT_FAILURE System property to set the time (in millis) to wait before failing when sending and the client has been flow controlled by the broker.
static String	QPID_FLOW_CONTROL_WAIT_NOTIFY_PERIOD System property to set the time (in millis) between log notifications that a send is waiting because the client was flow controlled by the broker.
static String	QPID_HEARTBEAT_INTERVAL Frequency of heartbeat messages (in seconds)
static int	QPID_HEARTBEAT_INTERVAL_010_DEFAULT Default heartbeat interval (used by 0-10 protocol).
static String	QPID_HEARTBEAT_TIMEOUT_FACTOR The factor applied to QPID_HEARTBEAT_INTERVAL that determines the maximum length of time that may elapse before the peer is deemed to have failed.
static float	QPID_HEARTBEAT_TIMEOUT_FACTOR_DEFAULT Default heartbeat timeout factor.
static String	QPID_MAX_CACHED_ADDR_OPTION_STRINGS
static String	QPID_SSL_KEY_MANAGER_FACTORY_ALGORITHM_PROP_NAME System property used to set the key manager factory algorithm.
static String	QPID_SSL_TRUST_MANAGER_FACTORY_ALGORITHM_PROP_NAME System property used to set the trust manager factory algorithm.
static String	QPID_SYNC_OP_TIMEOUT System properties to change the default timeout used during synchronous operations.
static String	QPID_TCP_NODELAY_PROP_NAME System properties to change the default value used for TCP_NODELAY
static String	QPID_USE_LEGACY_GETQUEUEDEPTH_BEHAVIOUR Before 0.30, when using AMQP 0-8..0-9-1 requesting queue depth (AMQSession#getQueueDepth) for a queue that did not exist resulted in AMQChannelException.
static String	QPID_VERIFY_CLIENT_ID
static String	RECEIVE_BUFFER_SIZE_PROP_NAME System property used to set the socket receive buffer size.
static String	REJECT_BEHAVIOUR_PROP_NAME System property to set the reject behaviour.
static String	SEND_BUFFER_SIZE_PROP_NAME System property used to set the socket send buffer size.
static String	SET_EXPIRATION_AS_TTL System property to control whether the 0-8/0-9/0-9-1 client will set the message 'expiration' header using the computed expiration value (default, when false) or instead set it to the raw TTL (when true).
static String	SYNC_ACK_PROP_NAME When true a sync command is sent after sending a message ack.
static String	SYNC_CLIENT_ACK When true a sync command is sent after sending a message ack on a CLIENT_ACK session.
static String	SYNC_PERSISTENT_PROP_NAME When true a sync command is sent after every persistent messages.
static String	SYNC_PUBLISH_PROP_NAME sync_publish property - {persistent|all} If set to 'persistent',then persistent messages will be publish synchronously If set to 'all', then all messages regardless of the delivery mode will be published synchronously.
static String	USE_LEGACY_MAP_MESSAGE_FORMAT
static String	USE_LEGACY_STREAM_MESSAGE_FORMAT
static String	VERIFY_QUEUE_ON_SEND

Method Summary

Methods

Modifier and Type	Method and Description
static void	ensureIsLoaded()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IGNORE_SET_CLIENTID_PROP_NAME

public static final String IGNORE_SET_CLIENTID_PROP_NAME

Currently with Qpid it is not possible to change the client ID. If one is not specified upon connection construction, an id is generated automatically. Therefore an exception is always thrown unless this property is set to true. type: boolean

See Also:

Constant Field Values

MAX_PREFETCH_PROP_NAME

public static final String MAX_PREFETCH_PROP_NAME

This property is currently used within the 0.10 code path only The maximum number of pre-fetched messages per destination This property is used for all the connection unless it is overwritten by the connectionURL type: long

See Also:

Constant Field Values

MAX_PREFETCH_DEFAULT

public static final String MAX_PREFETCH_DEFAULT

See Also:

Constant Field Values

SYNC_PERSISTENT_PROP_NAME

public static final String SYNC_PERSISTENT_PROP_NAME

When true a sync command is sent after every persistent messages. type: boolean

See Also:

Constant Field Values

SYNC_ACK_PROP_NAME

public static final String SYNC_ACK_PROP_NAME

When true a sync command is sent after sending a message ack. type: boolean

See Also:

Constant Field Values

SYNC_CLIENT_ACK

public static final String SYNC_CLIENT_ACK

When true a sync command is sent after sending a message ack on a CLIENT_ACK session. type: boolean

See Also:

Constant Field Values

SYNC_PUBLISH_PROP_NAME

public static final String SYNC_PUBLISH_PROP_NAME

sync_publish property - {persistent|all} If set to 'persistent',then persistent messages will be publish synchronously If set to 'all', then all messages regardless of the delivery mode will be published synchronously.

See Also:

Constant Field Values

QPID_HEARTBEAT_INTERVAL

public static final String QPID_HEARTBEAT_INTERVAL

Frequency of heartbeat messages (in seconds)

See Also:

Constant Field Values

QPID_HEARTBEAT_INTERVAL_010_DEFAULT

public static final int QPID_HEARTBEAT_INTERVAL_010_DEFAULT

Default heartbeat interval (used by 0-10 protocol).

See Also:

Constant Field Values

QPID_HEARTBEAT_TIMEOUT_FACTOR

public static final String QPID_HEARTBEAT_TIMEOUT_FACTOR

The factor applied to QPID_HEARTBEAT_INTERVAL that determines the maximum length of time that may elapse before the peer is deemed to have failed.

See Also:

QPID_HEARTBEAT_TIMEOUT_FACTOR_DEFAULT, Constant Field Values

QPID_HEARTBEAT_TIMEOUT_FACTOR_DEFAULT

public static final float QPID_HEARTBEAT_TIMEOUT_FACTOR_DEFAULT

Default heartbeat timeout factor.

See Also:

Constant Field Values

DEST_SYNTAX

public static final String DEST_SYNTAX

This value will be used to determine the default destination syntax type. Currently the two types are Binding URL (java only) and the Addressing format (used by all clients).

See Also:

Constant Field Values

USE_LEGACY_MAP_MESSAGE_FORMAT

public static final String USE_LEGACY_MAP_MESSAGE_FORMAT

See Also:

Constant Field Values

USE_LEGACY_STREAM_MESSAGE_FORMAT

public static final String USE_LEGACY_STREAM_MESSAGE_FORMAT

See Also:

Constant Field Values

AMQP_VERSION

public static final String AMQP_VERSION

See Also:

Constant Field Values

QPID_VERIFY_CLIENT_ID

public static final String QPID_VERIFY_CLIENT_ID

See Also:

Constant Field Values

QPID_SYNC_OP_TIMEOUT

public static final String QPID_SYNC_OP_TIMEOUT

System properties to change the default timeout used during synchronous operations.

See Also:

Constant Field Values

DEFAULT_SYNC_OPERATION_TIMEOUT

public static final int DEFAULT_SYNC_OPERATION_TIMEOUT

A default timeout value for synchronous operations

See Also:

Constant Field Values

QPID_CLOSE_TIMEOUT

public static final String QPID_CLOSE_TIMEOUT

System properties to change the default timeout used whilst closing connections and underlying sessions.

See Also:

Constant Field Values

DEFAULT_CLOSE_TIMEOUT

public static final int DEFAULT_CLOSE_TIMEOUT

A default timeout value for close operations

See Also:

Constant Field Values

QPID_TCP_NODELAY_PROP_NAME

public static final String QPID_TCP_NODELAY_PROP_NAME

System properties to change the default value used for TCP_NODELAY

See Also:

Constant Field Values

REJECT_BEHAVIOUR_PROP_NAME

public static final String REJECT_BEHAVIOUR_PROP_NAME

System property to set the reject behaviour. default value will be 'normal' but can be changed to 'server' in which case the server decides whether a message should be requeued or dead lettered. This can be overridden by the more specific settings at connection or binding URL level.

See Also:

Constant Field Values

QPID_SSL_KEY_MANAGER_FACTORY_ALGORITHM_PROP_NAME

public static final String QPID_SSL_KEY_MANAGER_FACTORY_ALGORITHM_PROP_NAME

System property used to set the key manager factory algorithm.

See Also:

Constant Field Values

QPID_SSL_TRUST_MANAGER_FACTORY_ALGORITHM_PROP_NAME

public static final String QPID_SSL_TRUST_MANAGER_FACTORY_ALGORITHM_PROP_NAME

System property used to set the trust manager factory algorithm.

See Also:

Constant Field Values

DAEMON_DISPATCHER

public static final String DAEMON_DISPATCHER

System property to enable allow dispatcher thread to be run as a daemon thread

See Also:

Constant Field Values

PROCESS_NAME

public static final String PROCESS_NAME

Used to name the process utilising the Qpid client, to override the default value is used in the ConnectionStartOk reply to the broker.

See Also:

Constant Field Values

RECEIVE_BUFFER_SIZE_PROP_NAME

public static final String RECEIVE_BUFFER_SIZE_PROP_NAME

System property used to set the socket receive buffer size.

See Also:

Constant Field Values

SEND_BUFFER_SIZE_PROP_NAME

public static final String SEND_BUFFER_SIZE_PROP_NAME

System property used to set the socket send buffer size.

See Also:

Constant Field Values

QPID_FLOW_CONTROL_WAIT_FAILURE

public static final String QPID_FLOW_CONTROL_WAIT_FAILURE

System property to set the time (in millis) to wait before failing when sending and the client has been flow controlled by the broker.

See Also:

Constant Field Values

DEFAULT_FLOW_CONTROL_WAIT_FAILURE

public static final long DEFAULT_FLOW_CONTROL_WAIT_FAILURE

Default time (in millis) to wait before failing when sending and the client has been flow controlled by the broker.

See Also:

Constant Field Values

QPID_FLOW_CONTROL_WAIT_NOTIFY_PERIOD

public static final String QPID_FLOW_CONTROL_WAIT_NOTIFY_PERIOD

System property to set the time (in millis) between log notifications that a send is waiting because the client was flow controlled by the broker.

See Also:

Constant Field Values

DEFAULT_FLOW_CONTROL_WAIT_NOTIFY_PERIOD

public static final long DEFAULT_FLOW_CONTROL_WAIT_NOTIFY_PERIOD

Default time (in millis) between log notifications that a send is waiting because the client was flow controlled by the broker.

See Also:

Constant Field Values

QPID_DECLARE_QUEUES_PROP_NAME

public static final String QPID_DECLARE_QUEUES_PROP_NAME

System property to control whether the client will declare queues during consumer creation when using BindingURLs.

See Also:

Constant Field Values

QPID_DECLARE_EXCHANGES_PROP_NAME

public static final String QPID_DECLARE_EXCHANGES_PROP_NAME

System property to control whether the client will declare exchanges during producer/consumer creation when using BindingURLs.

See Also:

Constant Field Values

QPID_BIND_QUEUES_PROP_NAME

public static final String QPID_BIND_QUEUES_PROP_NAME

System property to control whether the client will bind queues during consumer creation when using BindingURLs.

See Also:

Constant Field Values

VERIFY_QUEUE_ON_SEND

public static final String VERIFY_QUEUE_ON_SEND

See Also:

Constant Field Values

QPID_MAX_CACHED_ADDR_OPTION_STRINGS

public static final String QPID_MAX_CACHED_ADDR_OPTION_STRINGS

See Also:

Constant Field Values

DEFAULT_MAX_CACHED_ADDR_OPTION_STRINGS

public static final int DEFAULT_MAX_CACHED_ADDR_OPTION_STRINGS

See Also:

Constant Field Values

SET_EXPIRATION_AS_TTL

public static final String SET_EXPIRATION_AS_TTL

System property to control whether the 0-8/0-9/0-9-1 client will set the message 'expiration' header using the computed expiration value (default, when false) or instead set it to the raw TTL (when true). May be necessary for interop with other vendors.

See Also:

Constant Field Values

CONNECTION_OPTION_SSL_VERIFY_HOST_NAME

public static final String CONNECTION_OPTION_SSL_VERIFY_HOST_NAME

System property to set a default value for a connection option 'ssl_verify_hostname'

See Also:

Constant Field Values

DEFAULT_CONNECTION_OPTION_SSL_VERIFY_HOST_NAME

public static final boolean DEFAULT_CONNECTION_OPTION_SSL_VERIFY_HOST_NAME

See Also:

Constant Field Values

CONNECTION_OPTION_COMPRESS_MESSAGES

public static final String CONNECTION_OPTION_COMPRESS_MESSAGES

System property to set a default value for a connection option 'compress_messages'

See Also:

Constant Field Values

DEFAULT_CONNECTION_OPTION_COMPRESS_MESSAGES

public static final boolean DEFAULT_CONNECTION_OPTION_COMPRESS_MESSAGES

See Also:

Constant Field Values

CONNECTION_OPTION_MESSAGE_COMPRESSION_THRESHOLD_SIZE

public static final String CONNECTION_OPTION_MESSAGE_COMPRESSION_THRESHOLD_SIZE

System property to set a default value for a connection option 'message_compression_threshold_size'

See Also:

Constant Field Values

DEFAULT_MESSAGE_COMPRESSION_THRESHOLD_SIZE

public static final int DEFAULT_MESSAGE_COMPRESSION_THRESHOLD_SIZE

See Also:

Constant Field Values

ADDR_SYNTAX_SUPPORTED_IN_0_8

public static final String ADDR_SYNTAX_SUPPORTED_IN_0_8

See Also:

Constant Field Values

DEFAULT_ADDR_SYNTAX_0_8_SUPPORT

public static final boolean DEFAULT_ADDR_SYNTAX_0_8_SUPPORT

See Also:

Constant Field Values

QPID_USE_LEGACY_GETQUEUEDEPTH_BEHAVIOUR

public static final String QPID_USE_LEGACY_GETQUEUEDEPTH_BEHAVIOUR

Before 0.30, when using AMQP 0-8..0-9-1 requesting queue depth (AMQSession#getQueueDepth) for a queue that did not exist resulted in AMQChannelException. From 0.30 forward, 0 is returned in common with 0-10 behaviour. Setting this system property true restores the old behaviour. It also avoids the isBound with a null exchange that causes an error in the Apache Qpid Broker-J (0.28 and earlier).

See Also:

Constant Field Values

Method Detail

ensureIsLoaded

public static void ensureIsLoaded()