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

SessionManager  - AS3 ADEP Workspace
Packagelc.foundation
Classpublic class SessionManager
InheritanceSessionManager Inheritance Manager
Implements ISessionManager

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The SessionManager class is the standard implementation of the ISessionManager interface. Typically, the AuthenticatingApplication object is used, which automatically creates a SessionManager object.

If the AuthenticatingApplication class is not used, an instantiation of this class can be used to access Document Server.

For information on using this component to customize Workspace, see Customizing the Adobe Digital Enterprise Platform Document Services - Workspace User Interface .

Related API Elements

lc.procmgmt.AuthenticatingApplication

Public Properties
 PropertyDefined By
  authenticatedUser : User
The authenticated user, after the successful call using the login or singleSignOn methods.
SessionManager
  buildDate : String
[read-only] The build date.
SessionManager
  buildNumber : String
[read-only] The build number.
SessionManager
  channelSet : ChannelSet
[read-only] A ChannelSet object that is used with Remoting by DataService objects.
SessionManager
  clientUrl : String
[read-only] The server address, as a URL, for the client collateral.
SessionManager
  dataserviceChannelSet : ChannelSet
A ChannelSet object that is appropriate for use with Data Services.
SessionManager
  loadLocationUrl : String
[read-only] The server URL from which the SWF file is loaded.
SessionManager
  remotingChannelSet : ChannelSet
A ChannelSet object that is appropriate for use with Remoting.
SessionManager
  serverUrl : String
[read-only] The server address, as a URL, for the server session.
SessionManager
  userAssertion : String
The SAML assertion data that can be used to pass authentication to Data Services.
SessionManager
  userManagerUrl : String
[read-only] The URL for single-sign on and authentication.
SessionManager
Public Methods
 MethodDefined By
  
SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)
Constructor.
SessionManager
  
getRemotingEndpoint(endpointName:String):RemoteObject
Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service.
SessionManager
  
getRemotingService(serviceName:String):RemoteObject
Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service.
SessionManager
  
login(username:String, password:String):lc.foundation.util:Token
Logs in to the server, authenticating the user.
SessionManager
  
logout():lc.foundation.util:Token
Logs off the server, which invalidates the server session.
SessionManager
  
singleSignOn():lc.foundation.util:Token
Determines whether an authenticated session to the Document Server already exists or can be established without additional information, such as in single sign-on (SSO).
SessionManager
Events
Click for more information on events
 Event Summary Defined By
  
authenticationExpired
Dispatched when the authenticated session with the Document Server expires.SessionManager
Public Constants
 ConstantDefined By
  MSG_AUTHENTICATION_EXPIRED : String = "ALC-WKS-007-108"
[static] A special value that specifies an information message.
SessionManager
  SESSION_KEY : String = "lc.foundation.ISessionManager"
[static] A special value that specifies the manager key name in the SessionMap object.
SessionManager
Protected Constants
 ConstantDefined By
  MSG_BAD_CREDENTIALS : String = "ALC-WKS-007-001"
[static] A special value that specifies the user name, password, or both that was provided are invalid.
SessionManager
  MSG_CREDENTIALS_REQUIRED : String = "ALC-WKS-007-149"
[static] A special value that specifies login information is required.
SessionManager
  MSG_NON_SPECIFIC_ERROR : String = "ALC-WKS-007-000"
[static] A special value that specifies a non-specific error occurred.
SessionManager
  MSG_SERVER_BAD_CREDENTIALS : String = "ALC-WKS-005-000"
[static] A special value that specifies a server-side error identifier for bad credentials.
SessionManager
Property Detail

authenticatedUser

property
authenticatedUser:User

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The authenticated user, after the successful call using the login or singleSignOn methods.



Implementation
    public function get authenticatedUser():User
    public function set authenticatedUser(value:User):void

buildDate

property 
buildDate:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The build date.



Implementation
    public function get buildDate():String

buildNumber

property 
buildNumber:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The build number.



Implementation
    public function get buildNumber():String

channelSet

property 
channelSet:ChannelSet  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A ChannelSet object that is used with Remoting by DataService objects. This for internal use only.



Implementation
    public function get channelSet():ChannelSet

clientUrl

property 
clientUrl:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The server address, as a URL, for the client collateral.



