套件 | com.adobe.livecycle.ria.security.api |
介面 | public interface ISecurityManager extends IEventDispatcher |
實作者 | SecurityManager |
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | 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.
屬性 | 定義自 | ||
---|---|---|---|
currentUser : IUser [唯讀]
Current logged in user instance. | ISecurityManager |
方法 | 定義自 | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式,以便讓偵聽程式收到事件的通知。 | IEventDispatcher | ||
Configures the ISecurityManager instance with the provided configuration information. | ISecurityManager | ||
會將事件傳送到事件流程。 | IEventDispatcher | ||
Returns a ticket for the current user. | ISecurityManager | ||
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | 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 | ||
會從 EventDispatcher 物件移除偵聽程式。 | IEventDispatcher | ||
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式,或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | IEventDispatcher |
事件 | 摘要 | 定義自 | ||
---|---|---|---|---|
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 |
currentUser | 屬性 |
currentUser:IUser
[唯讀] 語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | AIR 2.6, Flash Player 10.2 |
Current logged in user instance. The value is never a null
value.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 propertyChange
事件。
實作
public function get currentUser():IUser
configure | () | 方法 |
public function configure(securityConfig:SecurityConfig):void
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | AIR 2.6, Flash Player 10.2 |
Configures the ISecurityManager
instance with the provided configuration information.
參數
securityConfig:SecurityConfig — Specifies the initial configuration for the SecurityManager service.
|
getTicket | () | 方法 |
public function getTicket():com.adobe.gravity.utility.async:IToken
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | 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.
傳回值com.adobe.gravity.utility.async:IToken — If the call is successful then an instance of ITicket would be passed to the result handler.
|
相關 API 元素
login | () | 方法 |
public function login(username:String, password:String, options:AuthOptions = null):com.adobe.gravity.utility.async:IToken
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | 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
.
參數
username:String — Specifies the user identifier of the user.
| |
password:String — Specifies password of the user.
| |
options:AuthOptions (default = null ) — (Optional)Specifies attributes to control how authentication is performed.
|
com.adobe.gravity.utility.async:IToken — If the call is successful then an instance of IAuthResult would be passed to the result handler.
|
相關 API 元素
logout | () | 方法 |
public function logout():com.adobe.gravity.utility.async:IToken
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | AIR 2.6, Flash Player 10.2 |
Logs out the current user.
傳回值com.adobe.gravity.utility.async:IToken — If the call is successful then an instance of IAuthResult would be passed to the result handler.
|
performSSO | () | 方法 |
public function performSSO(options:AuthOptions = null):com.adobe.gravity.utility.async:IToken
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | AIR 2.6, Flash Player 10.2 |
Initiates the call to perform Authentication for the current user.
參數
options:AuthOptions (default = null ) — (Optional) Specifies an AuthOption instance to control how the authentication is performed.
|
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.
|
COMPLETE | 事件 |
com.adobe.livecycle.ria.security.api.AuthenticationEvent
屬性 AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEvent.AUTHENTICATION_SUCCESS
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | 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 | 事件 |
com.adobe.livecycle.ria.security.api.AuthenticationEvent
屬性 AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEvent.AUTHENTICATION_REQUIRED
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | 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 | 事件 |
com.adobe.livecycle.ria.security.api.AuthenticationEvent
屬性 AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEvent.AUTHENTICATION_FAILED
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | 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 | 事件 |
com.adobe.livecycle.ria.security.api.AuthenticationEvent
屬性 AuthenticationEvent.type =
com.adobe.livecycle.ria.security.api.AuthenticationEvent.LOGOUT_COMPLETE
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
執行階段版本: | 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.Tue Jun 12 2018, 03:47 PM Z