flex.messaging.config
Class DestinationSettings

java.lang.Object
  flex.messaging.config.PropertiesSettings
      flex.messaging.config.DestinationSettings

public class DestinationSettings
extends flex.messaging.config.PropertiesSettings

Destinations are configured for a particular Service. A destination's configuration includes an id attribute to provide a public name for clients to use when sending messages.

The configuration also specifies which channels are valid to contact the destination, as well as which adapter a service must use to process client messages for this destination and any security constraints that need to be enforced.

See Also:

Destination

Constructor Summary

DestinationSettings(String id)
Used to construct a new set of properties to describe a destination.

Method Summary

void	addChannelSettings(flex.messaging.config.ChannelSettings c) Adds a channel to the set of channels that should be used to contact this destination.
AdapterSettings	getAdapterSettings() Gets the adapter to be used for this destination.
List	getChannelSettings() Gets the set of channels that can be used to contact this destination.
flex.messaging.config.SecurityConstraint	getConstraint() Gets the SecurityConstraint that will be applied to this destination, or null if no constraint has been registered.
String	getId() Gets the unique identity used by clients to target a destination.
void	setAdapterSettings(AdapterSettings a) Sets the service adapter to be used when the managing service is processing messages bound for this destination.
void	setChannelSettings(List settings) Overrides the set of channels that can be used to contact this destination.
void	setConstraint(flex.messaging.config.SecurityConstraint sc) Sets the security constraint to be applied to this destination.

Methods inherited from class flex.messaging.config.PropertiesSettings

addProperties, addProperty, addProperty, getProperties, getProperty, getPropertyAsBoolean, getPropertyAsInt, getPropertyAsList, getPropertyAsLong, getPropertyAsMap, getPropertyAsString

Methods inherited from class java.lang.Object

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

Constructor Detail

DestinationSettings

public DestinationSettings(String id)

Used to construct a new set of properties to describe a destination. Note that an identity is required in order for clients to refer to a destination.

Parameters:

id - A string representing the unique identity of this destination.

Method Detail

getId

public String getId()

Gets the unique identity used by clients to target a destination.

Returns:

String the destination's id.

addChannelSettings

public void addChannelSettings(flex.messaging.config.ChannelSettings c)

Adds a channel to the set of channels that should be used to contact this destination. The order in which channels are added is significant (clients use this order to locate an available channel and failover to the next in the list on failure).

Parameters:

c - the ChannelSettings to add to the set of channel definitions for this destination.

setChannelSettings

public void setChannelSettings(List settings)

Overrides the set of channels that can be used to contact this destination.

Parameters:

settings - A List of ChannelSettings.

getChannelSettings

public List getChannelSettings()

Gets the set of channels that can be used to contact this destination.

Returns:

a java.util.List of ChannelSettings describing the channels that can be used to contact this destination.

getConstraint

public flex.messaging.config.SecurityConstraint getConstraint()

Gets the SecurityConstraint that will be applied to this destination, or null if no constraint has been registered.

Returns:

the SecurityConstraint for this destination.

setConstraint

public void setConstraint(flex.messaging.config.SecurityConstraint sc)

Sets the security constraint to be applied to this destination. Security constraints restrict which clients can contact this destination. Use null to remove an existing constraint.

Parameters:

sc - the SecurityConstraint to apply to this destination.

setAdapterSettings

public void setAdapterSettings(AdapterSettings a)

Sets the service adapter to be used when the managing service is processing messages bound for this destination.

Parameters:

a - The AdapterSettings that describe the adapter to use for this destination.

getAdapterSettings

public AdapterSettings getAdapterSettings()

Gets the adapter to be used for this destination.

Returns:

AdapterSettings for this destinations adapter. A null value implies the the default service adapter should be used.