flex.messaging.config

Class AdapterSettings

java.lang.Object

flex.messaging.config.PropertiesSettings

flex.messaging.config.AdapterSettings

public class AdapterSettings
extends PropertiesSettings

A service must register the adapters that it will use to process messages. Each destination selects an adapter that processes the request by referring to it by id.

Adapters can also be configured with initialization properties.

Author:

Peter Farland

See Also:

flex.messaging.services.ServiceAdapter

Field Summary

Fields inherited from class flex.messaging.config.PropertiesSettings

properties

Constructor Summary

Constructors

Constructor and Description
AdapterSettings(String id) Used to construct a new set of properties to describe an adapter.

Method Summary

Methods

Modifier and Type	Method and Description
String	getClassName() Gets the name of the Java class implementation for this adapter.
String	getId() The identity that destinations will refer to when assigning and adapter.
boolean	isDefault() Returns a boolean flag that determines whether this adapter is the default for a service's destinations.
void	setClassName(String name) Sets name of the Java class implementation for this adapter.
void	setDefault(boolean b) Sets a flag to determine whether an adapter will be used as the default (for example, in the event that a destination did not specify an adapter explicitly).

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

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

Constructor Detail

AdapterSettings

public AdapterSettings(String id)

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

Parameters:

id - the String representing the unique identity for this adapter.

Method Detail

getId

public String getId()

The identity that destinations will refer to when assigning and adapter.

Returns:

the adapter identity as a String.

getClassName

public String getClassName()

Gets the name of the Java class implementation for this adapter.

Returns:

String The name of the adapter implementation.

See Also:

flex.messaging.services.ServiceAdapter

setClassName

public void setClassName(String name)

Sets name of the Java class implementation for this adapter. The implementation is resolved from the current classpath and must extend flex.messaging.services.ServiceAdapter.

Parameters:

name - the String

isDefault

public boolean isDefault()

Returns a boolean flag that determines whether this adapter is the default for a service's destinations. Only one default adapter can be set for a given service.

Returns:

boolean true if this adapter is the default.

setDefault

public void setDefault(boolean b)

Sets a flag to determine whether an adapter will be used as the default (for example, in the event that a destination did not specify an adapter explicitly). Only one default can be set for a given service.

Parameters:

b - a boolean flag, true if this adapter should be used as the default for the service.