| Package | com.adobe.rtc.authentication |
| Class | public class AbstractAuthenticator |
| Inheritance | AbstractAuthenticator  flash.events.EventDispatcher |
| Implements | mx.core.IMXMLObject |
| Subclasses | AdobeHSAuthenticator, LocalAuthenticator |
See also
| Property | Defined by | ||
|---|---|---|---|
| authenticationKey : String
For applications that leverage AFCS's external authentication capabilities,
authenticationKey is used to receive a unique, signed string created from
the developer's shared secret and the user's username, password, and role. | AbstractAuthenticator | ||
| authenticationURL : String
Allows a developer to specify the URL of a AFCS-compatible authentication service;
it is not needed for many applications.
| AbstractAuthenticator | ||
| isGuest : Boolean [read-only]
isGuest returns whether or not the supplied parameters
require that the user be admitted as a guest only. | AbstractAuthenticator | ||
password : Stringpassword is only required when Adobe IDs
are used; therefore, it is likely that only developers would need this parameter except
during development. | AbstractAuthenticator | ||
| userName : String
When
authenticationKey is not used,
userName is required upon room entry; when a someone enters as a guest, the name
becomes the user's display name. | AbstractAuthenticator | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched if user log in fails. | AbstractAuthenticator | |||
| Dispatched after user log in succeeds. | AbstractAuthenticator | |||
| authenticationKey | property |
public var authenticationKey:String
For applications that leverage AFCS's external authentication capabilities, authenticationKey is used to receive a unique, signed string created from
the developer's shared secret and the user's username, password, and role. The key enables users
to exit and return to an existing session without having to re-login. Once a user has logged in to a session,
the service returns a valid Adobe authenticationKey that
can be used in lieu of userName and
password upon user reentry.
Note that external authentication allow the developer to manage user credentials on their
private, existing infrastructure. End users do not need an Adobe ID, and Acrobat.com doesn't
need any authentication information other then the authenticationKey.
For details about external authentication, refer to the AFCS Developer Guide and the server scripts
the SDK's "extras" directory.
| authenticationURL | property |
public var authenticationURL:StringAllows a developer to specify the URL of a AFCS-compatible authentication service; it is not needed for many applications.
| isGuest | property |
isGuest:Boolean [read-only]
isGuest returns whether or not the supplied parameters
require that the user be admitted as a guest only. For example,
if no password is set, isGuest returns true.
public function get isGuest():Boolean
| password | property |
public var password:String
password is only required when Adobe IDs
are used; therefore, it is likely that only developers would need this parameter except
during development. If used, it is supplied in addition to
userName and permits admitting users as other than a guest.
Note that while it is possible for registered Adobe service users to use their Adobe ID,
applications will likely leverage AFCS's external authentication capabilities so that
authenticationKey would be used in lieu of a username and
password.
| userName | property |
public var userName:String
When authenticationKey is not used,
userName is required upon room entry; when a someone enters as a guest, the name
becomes the user's display name.
Two cases are supported:
UserDescriptor.displayName is set to the value in
userName.
password
is only provided when members login with Adobe IDs which is an uncommon case. See below.
| authenticationFailure | event |
| authenticationSuccess | event |
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/authentication/AbstractAuthenticator.html