Implementation
    public function get clientUrl():String

dataserviceChannelSet

property 
dataserviceChannelSet:ChannelSet

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A ChannelSet object that is appropriate for use with Data Services.



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

loadLocationUrl

property 
loadLocationUrl:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The server URL from which the SWF file is loaded. The URL does not include the name of the SWF file.



Implementation
    public function get loadLocationUrl():String

remotingChannelSet

property 
remotingChannelSet:ChannelSet

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A ChannelSet object that is appropriate for use with Remoting. Generally, using the getRemotingService method is more convenient.



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

serverUrl

property 
serverUrl:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The server address, as a URL, for the server session.



Implementation
    public function get serverUrl():String

userAssertion

property 
userAssertion:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The SAML assertion data that can be used to pass authentication to Data Services.



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

userManagerUrl

property 
userManagerUrl:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The URL for single-sign on and authentication.



Implementation
    public function get userManagerUrl():String
Constructor Detail

SessionManager

()Constructor
public function SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Parameters
server:String — Specifies the location of the server as a URL. If the URL is a value of null, the Manager default to accessing the Document Server at the same location from where the Workspace SWF file is retrieved.
 
session:SessionMap — Specifies the SessionMap object to use.
 
clientUrl:String (default = null) — Specifies URL to access the Document Server. A value of null specifies to use /workspace-server/.
 
userManagerUrl:String (default = null) — Specifies the URL for single-sign on and authentication. A value of null specifies to use /um/.
Method Detail

getRemotingEndpoint

()method
public function getRemotingEndpoint(endpointName:String):RemoteObject

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service. Successful authentication is a prerequisite.

Parameters

endpointName:String — Specifies the name of the Remoting startpoint.

Returns
RemoteObject — A ready to use RemoteObject.

getRemotingService

()method 
public function getRemotingService(serviceName:String):RemoteObject

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service. Successful authentication is a prerequisite.

Parameters

serviceName:String — Specifies the name of the Remoting startpoint.

Returns
RemoteObject — A ready to use RemoteObject.

login

()method 
public function login(username:String, password:String):lc.foundation.util:Token

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Logs in to the server, authenticating the user.

Parameters

username:String — Specifies the user profile.
 
password:String — Specifies the password.

Returns
lc.foundation.util:Token — A Token object used to set result and fault handlers that execute when the operation completes.

logout

()method 
public function logout():lc.foundation.util:Token

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Logs off the server, which invalidates the server session.

Returns
lc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.

singleSignOn

()method 
public function singleSignOn():lc.foundation.util:Token

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Determines whether an authenticated session to the Document Server already exists or can be established without additional information, such as in single sign-on (SSO). If an authenticated session is established, the server session is valid and the result handler on the returned token is called. If an authenticated session is not established, the fault handler is called.

Returns
lc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
Event Detail

authenticationExpired

 Event
Event Object Type: lc.foundation.events.LiveCycleFaultEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Dispatched when the authenticated session with the Document Server expires.

Constant Detail

MSG_AUTHENTICATION_EXPIRED

Constant
public static const MSG_AUTHENTICATION_EXPIRED:String = "ALC-WKS-007-108"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies an information message. The session for the user has expired. The user must log in again to Workspace.

MSG_BAD_CREDENTIALS

Constant 
protected static const MSG_BAD_CREDENTIALS:String = "ALC-WKS-007-001"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies the user name, password, or both that was provided are invalid.

MSG_CREDENTIALS_REQUIRED

Constant 
protected static const MSG_CREDENTIALS_REQUIRED:String = "ALC-WKS-007-149"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies login information is required.

MSG_NON_SPECIFIC_ERROR

Constant 
protected static const MSG_NON_SPECIFIC_ERROR:String = "ALC-WKS-007-000"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies a non-specific error occurred.

MSG_SERVER_BAD_CREDENTIALS

Constant 
protected static const MSG_SERVER_BAD_CREDENTIALS:String = "ALC-WKS-005-000"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies a server-side error identifier for bad credentials.

SESSION_KEY

Constant 
public static const SESSION_KEY:String = "lc.foundation.ISessionManager"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies the manager key name in the SessionMap object.




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

 

Legal Notices | Online Privacy Policy