Package org.marketcetera.util.auth

Multi-context gathering of credentials for authentication.

See:
Description

Interface Summary

Messages	The internationalization constants used by this package.
OptionsProvider	A provider of extra command line options.

Class Summary

AuthenticationSystem	An authentication system.
CliContext	A context for command-line setters (CliSetter).
CliSetter<T extends Holder<?>>	A setter that obtains holder data via a command-line.
CliSetterCharArray	A setter for a character array holder that obtains the data via a command-line.
CliSetterString	A setter for a string holder that obtains the data via a command-line.
ConsoleContext	A context for console setters (ConsoleSetter).
ConsoleSetter<T extends Holder<?>>	A setter that obtains holder data via the console.
ConsoleSetterCharArray	A setter for a character array holder that obtains the data via the console.
ConsoleSetterString	A setter for a string holder that obtains the data via the console.
Context<T extends Setter<?>>	A context, comprising a group of setters.
Holder<T>	A holder of a piece of data.
HolderCharArray	A holder of a character array.
Setter<T extends Holder<?>>	A wrapper around a data holder that sets the holder's data.
SpringContext	A context for Spring setters (SpringSetter).
SpringSetter<T extends Holder<?>>	A setter that obtains holder data via Spring configuration properties.
SpringSetterCharArray	A setter for a character array holder that obtains the data via Spring configuration properties.
SpringSetterString	A setter for a string holder that obtains the data via Spring configuration properties.
StandardAuthentication	A standard authentication system.

Package org.marketcetera.util.auth Description

Multi-context gathering of credentials for authentication.

A standard step in authentication is the gathering of user credentials. Credentials typically comprise a username and a password, but they can also include an authentication domain, certificates, or other information specific to the authentication algorithm. This package has no connection to authentication algorithms or even interfaces (such as JAAS); it concerns itself only with gathering credentials.

Credentials may come from multiples sources. For example a GUI application may look for credentials in the following places:

• Configuration files.
• Command-line options, which can override the configuration files.
• A login dialog box, displayed only if credentials were not specified using either of the above methods.

Each of the methods above seeks to gather credentials from a specific context (configuration file(s), command-line, dialog box). In this example, the command-line context is an override context, meaning that it always attempts to gather credentials and, if it does so successfully, the values it gathers override those provided by earlier contexts. The login dialog is a non-override context because it will only pop up and attempt to gather credentials if they have not been gathered yet.

For the benefit of user convenience and uniformity, StandardAuthentication provides a standard authentication system, aimed specifically at console applications. For developers who wish to create non-standard authentication systems, AuthenticationSystem is a generic registry of contexts. Contexts extend Context, and several subclasses are provided, such as command-line or Spring configuration. The package design can accomodate any number/type of credentials sought (not just a username and password), with some contexts capable of providing only some of them. A creative developer may also repurpose this package to retrieve any combination of application properties from multiple contexts, not just authentication credentials.

All provided contexts treat null and "" (empty string) inputs as no-ops, i.e. gathered credentials that are null or "" are treated as if no credentials were supplied (and hence do not override values set by earlier contexts).