edu.ucdavis.cstars.client

Class IdentityManagerBase

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.IdentityManagerBase

Direct Known Subclasses:

IdentityManager

public class IdentityManagerBase
extends com.google.gwt.core.client.JavaScriptObject

This class provides the framework and helper methods required to implement a solution for managing user credentials for the following resources: ArcGIS Server resources secured using token-based authentication. Note that only ArcGIS Server versions 10 SP 1 and greater are supported. Secured ArcGIS.com resources (i.e. web maps). This class is not typically used by itself and does not include a user interface to obtain user input. The esri.IdentityManager class provides a complete out-of-the-box implementation.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdentityManagerBase.RedirectionInfo

Method Summary

Methods

Modifier and Type	Method and Description
Credential	findCredential(java.lang.String url) Returns the credential for the resource identified by the specified url.
Credential	findCredential(java.lang.String url, java.lang.String userId) Returns the credential for the resource identified by the specified url.
ServerInfo	findServerInfo(java.lang.String url) Returns information about the server that is hosting the specified url.
Deferred	generateToken(ServerInfo serverInfo, com.google.gwt.core.client.JavaScriptObject userInfo) Returns an object containing a token and its expiration time.
Deferred	getCredential(java.lang.String url) Returns a Credential object that can be used to access the secured resource identified by the input url.
Deferred	getCredential(java.lang.String url, boolean retry) Returns a Credential object that can be used to access the secured resource identified by the input url.
int	getTokenValidity() The suggested lifetime of the token in minutes.
boolean	isBusy() Returns true if the identity manager is busy accepting user input, i.e.
void	registerServers(ServerInfo serverInfos) Register secure servers and the token endpoints.
void	setRedirectionHandler(RedirectionHandler handler) When accessing secure resources from ArcGIS.com or one of its sub-domains the IdentityManager redirects the user to the ArcGIS.com sign-in page.
Deferred	signIn(java.lang.String url, ServerInfo serverInfo) Sub-classes must implement this method to create and manager the user interface that is used to obtain a username and password from the end-user.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTokenValidity

public final int getTokenValidity()

The suggested lifetime of the token in minutes. Default is 60 minutes.

Returns:

int

findCredential

public final Credential findCredential(java.lang.String url,
                        java.lang.String userId)

Returns the credential for the resource identified by the specified url. Optionally you can provide a userId to find credentials for a specific user.

Parameters:

url - - The url to a server.

userId - - The userId for which you want to obtain credentials.

Returns:

Credential

findCredential

public final Credential findCredential(java.lang.String url)

Returns the credential for the resource identified by the specified url. Optionally you can provide a userId to find credentials for a specific user.

Parameters:

url - - The url to a server.

Returns:

Credential

findServerInfo

public final ServerInfo findServerInfo(java.lang.String url)

Returns information about the server that is hosting the specified url.

Parameters:

url - - The url to a server.

Returns:

ServerInfo

generateToken

public final Deferred generateToken(ServerInfo serverInfo,
                     com.google.gwt.core.client.JavaScriptObject userInfo)

Returns an object containing a token and its expiration time. You need to provide the ServerInfo object that contains token service URL and a user info object containing username and password. This is a helper method typically called by sub-classes to generate tokens.

Parameters:

serverInfo - - A ServerInfo object that contains a token service URL.

userInfo - - A user info object containing a user name and password.

Returns:

Deferred

getCredential

public final Deferred getCredential(java.lang.String url,
                     boolean retry)

Returns a Credential object that can be used to access the secured resource identified by the input url. If required the user will be challenged for a username and password which is used to generate a token. Note: The IdentityManager sets up a timer to update the Credential object with a new token prior to the expiration time. This method is typically called by esri.request when a request fails due to an "invalid credentials" error.

Parameters:

url - - The url for the secure resource.

retry - - Determines if the method should make additional attempts to get the credentials after a failure.

Returns:

Deferred

getCredential

public final Deferred getCredential(java.lang.String url)

Returns a Credential object that can be used to access the secured resource identified by the input url. If required the user will be challenged for a username and password which is used to generate a token. Note: The IdentityManager sets up a timer to update the Credential object with a new token prior to the expiration time. This method is typically called by esri.request when a request fails due to an "invalid credentials" error.

Parameters:

url - - The url for the secure resource.

Returns:

Deferred

isBusy

public final boolean isBusy()

Returns true if the identity manager is busy accepting user input, i.e. the user has invoked signIn and is waiting for a response.

Returns:

boolean

registerServers

public final void registerServers(ServerInfo serverInfos)

Register secure servers and the token endpoints.

Parameters:

serverInfos - - A ServerInfos object that defines the secure service and token endpoint. The Identity Manager makes its best guess to determine the locatation of the secure server and token endpoint so in most cases calling registerServers is not necessary. However if the location of your server or token endpoint is non-standard use this method to register the location.

setRedirectionHandler

public final void setRedirectionHandler(RedirectionHandler handler)

When accessing secure resources from ArcGIS.com or one of its sub-domains the IdentityManager redirects the user to the ArcGIS.com sign-in page. Once the user successfully logs-in they are redirected back to the application. Use this method if the application needs to execute custom logic before the page is redirected by creating a custom redirection handler. The IdentityManager calls the custom handler function with an object containing the redirection properties. (As of v2.6)

Parameters:

handler - - handler to fire on redirection

signIn

public final Deferred signIn(java.lang.String url,
              ServerInfo serverInfo)

Sub-classes must implement this method to create and manager the user interface that is used to obtain a username and password from the end-user. It should perform the following tasks: Challenge the user for a username and password. Generate a token and return it to the caller via Deferred object.

Parameters:

url - - Url for the secure resource.

serverInfo - - A ServerInfo object that contains the token service url.

Returns:

Deferred