Pacotemx.messaging.config
Classepublic class ServerConfig
HerançaServerConfig Inheritance Object

This class provides access to the server messaging configuration information. This class encapsulates information from the services-config.xml file on the client and is used by the messaging system to provide configured ChannelSets and Channels to the messaging framework.

The XML source is provided during the compilation process. However, there is currently no internal restriction preventing the acquisition of this XML data by other means, such as network, local file system, or shared object at runtime.



Propriedades Públicas
 PropriedadeDefinido por
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  xml : XML
[static] The XML configuration; this value must contain the relevant portions of the <services> tag from the services-config.xml file.
ServerConfig
Métodos Públicos
 MétodoDefinido por
  
checkChannelConsistency(destinationA:String, destinationB:String):void
[static] This method ensures that the destinations specified contain identical channel definitions.
ServerConfig
  
getChannel(id:String, clustered:Boolean = false):Channel
[static] Returns a shared instance of the configured Channel.
ServerConfig
  
[static] Returns a shared ChannelSet for use with the specified destination belonging to the service that handles the specified message type.
ServerConfig
  
getProperties(destinationId:String):XMLList
[static] Returns the property information for the specified destination
ServerConfig
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Detalhes da propriedade
xmlpropriedade
xml:XML  [read-write]

The XML configuration; this value must contain the relevant portions of the <services> tag from the services-config.xml file.


Implementação
    public static function get xml():XML
    public function set xml(value:XML):void
Detalhes do método
checkChannelConsistency()método
public static function checkChannelConsistency(destinationA:String, destinationB:String):void

This method ensures that the destinations specified contain identical channel definitions. If the channel definitions between the two destinations specified are not identical this method will throw an ArgumentError.

Parâmetros

destinationA:String — destinationA:String first destination to compare against
 
destinationB:String — destinationB:String second destination to compare channels with

getChannel()método 
public static function getChannel(id:String, clustered:Boolean = false):Channel

Returns a shared instance of the configured Channel.

Parâmetros

id:String — The id of the desired Channel.
 
clustered:Boolean (default = false) — True if the Channel will be used in a clustered fashion; otherwise false.

Retorna
Channel — The Channel instance.

Throws
InvalidChannelError — If no Channel has the specified id.
getChannelSet()método 
public static function getChannelSet(destinationId:String):ChannelSet

Returns a shared ChannelSet for use with the specified destination belonging to the service that handles the specified message type.

Parâmetros

destinationId:String — The target destination id.

Retorna
ChannelSet — The ChannelSet.

Throws
InvalidDestinationError — If the specified destination does not have channels and the application did not define default channels.
getProperties()método 
public static function getProperties(destinationId:String):XMLList

Returns the property information for the specified destination

Parâmetros

destinationId:String — The id of the desired destination.

Retorna
XMLList — XMLList containing the <property> tag information.

Throws
InvalidDestinationError — If the specified destination is not found.