ISecurityManager - Guide de référence de l’API Adobe ActionScript® 3 (AS3 ADEP Security)

Package	com.adobe.livecycle.ria.security.api
Interface	public interface ISecurityManager extends IEventDispatcher
Implémenteurs	SecurityManager

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

AIR 2.6, Flash Player 10.2

The ISecurityManager interface provides methods to perform user authentication. The class also provides access to the current user instance.

Propriétés publiques

	Propriété		Défini par
		currentUser : IUser [lecture seule] Current logged in user instance.	ISecurityManager

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.	IEventDispatcher
		configure(securityConfig:SecurityConfig):void Configures the ISecurityManager instance with the provided configuration information.	ISecurityManager
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	IEventDispatcher
		getTicket():com.adobe.gravity.utility.async:IToken Returns a ticket for the current user.	ISecurityManager
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	IEventDispatcher
		login(username:String, password:String, options:AuthOptions = null):com.adobe.gravity.utility.async:IToken Perform authentication with the provided username and password.	ISecurityManager
		logout():com.adobe.gravity.utility.async:IToken Logs out the current user.	ISecurityManager
		performSSO(options:AuthOptions = null):com.adobe.gravity.utility.async:IToken Initiates the call to perform Authentication for the current user.	ISecurityManager
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	IEventDispatcher
		willTrigger(type:String):Boolean Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.	IEventDispatcher

Evénements

Cliquez pour plus d’informations sur les événements

	Synthèse	Défini par
COMPLETE	The event is dispatched after the authentication process has completed successfully.	ISecurityManager
CREDENTIAL_CHALLENGE	The event is dispatched when authentication is required.	ISecurityManager
FAILED	The event is dispatched when an authentication attempt fails.	ISecurityManager
LOGGED_OUT	The event is dispatched after a user has been logged out.	ISecurityManager

Détails de la propriété

currentUser

propriété

currentUser:IUser [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

AIR 2.6, Flash Player 10.2

Current logged in user instance. The value is never a null value.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get currentUser():IUser

Détails de la méthode

configure

()

méthode

public function configure(securityConfig:SecurityConfig):void

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

AIR 2.6, Flash Player 10.2

Configures the ISecurityManager instance with the provided configuration information.

Paramètres

securityConfig:SecurityConfig — Specifies the initial configuration for the SecurityManager service.

getTicket

()

méthode

public function getTicket():com.adobe.gravity.utility.async:IToken

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

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.

Valeur renvoyée

com.adobe.gravity.utility.async:IToken — If the call is successful then an instance of ITicket would be passed to the result handler.

Eléments de l’API associés

TicketType.PIN
TicketType.SHORT_TICKET

login

()

méthode

 public function login(username:String, password:String, options:AuthOptions = null):com.adobe.gravity.utility.async:IToken

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

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.

Paramètres

	`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.

Valeur renvoyée

com.adobe.gravity.utility.async:IToken — If the call is successful then an instance of IAuthResult would be passed to the result handler.

Eléments de l’API associés

AuthStatus

logout

()

méthode

public function logout():com.adobe.gravity.utility.async:IToken

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

AIR 2.6, Flash Player 10.2

Logs out the current user.

Valeur renvoyée

com.adobe.gravity.utility.async:IToken — If the call is successful then an instance of IAuthResult would be passed to the result handler.

performSSO

()

méthode

public function performSSO(options:AuthOptions = null):com.adobe.gravity.utility.async:IToken

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

AIR 2.6, Flash Player 10.2

Initiates the call to perform Authentication for the current user.

Paramètres

options:AuthOptions (default = null) — (Optional) Specifies an AuthOption instance to control how the authentication is performed.

Valeur renvoyée

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.

Détails de l’événement

COMPLETE

Evénement

Type d’objet d’événement: com.adobe.livecycle.ria.security.api.AuthenticationEvent
propriété AuthenticationEvent.type = com.adobe.livecycle.ria.security.api.AuthenticationEvent.AUTHENTICATION_SUCCESS

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

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

Evénement

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

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

Evénement

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

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

Evénement

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Experience Services - Security 10

Versions du moteur d’exécution:

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.

Informations juridiques | Politique de confidentialité en ligne

ISecurityManager - AS3 ADEP Security

Classes x

currentUser

configure

getTicket

login

logout

performSSO

COMPLETE

CREDENTIAL_CHALLENGE

FAILED

LOGGED_OUT