| Package | com.adobe.icc.services.user |
| Interface | public interface ISSOManager extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
ISSOManager expose operations related to Single Sign On (SSO) in LiveCycle ES
environment. The application should register appropriate UserEvent handlers prior
to calling any of the following operations
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| assertionId : String [read-only]
Get the assertionId for the logged in user
| ISSOManager | ||
| currentUser : User [read-only] Current logged in user. | ISSOManager | ||
| flexConfig : FlexConfiguration Flex Configuration. | ISSOManager | ||
| securityManager : ISecurityManager [read-only]
Returns RIA SecurityManager
| ISSOManager | ||
Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
 | 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 | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Loads the user based on the session. | ISSOManager | ||
Authenticates the user using username and password. | ISSOManager | ||
Terminates the current session and logs out the user.Will lead to one of the following events:
UserEvent.LOGOUT_COMPLETE - user session has been terminated
| ISSOManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Renew the session id of current logged in user. | ISSOManager | ||
Tries to validate whether the user has an already existing session or not (SSO Scenarios). | ISSOManager | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Property Detail
assertionId | property |
currentUser | property |
currentUser:User [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Current logged in user.
This property can be used as the source for data binding. When this property is modified, it dispatches the currentUserChange event.
Implementation
public function get currentUser():UserflexConfig | property |
flexConfig:FlexConfiguration| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Flex Configuration.
Implementation
public function get flexConfig():FlexConfiguration public function set flexConfig(value:FlexConfiguration):voidsecurityManager | property |
securityManager:ISecurityManager [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Returns RIA SecurityManager
Implementation
public function get securityManager():ISecurityManagerMethod Detail
loadUser | () | method |
public function loadUser():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Loads the user based on the session. Will lead to one of the following events:
- UserEvent.LOAD_USER_COMPLETE - The
currentUserproperty is loaded with information on the user that established the session - userLoadError (FaultEvent) - Failed to load user information
login | () | method |
public function login(username:String, password:String, domain:String = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Authenticates the user using username and password. It may lead to one of the following events
- UserEvent.AUTHENTICATION_SUCCESS - The authentication is successful and a session is established
- UserEvent.AUTHENTICATION_FAILED - Authentication has failed
Parameters
username:String — The username entered to login.
| |
password:String — The password entered to login.
| |
domain:String (default = null) |
logout | () | method |
public function logout():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Terminates the current session and logs out the user.Will lead to one of the following events:
- UserEvent.LOGOUT_COMPLETE - user session has been terminated
renewSession | () | method |
public function renewSession():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Renew the session id of current logged in user. Will lead to one of the following events:
- UserEvent.RENEW_SESSION_COMPLETE - user session has been renewed
- renewSessionError (FaultEvent) - Failed to renew session
singleSignOn | () | method |
public function singleSignOn():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Tries to validate whether the user has an already existing session or not (SSO Scenarios). The application may call this method during the initialization. In general this call would lead to one of the following events getting dispatched
- UserEvent.AUTHENTICATION_SUCCESS - If a SSO session was found and valid
- UserEvent.AUTHENTICATION_REQUIRED - No SSO session was found and as such authentication is required in the form of username and password.
- UserEvent.AUTHENTICATION_FAILED - Some error has occured while connecting to the server
Mon Nov 28 2011, 06:48 AM -08:00