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

AbstractService  - AS3 Flex
Packagemx.rpc
Classpublic dynamic class AbstractService
InheritanceAbstractService Inheritance Proxy
Implements IEventDispatcher
Subclasses AbstractWebService, HTTPMultiService, ManagedRemoteService, RemoteObject

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The AbstractService class is the base class for the HTTPMultiService, WebService, and RemoteObject classes. This class does the work of creating Operations which do the actual execution of remote procedure calls.


Public Properties
 PropertyDefined By
  channelSet : ChannelSet
Provides access to the ChannelSet used by the service.
AbstractService
  destination : String
The destination of the service.
AbstractService
  managers : Array
The managers property stores a list of data managers which modify the behavior of this service.
AbstractService
  operations : Object
The Operations array is usually only set by the MXML compiler if you create a service using an MXML tag.
AbstractService
  requestTimeout : int
Provides access to the request timeout in seconds for sent messages.
AbstractService
Public Methods
 MethodDefined By
  
AbstractService(destination:String = null)
Constructor.
AbstractService
  
disconnect():void
Disconnects the service's network connection and removes any pending request responders.
AbstractService
  
getOperation(name:String):AbstractOperation
Returns an Operation of the given name.
AbstractService
  
initialize():void
Called to initialize the service.
AbstractService
  
logout():void
Logs the user out of the destination.
AbstractService
  
setCredentials(username:String, password:String, charset:String = null):void
Sets the credentials for the destination accessed by the service when using Data Services on the server side.
AbstractService
  
setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void
The username and password to be used to authenticate a user when accessing a remote, third-party endpoint such as a web service through a proxy or a remote object through a custom adapter when using Data Services on the server side.
AbstractService
Events
Click for more information on events
 Event Summary Defined By
  
fault
The fault event is dispatched when a service call fails and isn't handled by the Operation itself.AbstractService
  
invoke
The invoke event is dispatched when a service Operation is invoked so long as an Error is not thrown before the Channel attempts to send the message.AbstractService
  
result
The result event is dispatched when a service call successfully returns and isn't handled by the Operation itself.AbstractService
Property Detail

channelSet

property
channelSet:ChannelSet

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Provides access to the ChannelSet used by the service. The ChannelSet can be manually constructed and assigned, or it will be dynamically created to use the configured Channels for the destination for this service.



Implementation
    public function get channelSet():ChannelSet
    public function set channelSet(value:ChannelSet):void

destination

property 
destination:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The destination of the service. This value should match a destination entry in the services-config.xml file.



Implementation
    public function get destination():String
    public function set destination(value:String):void

managers

property 
managers:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The managers property stores a list of data managers which modify the behavior of this service. You can use this hook to define one or more manager components associated with this service. When this property is set, if the managers have a property called "service" that property is set to the value of this service. When this service is initialized, we also call the initialize method on any manager components.



Implementation
    public function get managers():Array
    public function set managers(value:Array):void

operations

property 
operations:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The Operations array is usually only set by the MXML compiler if you create a service using an MXML tag.



Implementation
    public function get operations():Object
    public function set operations(value:Object):void

requestTimeout

property 
requestTimeout:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Provides access to the request timeout in seconds for sent messages. A value less than or equal to zero prevents request timeout.



Implementation
    public function get requestTimeout():int
    public function set requestTimeout(value:int):void
Constructor Detail

AbstractService

()Constructor
public function AbstractService(destination:String = null)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
destination:String (default = null) — The destination of the service.
Method Detail

disconnect

()method
public function disconnect():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Disconnects the service's network connection and removes any pending request responders. This method does not wait for outstanding network operations to complete.

getOperation

()method 
public function getOperation(name:String):AbstractOperation

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns an Operation of the given name. If the Operation wasn't created beforehand, subclasses are responsible for creating it during this call. Operations are usually accessible by simply naming them after the service variable (myService.someOperation), but if your Operation name happens to match a defined method on the service (like setCredentials), you can use this method to get the Operation instead.

Parameters

name:String — Name of the Operation.

Returns
AbstractOperation — Operation that executes for this name.

initialize

()method 
public function initialize():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Called to initialize the service.

logout

()method 
public function logout():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Logs the user out of the destination. Logging out of a destination applies to everything connected using the same ChannelSet as specified in the server configuration. For example, if you're connected over the my-rtmp channel and you log out using one of your RPC components, anything that was connected over the same ChannelSet is logged out.

Note: Adobe recommends that you use the mx.messaging.ChannelSet.logout() method rather than this method.

Related API Elements

mx.messaging.ChannelSet.logout()

setCredentials

()method 
public function setCredentials(username:String, password:String, charset:String = null):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the credentials for the destination accessed by the service when using Data Services on the server side. The credentials are applied to all services connected over the same ChannelSet. Note that services that use a proxy or a third-party adapter to a remote endpoint will need to setRemoteCredentials instead.

Parameters

username:String — The username for the destination.
 
password:String — The password for the destination.
 
charset:String (default = null) — The character set encoding to use while encoding the credentials. The default is null, which implies the legacy charset of ISO-Latin-1. The only other supported charset is "UTF-8".

setRemoteCredentials

()method 
public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The username and password to be used to authenticate a user when accessing a remote, third-party endpoint such as a web service through a proxy or a remote object through a custom adapter when using Data Services on the server side.

Parameters

remoteUsername:String — The username to pass to the remote endpoint
 
remotePassword:String — The password to pass to the remote endpoint
 
charset:String (default = null) — The character set encoding to use while encoding the remote credentials. The default is null, which implies the legacy charset of ISO-Latin-1. The only other supported charset is "UTF-8".
Event Detail

fault

 Event
Event Object Type: mx.rpc.events.FaultEvent
property FaultEvent.type = mx.rpc.events.FaultEvent.FAULT

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The fault event is dispatched when a service call fails and isn't handled by the Operation itself.

The FAULT event type.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
faultThe Fault object that contains the details of what caused this event.
messageThe Message associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
tokenThe token that represents the call to the method. Used in the asynchronous completion token pattern.

invoke

 Event  
Event Object Type: mx.rpc.events.InvokeEvent
property InvokeEvent.type = mx.rpc.events.InvokeEvent.INVOKE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The invoke event is dispatched when a service Operation is invoked so long as an Error is not thrown before the Channel attempts to send the message.

The INVOKE event type.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
token The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
message The request Message associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

result

 Event  
Event Object Type: mx.rpc.events.ResultEvent
property ResultEvent.type = mx.rpc.events.ResultEvent.RESULT

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The result event is dispatched when a service call successfully returns and isn't handled by the Operation itself.

The RESULT event type.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue, preventDefault() from the associated token's responder.result method will prevent the service or operation from dispatching this event
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
message The Message associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
resultResult that the RPC call returns.
tokenThe token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.



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

 

Legal Notices | Online Privacy Policy