Packagecom.adobe.rtc.authentication
Classpublic class AdobeHSAuthenticator
InheritanceAdobeHSAuthenticator Inheritance AbstractAuthenticator Inheritance flash.events.EventDispatcher

AdobeHSAuthenticator is used to log users into a LCCS hosted room with the requisite parameters for the given log in scenario. When you supply this component to an IConnectSession's authenticator property, the IConnectSession manages the rest. AdobeHSAuthenticator takes one of the following sets of input parameters depending on how the user is logging in. There are several possible scenarios:
Note: It's possible to develop offline without a connection to the LCCS service. Simply change rtc:AdobeHSAuthenticator to rtc:LocalAuthenticator and use any arbitrary username. Then start the SDK's LocalConnectionServer.air and your applications will automatically detect the local server. For details, refer to the LCCS Developer Guide or the LocalConnectionServer demo in the SDK's examples directory.

Example 1: Simple, development-only authentication
  <rtc:AdobeHSAuthenticator 
     // Deployed applications DO NOT hard code username and password here.
     userName="AdobeIDusername@example.com" 
     password="AdobeIDpassword" 
     id="auth"/> 
   <session:ConnectSessionContainer 
     roomURL="http://connect.acrobat.com/exampleAccount/exampleRoom" 
     authenticator="{auth}">
     <pods:WebCamera width="100%" height="100%"/>
  </session:ConnectSessionContainer>
Note: For more information about external authentication, refer to the LCCS Developer Guide and the scripts in the SDK's "extras/scripts" directory. Example 2 assumes that authenticationKey and roomURL are being passed to the SWF via flashvars.
Example 2: Production authentication method using external authentication
  <mx:Script>
    <![CDATA[
       [Bindable]
     private var roomURL:String;
     [Bindable]
      // Use external authentication to create a property to authenticationKey.
     private var authToken:String;
      
       private function init():void {
      roomURL = Application.application.parameters["roomURL"];
       // authToken is created by the developer's server from the developer's 
       // shared secret as well as the users's authentication information.
      authToken = Application.application.parameters["authToken"];    
      cSession.login(); 
      }
      ]]>
    </mx:Script> 
    // Pass the authToken to authenticationKey.
    <rtc:AdobeHSAuthenticator authenticationKey="{authToken}" id="auth"/>

See also



Public Properties
 PropertyDefined by
 InheritedauthenticationKey : String
For applications that leverage LCCS'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
 InheritedauthenticationURL : String
Allows a developer to specify the URL of a LCCS-compatible authentication service; it is not needed for many applications.
AbstractAuthenticator
 InheritedisGuest : Boolean
isGuest returns whether or not the supplied parameters require that the user be admitted as a guest only.
AbstractAuthenticator
 Inheritedpassword : String
password is only required when Adobe IDs are used; therefore, it is likely that only developers would need this parameter except during development.
AbstractAuthenticator
  protocol : String
[write-only] [Deprecated 4/15/10] Set the protocol, values are RTMPS and RTMFP.
AdobeHSAuthenticator
  requireRTMFP : Boolean
[write-only] Determines whether the user must connect via RTMFP.
AdobeHSAuthenticator
 InheriteduserName : 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
Public Methods
 MethodDefined by
  
AdobeHSAuthenticator
  
AdobeHSAuthenticator
Events
 EventSummaryDefined by
 Inherited Dispatched if user log in fails.AbstractAuthenticator
 Inherited Dispatched after user log in succeeds.AbstractAuthenticator
Property detail
protocolproperty
protocol:String  [write-only]

[Deprecated 4/15/10] Set the protocol, values are RTMPS and RTMFP. This property is no longer required - all applications built with the player 10 (and above) swcs will automatically attempt to connect with RTMFP, and, failing that, use RTMPS (unless requireRTMFP is set to true).

Implementation
    public function set protocol(value:String):void
requireRTMFPproperty 
requireRTMFP:Boolean  [write-only]

Determines whether the user must connect via RTMFP. Setting this to true means that any client who cannot connect via RTMFP will not fall back to RTMPs, and instead throw a SessionError (or dispatch a SessionEvent, if a listener is waiting).

Implementation
    public function set requireRTMFP(value:Boolean):void
Constructor detail
AdobeHSAuthenticator()constructor
public function AdobeHSAuthenticator()
Method detail
getAuthenticationRequestParameters()method
public override function getAuthenticationRequestParameters():String

Returns
String




 

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/AdobeHSAuthenticator.html