| Package | com.adobe.livecycle.ria.security.api |
| Interface | public interface ISecurityManager extends IEventDispatcher |
| Implementors | SecurityManager |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
ISecurityManager interface provides methods to perform user authentication. The class also provides access to the current
user instance.
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| currentUser : IUser [read-only]
Current logged in user instance. | ISecurityManager | ||
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 | |
Configures the ISecurityManager instance with the provided configuration information. | ISecurityManager | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Returns a ticket for the current user. | ISecurityManager | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
login(username:String, password:String, options:AuthOptions = null):com.adobe.gravity.utility.async:IToken
Perform authentication with the provided username and password. | ISecurityManager | ||
Logs out the current user. | ISecurityManager | ||
Initiates the call to perform Authentication for the current user. | ISecurityManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| The event is dispatched after the authentication process has completed successfully. | ISecurityManager | |||
| The event is dispatched when authentication is required. | ISecurityManager | |||
| The event is dispatched when an authentication attempt fails. | ISecurityManager | |||
| The event is dispatched after a user has been logged out. | ISecurityManager | |||
Property Detail
currentUser | property |
currentUser:IUser [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Current logged in user instance. The value is never a null value.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get currentUser():IUserMethod Detail
configure | () | method |
public function configure(securityConfig:SecurityConfig):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Configures the ISecurityManager instance with the provided configuration information.
Parameters
securityConfig:SecurityConfig — Specifies the initial configuration for the SecurityManager service.
|
getTicket | () | method |
public function getTicket():com.adobe.gravity.utility.async:IToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns a ticket for the current user.
Depending on the server setup the ticket can be of type TicketType.SHORT_TICKET or
TicketType.PIN. In any case the ticket value would be suitable for use as part of GET request. This
method should be used to obtain a ticket for performing authentication in case of file uploads.
In case if TicketType is PIN then client might make a remote call to server to initialize the pin or in case of expired pin get a new pin issued.
Returnscom.adobe.gravity.utility.async:IToken — If the call is successful then an instance of ITicket would be passed to the result handler.
|
Related API Elements
login | () | method |
public function login(username:String, password:String, options:AuthOptions = null):com.adobe.gravity.utility.async:IToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Perform authentication with the provided username and password. This method is invoked when the
IAuthResult.status obtained from the performSSO property
is a value of AuthStatus.AUTHENTICATION_FAILED or AuthStatus.AUTHENTICATION_REQUIRED.
Parameters
username:String — Specifies the user identifier of the user.
| |
password:String — Specifies password of the user.
| |
options:AuthOptions (default = null) |
com.adobe.gravity.utility.async:IToken — If the call is successful then an instance of IAuthResult would be passed to the result handler.
|
Related API Elements
logout | () | method |
public function logout():com.adobe.gravity.utility.async:IToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Logs out the current user.
Returnscom.adobe.gravity.utility.async:IToken — If the call is successful then an instance of IAuthResult would be passed to the result handler.
|
performSSO | () | method |
public function performSSO(options:AuthOptions = null):com.adobe.gravity.utility.async:IToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Initiates the call to perform Authentication for the current user.
Parameters
options:AuthOptions (default = null) |
com.adobe.gravity.utility.async:IToken — A token used to set success and failure handler to be called when the operation is completed. If the
call was successful, then an IAuthResult object is passed to the result handler.
|
Event Detail
COMPLETE | Event |
Event Object Type:
property AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEventproperty AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEvent.AUTHENTICATION_SUCCESS| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The event is dispatched after the authentication process has completed successfully.
A special value that indicates that the authentication process was successful. Authentication can be completed using single sign-on (SSO) or a username and password. As a response to this event the application can show the welcome page to the user. An application can validate for permissions and roles to further verify the user is allowed access. As a response to this event, an application would do complete the validation and then display the welcome page.CREDENTIAL_CHALLENGE | Event |
Event Object Type:
property AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEventproperty AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEvent.AUTHENTICATION_REQUIRED| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The event is dispatched when authentication is required. Authentication is required when an application starts and then detects that user identity is not known and the user has to authenticate.
A special value that indicates the type of event that is dispatched when authentication using single sign-on (SSO) fails. When SSO fails, the user's username and password is required for authentication. As a response to this event, an application can display the login page to the user.FAILED | Event |
Event Object Type:
property AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEventproperty AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEvent.AUTHENTICATION_FAILED| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The event is dispatched when an authentication attempt fails.
A special value that indicates the type of event that is dispatched when authentication fails using the username and password. As a response to this type of event, an application can show an error message to the user. This event would only happen when authentication is done using username and password and NOT in single sign-on scenario.LOGGED_OUT | Event |
Event Object Type:
property AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEventproperty AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEvent.LOGOUT_COMPLETE| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The event is dispatched after a user has been logged out.
A special value that indicates the type of event that is dispatched a user logs off. As a response to this event, an application can display the logout page. The logout page can inform the user that he has been logged out. Alternatively, an application can display the login page to the user.Mon Nov 28 2011, 06:48 AM -08:00