SessionManager

(Beta)

Package	lc.foundation
Class	public class SessionManager
Inheritance	SessionManager Manager EventDispatcher Object
Implements	ISessionManager

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 LiveCycle ES2 server.

For information on using this component to customize Workspace ES2, see Customizing the LiveCycle Workspace ES2 User Interface .

Related API Elements

lc.procmgmt.AuthenticatingApplication

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined 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] The ChannelSet object that is used by the base connectivity.	SessionManager
		clientUrl : String [read-only] The server address, as a URL, for the client collateral.	SessionManager
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		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 LiveCycle 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 LiveCycle Data Services ES2.	SessionManager
		userManagerUrl : String [read-only] The URL for single-sign on and authentication.	SessionManager

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null) Constructor.	SessionManager
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getRemotingEndpoint(endpointName:String):RemoteObject Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking the specified LiveCycle Remoting endpoint.	SessionManager
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		singleSignOn():lc.foundation.util:Token Determines whether an authenticated session to the LiveCycle ES2 server already exists or can be established without additional information, such as in single sign-on (SSO).	SessionManager
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
authenticationExpired	Dispatched when the authenticated session with the LiveCycle ES2 server expires.	SessionManager
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

	Constant		Defined 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

	Constant		Defined 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The ChannelSet object that is used by the base connectivity.

Implementation
public function get channelSet():ChannelSet

clientUrl

property

clientUrl:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

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

Implementation
public function get clientUrl():String

loadLocationUrl

property

loadLocationUrl:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A ChannelSet object that is appropriate for use with LiveCycle Remoting. Generally, using the getRemotingEndpoint 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

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

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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The URL for single-sign on and authentication.

Implementation
public function get userManagerUrl():String

Constructor Detail

()

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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 LiveCycle ES server at the same location from where the LiveCycle Workspace ES2 SWF file is retrieved.

	`session:SessionMap` — Specifies the `SessionMap` object to use.

	`clientUrl:String` (default = `null`) — Specifies URL to access Workspace ES2 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking the specified LiveCycle Remoting endpoint. Successful authentication is a prerequisite.

Parameters

endpointName:String — Specifies the name of the LiveCycle Remoting endpoint.

Returns

RemoteObject — An object configured to invoke the specified process as the currently authenticated user.

login

()

method

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

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Determines whether an authenticated session to the LiveCycle ES2 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Dispatched when the authenticated session with the LiveCycle ES2 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 ES2.

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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, 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 Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

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

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

SessionManager - AS3 ADEP Document Services

Classes x

authenticatedUser

buildDate

buildNumber

channelSet

clientUrl

loadLocationUrl

remotingChannelSet

serverUrl

userAssertion

userManagerUrl

SessionManager

getRemotingEndpoint

login

logout

singleSignOn

authenticationExpired

MSG_AUTHENTICATION_EXPIRED

MSG_BAD_CREDENTIALS

MSG_CREDENTIALS_REQUIRED

MSG_NON_SPECIFIC_ERROR

MSG_SERVER_BAD_CREDENTIALS

SESSION_KEY