| Package | com.adobe.mosaic.mxml |
| Class | public class ServerSession |
| Inheritance | ServerSession  FrameworkInitializer |
| Implements | IMXMLObject |
| 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 |
ServerSession repesents a remote server's location and an ISession.
It's purpose is use the ISessionManager in the runtime to successfully connect
the to server and create a new ISession so that other composite application MXML components may have
a pathway to the Experience Server. ServerSession encapsulates a session with a specific server
for use by other components. It does NOT provide authentication functionality.
Authentication handling functionality is set upon this component on the securityManager property
and in the form of an ISecurityManager.
Related API Elements
com.adobe.mosaic.mxml.Application
com.adobe.mosaic.mxml.Catalog
com.adobe.mosaic.mxml.Shell
com.adobe.mosaic.mxml.Tile
com.adobe.mosaic.mxml.Service
| Property | Defined By | ||
|---|---|---|---|
| autoConnect : Boolean
Returns the value of autoConnect. | ServerSession | ||
| cachePolicy : ICachePolicy
Returns the value of cachePolicy (if one is set). | ServerSession | ||
| id : String
Returns the id of the component
| ServerSession | ||
| securityManager : ISecurityManager
Returns the ISecurityManager
| ServerSession | ||
| state : String [read-only]
Returns the state of the underlying ISession
| ServerSession | ||
| url : String
The value of the fully qualified URL path to the Experience Server. | ServerSession | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ServerSession | ||
This will begin an Experiene Server connection sequence,
once the framework and runtime are ready,
by first acquiring the ISessionManager, and
subsequently connecting an ISession. | ServerSession | ||
Returns the ISessionManager instance associated to the runtime
| ServerSession | ||
Implementation of IMXMLObject initialized. | ServerSession | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an OpenSessionEvent call fails. | ServerSession | |||
| Dispatched upon the first successful OpenSessionEvent from the remote server. | ServerSession | |||
autoConnect | property |
autoConnect:Boolean| 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 the value of autoConnect. Default is true. autoConnect only affects MXML usage by automatically connecting to the server once all properties are set. url and securityManager properties must be set before connection can succeed. For ActionScript usage, call connect() once url and securityManager properties are set.
Implementation
public function get autoConnect():Boolean public function set autoConnect(value:Boolean):voidRelated API Elements
cachePolicy | property |
cachePolicy:ICachePolicy| 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 the value of cachePolicy (if one is set). Default is CachePolicy.NONE.
Implementation
public function get cachePolicy():ICachePolicy public function set cachePolicy(value:ICachePolicy):voidRelated API Elements
id | property |
id:String| 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 the id of the component
Implementation
public function get id():String public function set id(value:String):voidsecurityManager | property |
securityManager:ISecurityManager| 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 the ISecurityManager
Implementation
public function get securityManager():ISecurityManager public function set securityManager(value:ISecurityManager):voidRelated API Elements
state | property |
state:String [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 the state of the underlying ISession
Implementation
public function get state():StringRelated API Elements
url | property |
url:String| 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 value of the fully qualified URL path to the Experience Server.
Implementation
public function get url():String public function set url(value:String):voidServerSession | () | Constructor |
public function ServerSession()| 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 |
Constructor.
connect | () | method |
public function connect():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 |
This will begin an Experiene Server connection sequence, once the framework and runtime are ready, by first acquiring the ISessionManager, and subsequently connecting an ISession. This method will be called automatically from "initialized" if the autoConnect property is set to true and the url and security manager values have been set.
getSessionManager | () | method |
public function getSessionManager():ISessionManager| 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 the ISessionManager instance associated to the runtime
ReturnsISessionManager — ISessionManager
|
Related API Elements
initialized | () | method |
public function initialized(document:Object, id:String):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 |
Implementation of IMXMLObject initialized. If autoConnect is set to true and the url and security manager values have been set, the connect method will be called here.
Parameters
document:Object — The document
| |
id:String — The mxml id
|
openSessionEventFailure | Event |
com.adobe.mosaic.om.events.OpenSessionEventproperty OpenSessionEvent.type =
com.adobe.mosaic.om.events.OpenSessionEvent.FAILURE| 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 |
Dispatched when an OpenSessionEvent call fails.
This type is sent when handling failed in opening an ISessionopenSessionEventSuccess | Event |
com.adobe.mosaic.om.events.OpenSessionEventproperty OpenSessionEvent.type =
com.adobe.mosaic.om.events.OpenSessionEvent.SUCCESS| 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 |
Dispatched upon the first successful OpenSessionEvent from the remote server.
This type is sent when handling succeeded in opening an ISessionMon Apr 10 2017, 12:28 PM -07:00