com.esri.gpt.framework.security.identity
Class SingleSignOnMechanism

java.lang.Object
  com.esri.gpt.framework.security.identity.SingleSignOnMechanism

public class SingleSignOnMechanism
extends Object

Provides support for a single sign on process.

There are 2 patterns for specifying the credential location:

credentialLocation="userPrincipal"

credentialLocation="header.variable"

"userPrincipal" is the typical case and indicates that the credential can be found within HttpServletRequest.getUserPrincipal().getName()

header.variable indicates that the credential can be found within the HTTP header.
Example: credentialLocation="header.html-wg-useruid" indicates that the credential can be found within an HTTP header variable named "html-wg-useruid" (ie. HttpServletRequest.getHeader("html-wg-useruid"))

Constructor Summary

SingleSignOnMechanism()
Default constructor.

Method Summary

String	determineUsername(HttpServletRequest request) Determines the user name associated with a single sign-on request.
boolean	getActive() Gets the flag indication whether or not single sign-on is active.
String	getAnonymousValue() Gets the credential value that indicates an anonymous user.
String	getCredentialLocation() Gets the location of the credential.
void	setActive(boolean active) Sets the flag indication whether or not single sign-on is active.
void	setAnonymousValue(String value) Sets the credential value that indicates an anonymous user.
void	setCredentialLocation(String location) Sets the location of the credential.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SingleSignOnMechanism

public SingleSignOnMechanism()

Default constructor.

Method Detail

getActive

public boolean getActive()

Gets the flag indication whether or not single sign-on is active.

Returns:

true if single sign-on is active.

setActive

public void setActive(boolean active)

Sets the flag indication whether or not single sign-on is active.

Parameters:

active - true if single sign-on is active.

getAnonymousValue

public String getAnonymousValue()

Gets the credential value that indicates an anonymous user.
For most mechanisms, an anonymous user is represented by a null value or empty string. For others, the specification is explicit, eg. "OblixAnonymous"

Returns:

the credential value indicating an anonymous user

setAnonymousValue

public void setAnonymousValue(String value)

Sets the credential value that indicates an anonymous user.
For most mechanisms, an anonymous user is represented by a null value or empty string. For others, the specification is explicit, eg. "OblixAnonymous"

Parameters:

value - the credential value indicating an anonymous user

getCredentialLocation

public String getCredentialLocation()

Gets the location of the credential.

Returns:

the credential location

setCredentialLocation

public void setCredentialLocation(String location)

Sets the location of the credential.

Parameters:

location - the credential location

determineUsername

public String determineUsername(HttpServletRequest request)

Determines the user name associated with a single sign-on request.

Returns:

the username (empty string if anonymous)

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string