com.adobe.rtc.authentication.LocalAuthenticator

Package	com.adobe.rtc.authentication
Class	public class LocalAuthenticator
Inheritance	LocalAuthenticator AbstractAuthenticator flash.events.EventDispatcher

LocalAuthenticator is a development-only authenticator for use with the Local Server tool which enables offline development of LCCS applications. With the exception of streaming components (i.e. Audio and Webcam components), most LCCS components work with the Local Server.

This tool has the following features:

Applications connect automatically to the running server. No configuration is required.
All non-streaming components are supported. (excludes Webcam and Audio streaming components).
The room URL is not used and does not need to be changed.
Because username and password is not used for authentication, any valid string may be used.
The server stores no data, so stopping the server cleans the application of data.
All users are treated as hosts.
Users can change the roles of others at runtime.

Starting the local server

To use this class replace AdobeHSAuthenticator with LocalAuthenticator. Start the local server by opening the LCCS SDK Navigator, selecting the tools tab, and choosing Local For a working example, see LocalConnection in the SDK's "sampleApps" directory.

Using LocalAuthenticator to develop applications with the local server tool

  <rtc:LocalAuthenticator id="auth" userName="AnyArbitraryName"  />
    <rtc:ConnectSessionContainer id="cSession" authenticator="{auth}" width="100%" height="100%" >
    <mx:VBox width="100%" height="100%" >
     <rtc:Note width="100%" height="100%" />
     <rtc:SimpleChat width="100%" height="100%" />
    </mx:VBox>
  </rtc:ConnectSessionContainer>

See also

com.adobe.rtc.session.IConnectSession

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		authenticationKey : 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
		authenticationURL : String Allows a developer to specify the URL of a LCCS-compatible authentication service; it is not needed for many applications.	AbstractAuthenticator
		isGuest : Boolean `isGuest` returns whether or not the supplied parameters require that the user be admitted as a guest only.	AbstractAuthenticator
		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.	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

	Method	Defined by
		LocalAuthenticator()	LocalAuthenticator
		getAuthenticationRequestParameters():String	AbstractAuthenticator

	Event	Summary	Defined by
		authenticationFailure	Dispatched if user log in fails.	AbstractAuthenticator
		authenticationSuccess	Dispatched after user log in succeeds.	AbstractAuthenticator

Constructor detail

LocalAuthenticator

()

constructor

public function LocalAuthenticator()

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/authentication/LocalAuthenticator.html

LCCS API Reference Player 10.1	All Packages \| All Classes \| Index \| Frames No Frames
Class LocalAuthenticator	Properties \| Methods \| Events