Package	com.adobe.rtc.authentication
Class	public class AdobeHSAuthenticator
Inheritance	AdobeHSAuthenticator AbstractAuthenticator 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:

• The application is under development: Required parameters: userName and password. Developers may find it expedient to hard code their Adobe ID during development and testing so that their application will communicate directly with the service. In this case, pass the Adobe ID username, password, and the room's URL. It should be obvious that authentication details should never be hard coded anywhere, including deployed SWFs. See Example 1 below for a simple development-only use case.
• Users log in as a guest: Required parameter: userName. Users may only want to enter as a guest or the developer may want to limit room members to a guest role. In this case, only username is required, and that name is used only as a display name. For more information on managing guest users, see the autoPromote() and guestsHaveToKnock() in the RoomManager class.
• Users authenticate via external authentication: Required parameter: authenticationKey. In most production scenarios, developers will want automatically authenticate users on their organization's existing systems. Production LCCS applications are usually designed to rely on external authentication mechanisms so that their client users do not have to have an Adobe ID, so the developer can leverage existing infrastructure, and so they can take advantage of a host of other benefits as described in the LCCS Developer Guide. See Example 2 below.

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

com.adobe.rtc.session.IConnectSession
com.adobe.rtc.messaging.UserRoles
com.adobe.rtc.sharedManagers.descriptors.UserDescriptor
com.adobe.rtc.sharedManagers.RoomManager.autoPromote
com.adobe.rtc.sharedManagers.RoomManager.guestsHaveToKnock

---

protocol

property

requireRTMFP

property

AdobeHSAuthenticator

()

constructor

getAuthenticationRequestParameters

()

method

---

2008-2010 Adobe Systems Incorporated. All rights reserved.