org.das2.util

Class CredentialsManager

java.lang.Object

org.das2.util.CredentialsManager

public class CredentialsManager
extends java.lang.Object

Provides per-resource login credentials This class maintains a map of login credentials by resource ID. The resource ID's themselves are just strings. The only expectation on resource ID strings is that they should be suitable for use as the Keys to a hash map. Otherwise no formation rules are assumed nor expected. User names and passwords for multiple web-sites, ftp sites, etc. are maintained by a single instance of this class. Call: CredentialsManager.getManager() to get a reference to that single instance. In a graphical environment this class handles presenting dialogs to the user to gather logon credentials. In a shell environment it will interact with the TTY to get user information. An example of using this class to handle Das 2.1 server authentication which html location information formatting follows: CredentialsManage cm = CrentialsManager.getMannager(); String sLocId = "planet.physics.uiowa.edu/das/das2Server|voyager1/pwi/SpecAnalyzer-4s-Efield"; if(!cm.hasCredentials(sLocId)){ DasServer svr = DasServer.create(sDsdf); String sDesc = String.Format("

%s

Server: %s

DataSource: %s

", DasServer.getName(), "planet.physics.uiowa.edu", "voyager1 > pwi > SpecAnalyzer-4s-Efield"); cm.setDescription(sLocId, sDesc, DasServer.getLogo()); } String sHash = getHttpBasicHash(sLocId) Two previous classes, org.das2.util.filesystem.KeyChain (autoplot) and org.das2.client.Authenticator have approached this problem as well. However both of those classes make assumptions that are not valid in general. The first assumes that the caller somehow knows the username. The second assumes that you are talking to a first generation Das 2.1 server. Details of server communication are beyond the scope of this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CredentialsManager.Location

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CredentialsManager(java.lang.String sName)

Method Summary

Modifier and Type	Method and Description
protected boolean	getCredentialsCmdLine(CredentialsManager.Location loc) get the credentials from the command line.
protected boolean	getCredentialsGUI(CredentialsManager.Location loc) Gather User Credentials
static java.io.File	getDas2UserDirectory() returns the location of the local directory sandbox.
java.lang.String	getHttpBasicHash(java.lang.String sLocationId) Get credentials in the form of a hashed HTTP Basic authentication string If there are no credentials stored for the given location id, this function may trigger interaction with the user, such as presenting modal dialogs, or changing the TTY to non-echo.
java.lang.String	getHttpBasicHashRaw(java.lang.String sLocationId) Get credentials in the form of a hashed HTTP Basic authentication string.
static CredentialsManager	getMannager() Get a reference to the authentication manager.
static CredentialsManager	getMannager(java.lang.String sWhich) Get an authentication manager associated with an associated tracking string.
static java.lang.String	getProperty(java.lang.String name, java.lang.String deft) support restricted security environment by checking permissions before checking property.
boolean	hasCredentials(java.lang.String sLocationId) Determine if there are any stored credentials for this location If either a username or a password have been provided for the location then it is considered to have credentials
boolean	hasDescription(java.lang.String sLocationId) Determine if a given location has been described Gathering descriptive information about a remote location may trigger communication with a remote site.
boolean	hasIcon(java.lang.String sLocationId) Determine is a site image has been set for a location ID.
void	invalidate(java.lang.String sLocationId) Let the credentials manager know that stored credentials for a location are invalid
void	setDescription(java.lang.String sLocationId, java.lang.String sDescription) Provide a description of a location for use in authentication dialogs.
void	setDescription(java.lang.String sLocationId, java.lang.String sDescription, javax.swing.ImageIcon icon) Provide a description of a location with an Image Icon Use this function to tie a string description and an Icon to a location.
void	setHttpBasicHashRaw(java.lang.String sLocationId, java.lang.String userInfo) Allow scripts to set username and password.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialsManager

protected CredentialsManager(java.lang.String sName)

Method Detail

getMannager

public static CredentialsManager getMannager()

Get a reference to the authentication manager. Typically this is the function you want to use to get started.

getMannager

public static CredentialsManager getMannager(java.lang.String sWhich)

Get an authentication manager associated with an associated tracking string. This is probably not the function you are looking for. It only exists for odd cases where two different credential managers are active in a single application at the same time.

Parameters:

sWhich - - A string used to differentiate this credentials manager from the default instance.

setDescription

public void setDescription(java.lang.String sLocationId,
                           java.lang.String sDescription)

