ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.messaging.config 

ServerConfig  - AS3 BlazeDS LCDS
Packagemx.messaging.config
Classpublic class ServerConfig
InheritanceServerConfig Inheritance Object

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

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.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
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
Public Methods
 MethodDefined By
  
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
  
getChannelSet(destinationId:String):ChannelSet
[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
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

xml

property
xml:XML

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

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



Implementation
    public static function get xml():XML
    public static function set xml(value:XML):void
Method Detail

checkChannelConsistency

()method
public static function checkChannelConsistency(destinationA:String, destinationB:String):void

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

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.

Parameters

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

getChannel

()method 
public static function getChannel(id:String, clustered:Boolean = false):Channel

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns a shared instance of the configured Channel.

Parameters

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.

Returns
Channel — The Channel instance.

Throws
InvalidChannelError — If no Channel has the specified id.

getChannelSet

()method 
public static function getChannelSet(destinationId:String):ChannelSet

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

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

Parameters

destinationId:String — The target destination id.

Returns
ChannelSet — The ChannelSet.

Throws
InvalidDestinationError — If the specified destination does not have channels and the application did not define default channels.

getProperties

()method 
public static function getProperties(destinationId:String):XMLList

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the property information for the specified destination

Parameters

destinationId:String — The id of the desired destination.

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

Throws
InvalidDestinationError — If the specified destination is not found.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy