ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.icc.services.user 

ISSOManager  - AS3 Asset Composer
Packagecom.adobe.icc.services.user
Interfacepublic 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

The 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
 PropertyDefined 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
 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
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
loadUser():void
Loads the user based on the session.
ISSOManager
  
login(username:String, password:String, domain:String = null):void
Authenticates the user using username and password.
ISSOManager
  
logout():void
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
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
renewSession():void
Renew the session id of current logged in user.
ISSOManager
  
singleSignOn():void
Tries to validate whether the user has an already existing session or not (SSO Scenarios).
ISSOManager
 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

assertionId

property
assertionId:String  [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

Get the assertionId for the logged in user



Implementation
    public function get assertionId():String

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():User

flexConfig

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):void

securityManager

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():ISecurityManager
Method 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 currentUser property 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) — The domain entered to login.

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



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

 

Legal Notices | Online Privacy Policy