flex.messaging.config
Class NetworkSettings

java.lang.Object
  flex.messaging.config.NetworkSettings

public class NetworkSettings
extends Object

Network policy settings for a MessageDestination.

Field Summary

static int	DEFAULT_TIMEOUT
static String	NETWORK_ELEMENT
static String	SESSION_TIMEOUT
static String	SUBSCRIPTION_TIMEOUT_MINUTES

Constructor Summary

NetworkSettings()
Constructs a default NetworkSettings instance with default session timeout.

Method Summary

String	getClusterId() Returns the cluster id.
int	getSubscriptionTimeoutMinutes() Returns the subscription-timeout-minutes property.
ThrottleSettings	getThrottleSettings() Returns the ThrottleSettings property.
boolean	isSharedBackend() Returns the shared-backend property.
boolean	isSharedBackendSet() Returns true if the shared backend has been set or false if it is still using the default.
void	setClusterId(String id) Sets the cluster id.
void	setSharedBackend(boolean sharedBackend) Sets the shared-backend property.
void	setSubscriptionTimeoutMinutes(int value) Sets the subscription-timeout-minutes property which is the idle time in minutes before a subscriber that no messages are being pushed to will be unsubscribed.
void	setThrottleSettings(ThrottleSettings value) Sets the ThrottleSettings property.

Methods inherited from class java.lang.Object

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

Field Detail

NETWORK_ELEMENT

public static final String NETWORK_ELEMENT

See Also:

Constant Field Values

SUBSCRIPTION_TIMEOUT_MINUTES

public static final String SUBSCRIPTION_TIMEOUT_MINUTES

See Also:

Constant Field Values

SESSION_TIMEOUT

public static final String SESSION_TIMEOUT

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

NetworkSettings

public NetworkSettings()

Constructs a default NetworkSettings instance with default session timeout.

Method Detail

getClusterId

public String getClusterId()

Returns the cluster id.

Returns:

The cluster id.

setClusterId

public void setClusterId(String id)

Sets the cluster id.

Parameters:

id - The cluster id.

getSubscriptionTimeoutMinutes

public int getSubscriptionTimeoutMinutes()

Returns the subscription-timeout-minutes property.

Returns:

the subscription-timeout-minutes property.

setSubscriptionTimeoutMinutes

public void setSubscriptionTimeoutMinutes(int value)

Sets the subscription-timeout-minutes property which is the idle time in minutes before a subscriber that no messages are being pushed to will be unsubscribed. A value of 0 will cause subscriptions to be kept alive as long as the associated FlexSession they are created over is active.

Parameters:

value - The value to set the subscription-timeout-minutes property to.

isSharedBackend

public boolean isSharedBackend()

Returns the shared-backend property.

Returns:

the shared-backend property.

setSharedBackend

public void setSharedBackend(boolean sharedBackend)

Sets the shared-backend property.

Parameters:

sharedBackend - The value to set the shared-backend property to.

isSharedBackendSet

public boolean isSharedBackendSet()

Returns true if the shared backend has been set or false if it is still using the default.

Returns:

true if the shared backend has been set; false otherwise.

getThrottleSettings

public ThrottleSettings getThrottleSettings()

Returns the ThrottleSettings property.

Returns:

the ThrottleSettings property.

setThrottleSettings

public void setThrottleSettings(ThrottleSettings value)

Sets the ThrottleSettings property.

Parameters:

value - The value to set the ThrottleSettings property to.