Provide a description of a location for use in authentication dialogs. Use this function to tie a string description to a location id. This description will be used when interacting with the user. If no description is present, then just the location ID itself will be used to identify the site to the end user. Usually location strings aren't that easy to read so use of this function or the version with an icon argument is recommended, though not required.

Parameters:

sLocationId - The location to describe, can not be null.

sDescription - A string to present to a user when prompting for a credentials for this location, may be a basic HTML string.

setDescription

public void setDescription(java.lang.String sLocationId,
                           java.lang.String sDescription,
                           javax.swing.ImageIcon icon)

Provide a description of a location with an Image Icon Use this function to tie a string description and an Icon to a location.

Parameters:

sLocationId - The location to describe, can not be null.

sDescription - The description, may be a simply formatted HTML string.

icon - An icon to display for the server.

hasCredentials

public boolean hasCredentials(java.lang.String sLocationId)

Determine if there are any stored credentials for this location If either a username or a password have been provided for the location then it is considered to have credentials

Parameters:

sLocationId - The location to describe, can not be null.

Returns:

true if there are stored credentials, false otherwise

setHttpBasicHashRaw

public void setHttpBasicHashRaw(java.lang.String sLocationId,
                                java.lang.String userInfo)

Allow scripts to set username and password.

Parameters:

sLocationId - the location/realm, like "http://jupiter.physics.uiowa.edu/das/server|Juno Magnetospheric Working Group"

userInfo - the user pass in string like "usern:passw"

hasDescription

public boolean hasDescription(java.lang.String sLocationId)

Determine if a given location has been described Gathering descriptive information about a remote location may trigger communication with a remote site. Use this function to see if such communication is needed.

Parameters:

sLocationId - The location in question

Returns:

true if the location has been described, false otherwise

hasIcon

public boolean hasIcon(java.lang.String sLocationId)

Determine is a site image has been set for a location ID. This function is provided because retrieving the logo for a site may trigger remote host communication. Use this function to see if such communication is needed.

Parameters:

sLocationId - the location in question

Returns:

true if the location has as attached icon logo

getHttpBasicHash

public java.lang.String getHttpBasicHash(java.lang.String sLocationId)

Get credentials in the form of a hashed HTTP Basic authentication string If there are no credentials stored for the given location id, this function may trigger interaction with the user, such as presenting modal dialogs, or changing the TTY to non-echo.

Parameters:

sLocationId - A unique string identifying a location. There are no formation rules on the string, but convenience functions are provided if a uniform naming convention is desired.

Returns:

The string USERNAME + ":" + PASSWORD that is then run through a base64 encoding. If no credentials are available for the given location ID and none can be gathered from the user (possibly due to the java.awt.headless being set or the user pressing cancel), null is returned.

See Also:

getHttpBasicHashRaw(java.lang.String)

getHttpBasicHashRaw

public java.lang.String getHttpBasicHashRaw(java.lang.String sLocationId)

Get credentials in the form of a hashed HTTP Basic authentication string. If there are no credentials stored for the given location id, this function may trigger interaction with the user, such as presenting modal dialogs, or changing the TTY to non-echo.

Parameters:

sLocationId - A unique string identifying a location. There are no formation rules on the string, but convenience functions are provided if a uniform naming convention is desired.

Returns:

The string USERNAME + ":" + PASSWORD. If no credentials are available for the given location ID and none can be gathered from the user (possibly due to the java.awt.headless being set or the user pressing cancel), null is returned.

See Also:

getHttpBasicHash(java.lang.String)

invalidate

public void invalidate(java.lang.String sLocationId)

Let the credentials manager know that stored credentials for a location are invalid

Parameters:

sLocationId -

getProperty

public static java.lang.String getProperty(java.lang.String name,
                                           java.lang.String deft)

support restricted security environment by checking permissions before checking property.

Parameters:

name -

deft -

Returns:

See Also:

!

getDas2UserDirectory

public static java.io.File getDas2UserDirectory()

returns the location of the local directory sandbox. For example, The web filesystem object downloads temporary files to here, logging properties file, etc. Assume that this File is local, so I/O is quick, and that the process has write access to this area. For definition, assume that at least 1Gb of storage is available as well.

Returns:

the directory.

See Also:

!

getCredentialsGUI

protected boolean getCredentialsGUI(CredentialsManager.Location loc)

Gather User Credentials

Parameters:

loc - The Location in question

Returns:

True if user hit OK, False if user canceled the operation

getCredentialsCmdLine

protected boolean getCredentialsCmdLine(CredentialsManager.Location loc)

get the credentials from the command line.

Parameters:

loc -

Returns: