SecurityManager

Package	com.adobe.livecycle.ria.security.service
Class	public class SecurityManager
Inheritance	SecurityManager EventDispatcher Object
Implements	ISecurityManager

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 SecurityManager class provides methods to perform user authentication and also provides access to current user instance.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		channelSet : ChannelSet [write-only] The channelset to use to communicate with the Experience Server.	SecurityManager
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentUser : IUser [read-only] Current logged in user instance.	SecurityManager

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SecurityManager() Constructor.	SecurityManager
		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.	EventDispatcher
		configure(config:SecurityConfig):void Configures the ISecurityManager instance with the provided configuration information.	SecurityManager
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getInstance(config:SecurityConfig = null):SecurityManager [static] Specifies a factory method to create an instance of ISecurityManager object.	SecurityManager
		getTicket():com.adobe.gravity.utility.async:IToken Returns a ticket for the current user.	SecurityManager
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		login(username:String, password:String, options:AuthOptions = null):com.adobe.gravity.utility.async:IToken Perform authentication with the provided username and password.	SecurityManager
		logout():com.adobe.gravity.utility.async:IToken Logs out the current user.	SecurityManager
		performSSO(options:AuthOptions = null):com.adobe.gravity.utility.async:IToken Initiates the call to perform Authentication for the current user.	SecurityManager
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

	Constant		Defined By
		SEC_PREFIX : String = "com.adobe.livecycle.ria.security." [static] A special value that indicates that attributes which begin with this constant are not be sent to server	SecurityManager

Property Detail

channelSet

property

channelSet:ChannelSet [write-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

The channelset to use to communicate with the Experience Server.

Implementation
public function set channelSet(value:ChannelSet):void

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.

Implementation
public function get currentUser():IUser

Constructor Detail

()

Constructor

public function 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

Constructor.

Method Detail

configure

()

method

public function configure(config: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

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

getInstance

()

method

public static function getInstance(config:SecurityConfig = null):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

Specifies a factory method to create an instance of ISecurityManager object.

Parameters

config:SecurityConfig (default = null) — Specifies the security configuration obtained through ConfigUtil object. This is required for initial construction. Subsequent calls can omit the config value.

Returns

SecurityManager — A SecurityManager instance constructed from the given configuration.

Example ( How to use this example )

To create a SecurityManager instance:

Copy

         import com.adobe.utility.logging.DefaultLogger;
         import com.adobe.utility.logging.Logger;
         import com.adobe.utility.logging.logging;
     
          //Initialize the logger
          Logger.logging::logger = new DefaultLogger();
     
         var securityConfig:SecurityConfig = ConfigUtil.getDefaultRIASecurityConfig();
         var securityManager:SecurityManager = SecurityManager.getInstance(securityConfig);

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.

Returns

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

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`) — (Optional)Specifies attributes to control how authentication is performed.

Returns

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

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.

Returns

com.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) — (Optional) Specifies an AuthOption instance to control how the authentication is performed.

Returns

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.

Constant Detail

SEC_PREFIX

Constant

public static const SEC_PREFIX:String = "com.adobe.livecycle.ria.security."

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Security 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

A special value that indicates that attributes which begin with this constant are not be sent to server

SecurityManager - AS3 ADEP Security

Classes x

channelSet

currentUser