com.rabbitmq.client
Class ConnectionParameters

java.lang.Object
  com.rabbitmq.client.ConnectionParameters

public class ConnectionParameters
extends java.lang.Object

Properties bean to encapsulate parameters for a Connection.

Field Summary

static int	DEFAULT_CHANNEL_MAX Default value for the desired maximum number of channels; zero for unlimited
static int	DEFAULT_FRAME_MAX Default value for the desired maximum frame size; zero for unlimited
static int	DEFAULT_HEARTBEAT Default value for desired heartbeat interval; zero for none
static java.lang.String	DEFAULT_PASS Default password
static boolean	DEFAULT_SUPPRESS_ACCESS_REQUEST Default value for suppressAccessRequest flag.
static java.lang.String	DEFAULT_USER Default user name
static java.lang.String	DEFAULT_VHOST Default virtual host

Constructor Summary

ConnectionParameters()
Instantiate a set of parameters with all values set to the defaults

Method Summary

java.lang.String	getPassword() Retrieve the password.
int	getRequestedChannelMax() Retrieve the requested maximum number of channels
int	getRequestedFrameMax() Retrieve the requested maximum frame size
int	getRequestedHeartbeat() Retrieve the requested heartbeat interval.
boolean	getSuppressAccessRequest() Retrieve the setting for the suppression of sending "access.request" methods.
java.lang.String	getUserName() Retrieve the user name.
java.lang.String	getVirtualHost() Retrieve the virtual host.
void	setPassword(java.lang.String password) Set the password.
void	setRequestedChannelMax(int requestedChannelMax) Set the requested maximum number of channels
void	setRequestedFrameMax(int requestedFrameMax) Set the requested maximum frame size
void	setRequestedHeartbeat(int requestedHeartbeat) Set the requested heartbeat.
void	setSuppressAccessRequest(boolean suppressAccessRequest) Enable or disable the suppression of sending "access.request" methods.
void	setUsername(java.lang.String userName) Set the user name.
void	setVirtualHost(java.lang.String virtualHost) Set the virtual host.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USER

public static final java.lang.String DEFAULT_USER

Default user name

See Also:

Constant Field Values

DEFAULT_PASS

public static final java.lang.String DEFAULT_PASS

Default password

See Also:

Constant Field Values

DEFAULT_VHOST

public static final java.lang.String DEFAULT_VHOST

Default virtual host

See Also:

Constant Field Values

DEFAULT_CHANNEL_MAX

public static final int DEFAULT_CHANNEL_MAX

Default value for the desired maximum number of channels; zero for unlimited

See Also:

Constant Field Values

DEFAULT_FRAME_MAX

public static final int DEFAULT_FRAME_MAX

Default value for the desired maximum frame size; zero for unlimited

See Also:

Constant Field Values

DEFAULT_HEARTBEAT

public static final int DEFAULT_HEARTBEAT

Default value for desired heartbeat interval; zero for none

See Also:

Constant Field Values

DEFAULT_SUPPRESS_ACCESS_REQUEST

public static final boolean DEFAULT_SUPPRESS_ACCESS_REQUEST

Default value for suppressAccessRequest flag. Retrieved from system property "com.rabbitmq.client.ConnectionParameters.suppressAccessRequest" and defaulting to true.

Constructor Detail

ConnectionParameters

public ConnectionParameters()

Instantiate a set of parameters with all values set to the defaults

Method Detail

getUserName

public java.lang.String getUserName()

Retrieve the user name.

Returns:

the AMQP user name to use when connecting to the broker

setUsername

public void setUsername(java.lang.String userName)

Set the user name.

Parameters:

userName - the AMQP user name to use when connecting to the broker

getPassword

public java.lang.String getPassword()

Retrieve the password.

Returns:

the password to use when connecting to the broker

setPassword

public void setPassword(java.lang.String password)

Set the password.

Parameters:

password - the password to use when connecting to the broker

getVirtualHost

public java.lang.String getVirtualHost()

Retrieve the virtual host.

Returns:

the virtual host to use when connecting to the broker

setVirtualHost

public void setVirtualHost(java.lang.String virtualHost)

Set the virtual host.

Parameters:

virtualHost - the virtual host to use when connecting to the broker

getRequestedChannelMax

public int getRequestedChannelMax()

Retrieve the requested maximum number of channels

Returns:

the initially requested maximum number of channels; zero for unlimited

setRequestedFrameMax

public void setRequestedFrameMax(int requestedFrameMax)

Set the requested maximum frame size

Parameters:

requestedFrameMax - initially requested maximum frame size, in octets; zero for unlimited

getRequestedFrameMax

public int getRequestedFrameMax()

Retrieve the requested maximum frame size

Returns:

the initially requested maximum frame size, in octets; zero for unlimited

getRequestedHeartbeat

public int getRequestedHeartbeat()

Retrieve the requested heartbeat interval.

Returns:

the initially requested heartbeat interval, in seconds; zero for none

setRequestedHeartbeat

public void setRequestedHeartbeat(int requestedHeartbeat)

Set the requested heartbeat.

Parameters:

requestedHeartbeat - the initially requested heartbeat interval, in seconds; zero for none

setRequestedChannelMax

public void setRequestedChannelMax(int requestedChannelMax)

Set the requested maximum number of channels

Parameters:

requestedChannelMax - initially requested maximum number of channels; zero for unlimited

getSuppressAccessRequest

public boolean getSuppressAccessRequest()

Retrieve the setting for the suppression of sending "access.request" methods.

Returns:

true of "access.request" methods are suppressed, false otherwise.

setSuppressAccessRequest

public void setSuppressAccessRequest(boolean suppressAccessRequest)

Enable or disable the suppression of sending "access.request" methods.

Parameters:

suppressAccessRequest - true of "access.request" methods are suppressed, false otherwise.