Packagelc.domain.impl.v1
Classpublic class SessionManager
InheritanceSessionManager Inheritance EventDispatcher Inheritance Object
Implements ISessionManager

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 ES server.

See also

lc.core.AuthenticatingApplication

Public Properties
 PropertyDefined By
  authenticatedUser : User
The authenticated user, which will valid 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
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  faultHandler : Function
The default fault handler function.
SessionManager
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  remotingChannelSet : ChannelSet
[read-only] 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
[read-only] The SAML assertion data that can be used to pass authentication to LiveCycle Data Services ES.
SessionManager
Public Methods
 MethodDefined By
  
SessionManager(url:String, session:SessionMap)
Constructor.
SessionManager
 Inherited
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
 Inherited
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
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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(userid:String, password:String):Token
Logs in to the server, authenticating the user.
SessionManager
  
logout():Token
Logs off the server, which invalidates the server session.
SessionManager
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
singleSignOn():Token
Determines whether an authenticated session to the server already exists or can be established without additional information (for example, in single sign-on (SSO) scenarios).
SessionManager
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
 Event Summary Defined By
 Inherited
activate
Dispatched when Flash Player gains operating system focus and becomes active.EventDispatcher
  
authenticationExpired
The event is dispatched when the authenticated session with the server expires.SessionManager
 Inherited
deactivate
Dispatched when Flash Player loses operating system focus and is becoming inactive.EventDispatcher
Property Detail
authenticatedUserproperty
authenticatedUser:User  [read-write]

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


Implementation
    public function get authenticatedUser():User
    public function set authenticatedUser(value:User):void
buildDateproperty 
buildDate:String  [read-only]

The build date.


Implementation
    public function get buildDate():String
buildNumberproperty 
buildNumber:String  [read-only]

The build number.


Implementation
    public function get buildNumber():String
faultHandlerproperty 
faultHandler:Function  [read-write]

The default fault handler function. The function must take a single parameter of type WorkspaceFaultEvent. Note that all LiveCycle Workspace ES API fault events will be dispatched to this function, not just the events from the ISessionManager implementation.


Implementation
    public function get faultHandler():Function
    public function set faultHandler(value:Function):void
remotingChannelSetproperty 
remotingChannelSet:ChannelSet  [read-only]

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
serverUrlproperty 
serverUrl:String  [read-only]

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


Implementation
    public function get serverUrl():String
userAssertionproperty 
userAssertion:String  [read-only]

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


Implementation
    public function get userAssertion():String
Constructor Detail
SessionManager()Constructor
public function SessionManager(url:String, session:SessionMap)

Constructor.

Parameters
url: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 ES SWF file is retrieved.
 
session:SessionMap — Specifies the SessionMap object to use.
Method Detail
getRemotingEndpoint()method
public function getRemotingEndpoint(endpointName:String):RemoteObject

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 — A RemoteObject object configured to invoke the specified process as the currently authenticated user.
login()method 
public function login(userid:String, password:String):Token

Logs in to the server, authenticating the user.

Parameters

userid:String
 
password:String

Returns
Token — A token used to set result and fault handlers to be called when the operation has completed.
logout()method 
public function logout():Token

Logs off the server, which invalidates the server session.

Returns
Token — A token used to set result and fault handlers to be called when the operation has completed.
singleSignOn()method 
public function singleSignOn():Token

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

Returns
Token — A token used to set result and fault handlers to be called when the operation has completed.
Event Detail
authenticationExpired Event
Event Object Type: lc.core.events.WorkspaceFaultEvent
WorkspaceFaultEvent.type property = flash.events.DataEvent.FORM_INITIAL_DATA

The event is dispatched when the authenticated session with the server expires.




© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/domain/impl/v1/SessionManager.html