Packagelc.core
Interfacepublic interface ISessionManager extends IEventDispatcher
ImplementorsSessionManager

The ISessionManager interface is implemented to expose operations and properties related to the LiveCycle ES server session. You implement this interface to authenticate a user and provide the session that is required for all other server operations.


Public Properties
 PropertyDefined By
  authenticatedUser : User
The authenticated user, which will valid after the successful call using the login or singleSignOn methods.
ISessionManager
  buildDate : String
[read-only] The build date.
ISessionManager
  buildNumber : String
[read-only] The build number.
ISessionManager
  faultHandler : Function
The default fault handler function.
ISessionManager
  remotingChannelSet : ChannelSet
[read-only] A ChannelSet object that is appropriate for use with LiveCycle Remoting.
ISessionManager
  serverUrl : String
[read-only] The server address, as a URL, for the server session.
ISessionManager
  userAssertion : String
[read-only] The SAML assertion data that can be used to pass authentication to LiveCycle Data Services ES.
ISessionManager
Public Methods
 MethodDefined By
 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.
IEventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
IEventDispatcher
  
getRemotingEndpoint(endpointName:String):RemoteObject
Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking the specified LiveCycle Remoting endpoint.
ISessionManager
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
login(userid:String, password:String):Token
Logs in to the server, authenticating the user.
ISessionManager
  
logout():Token
Logs off the server, which invalidates the server session.
ISessionManager
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
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).
ISessionManager
 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.
IEventDispatcher
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

See also

lc.core.ISessionManager.getRemotingEndpoint
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
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.



© 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/core/ISessionManager.html