Package | com.esri.bao.tasks.authentication |
Class | public class BAOnlineTokenProvider |
Inheritance | BAOnlineTokenProvider TokenProvider Object |
Property | Defined By | ||
---|---|---|---|
authenticationTask : AbstractTask [override] [read-only]
Authentication task associated with this token provider. | BAOnlineTokenProvider | ||
currentToken : String
Current authentication token. | TokenProvider | ||
proxyURL : String
The URL to proxy the request through. | TokenProvider | ||
url : String
Authentication service URL. | TokenProvider |
Method | Defined By | ||
---|---|---|---|
BAOnlineTokenProvider(authentication:IAuthentication = null, url:String = null)
Creates a new instance of the BAOnlineTokenProvider class. | BAOnlineTokenProvider | ||
updateToken(responder:IResponder):void
Requests an authentication service for getting a new security token. | TokenProvider |
authenticationTask | property |
authenticationTask:AbstractTask
[read-only] [override] Authentication task associated with this token provider.
public function get authenticationTask():AbstractTask
BAOnlineTokenProvider | () | Constructor |
public function BAOnlineTokenProvider(authentication:IAuthentication = null, 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 Community Analyst
authentication Web Service as follows:
https://{host}:{port}
The {host}
and {port}
parameters in this URL should be substituted with
valid Community Analyst 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.
Parametersauthentication:IAuthentication (default = null ) — An object used for getting user credentials.
| |
url:String (default = null ) — The base URL to the Community Analyst REST Authentication Service.
|