ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.mosaic.om.interfaces 

ISessionManager  - AS3 ADEP Composite Application

Packagecom.adobe.mosaic.om.interfaces
Interfacepublic interface ISessionManager extends IManager

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The ISessionManager interface represents an instance of a server connection pool. Use this interface to create and destroy sessions. The implementation of this object will be responsible for connecting, building, and tearing-down server sessions.



Public Properties
 PropertyDefined By
 Inheritedname : String
[read-only] Returns the name associated with the manager object.
IManager
  sessions : Array
[read-only] Returns an Array of type ISession representing all opened sessions.
ISessionManager
Public Methods
 MethodDefined By
  
closeAllSessions(onSuccess:Function = null, onFailure:Function = null):void
Initiates the destruction of all open ISession instances.
ISessionManager
  
closeSession(session:ISession, onSuccess:Function = null, onFailure:Function = null):void
Initiates the destruction of an ISession instance.
ISessionManager
  
openSession(config:ISessionConfiguration, onSuccess:Function = null, onFailure:Function = null):void
Creates an ISession instance based on the supplied configuration information.
ISessionManager
Property Detail

sessions

property
sessions:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Returns an Array of type ISession representing all opened sessions.



Implementation
    public function get sessions():Array
Method Detail

closeAllSessions

()method
public function closeAllSessions(onSuccess:Function = null, onFailure:Function = null):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Initiates the destruction of all open ISession instances.

Parameters

onSuccess:Function (default = null) — The onSuccess function.
 
onFailure:Function (default = null) — The onFailure function.

closeSession

()method 
public function closeSession(session:ISession, onSuccess:Function = null, onFailure:Function = null):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Initiates the destruction of an ISession instance. The ISession destruction generates a SessionEvent of type "sessionClosing" which is cancelable by any registered listener. If no listener invokes the "preventDefault()" method, then the session will be destroyed followed by a SessionEvent of type "sessionClosed".

Parameters

session:ISession — The ISession instance to close and destroy.
 
onSuccess:Function (default = null) — The onSuccess function.
 
onFailure:Function (default = null) — The onFailure function.

openSession

()method 
public function openSession(config:ISessionConfiguration, onSuccess:Function = null, onFailure:Function = null):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Creates an ISession instance based on the supplied configuration information. The Session is ready to be utilized for requests to the associated server, although certain communication faults may occur.

Parameters

config:ISessionConfiguration — The ISessionConfiguration to identify the session instance.
 
onSuccess:Function (default = null) — The onSuccess function.
 
onFailure:Function (default = null) — The onFailure function.