Packagecom.esri.bao.tasks.authentication
Classpublic final class BAOnlineTokenProvider
InheritanceBAOnlineTokenProvider Inheritance TokenProvider

The BAOnlineTokenProvider class implements the token provider used with the tasks.



Public Properties
 PropertyDefined by
  authenticationTask : AbstractTask
[read-only] Authentication task associated with this token provider.
BAOnlineTokenProvider
 InheritedcurrentToken : String
Current authentication token.
TokenProvider
 Inheritedurl : String
Authentication service URL.
TokenProvider
Public Methods
 MethodDefined by
  
BAOnlineTokenProvider(authentication:IAuthentication, url:String = null)
Creates a new instance of the BAOnlineTokenProvider class.
BAOnlineTokenProvider
 Inherited
updateToken(responder:IResponder):void
Requests an authentication service for getting a new security token.
TokenProvider
Property detail
authenticationTaskproperty
authenticationTask:AbstractTask  [read-only]

Authentication task associated with this token provider.

Implementation
    public function get authenticationTask():AbstractTask
Constructor detail
BAOnlineTokenProvider()constructor
public function BAOnlineTokenProvider(authentication:IAuthentication, url:String = null)

Creates a new instance of the BAOnlineTokenProvider class.

The authentication object receives in the getUserCredentials request a userInfo object with the "url" property specifying the token service URL. This property should be passed to the output userCredentials object along with "username" and "password" properties.

The url parameter specifies the base URL to the Business Analyst Online authentication Web Service as follows:

https://{host}:{port}

The {host} and {port} parameters in this URL should be substituted with valid Business Analyst Online host name and port, respectively.

If the base URL is null or empty, the "https://baoapi.esri.com" value is assigned as the base URL.

Parameters
authentication:IAuthentication — An object used for getting user credentials.
 
url:String (default = null) — The base URL to the Business Analyst Online REST Authentication Service.