com.xmlmind.netutil

Class SimpleAuthenticatorModule

java.lang.Object

com.xmlmind.netutil.SimpleAuthenticatorModule

All Implemented Interfaces:

AuthenticatorModule

public class SimpleAuthenticatorModule
extends Object
implements AuthenticatorModule

A simple, non-interactive, authenticator module.

Field Summary

Fields

Modifier and Type	Field and Description
String	host The hostname or address of the host for which credentials are to be returned.
char[]	password The password of the authenticated user.
int	port The port of the service for which credentials are to be returned.
String	prompt The prompt (AKA realm) used by the service for which credentials are to be returned.
String	scheme The authentication scheme (BASIC, DIGEST, etc) used by the service for which credentials are to be returned.
String	username The username of the authenticated user.

Constructor Summary

Constructors

Constructor and Description
SimpleAuthenticatorModule(String info) Constructs an authenticator module initialized using specified info.
SimpleAuthenticatorModule(String host, int port, String prompt, String scheme, String username, char[] password) Constructs an authenticator module initialized using specified fields.

Method Summary

Modifier and Type	Method and Description
void	clearCredentials() If usernames/passwords are cached, invoking this method definitely clears such cached information.
static String	encodeCredentials(String host, int portNumber, String prompt, String scheme, String username, char[] password) Returns a string for use by the -auth command-line option.
ModularAuthenticator	getModularAuthenticator() Returns the modular authenticator to which this module belongs.
PasswordAuthentication	getPasswordAuthentication() Returns the PasswordAuthentication found for the context which can be queried using the ModularAuthenticator interface.
static void	main(String[] args) Command-line utility which may be used to encode authentication credentials in the format expected by SimpleAuthenticatorModule(String).
void	setModularAuthenticator(ModularAuthenticator authenticator) Invoked by the modular authenticator to specify to its module to which ``parent'' it belongs.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

host

public final String host

The hostname or address of the host for which credentials are to be returned. null matches any host.

port

public final int port

The port of the service for which credentials are to be returned. A negative or null number matches any port.

prompt

public final String prompt

The prompt (AKA realm) used by the service for which credentials are to be returned. null matches any prompt.

scheme

public final String scheme

The authentication scheme (BASIC, DIGEST, etc) used by the service for which credentials are to be returned. null matches any scheme.

username

public final String username

The username of the authenticated user.

password

public final char[] password

The password of the authenticated user.

Constructor Detail

SimpleAuthenticatorModule

public SimpleAuthenticatorModule(String info)
                          throws IllegalArgumentException

Constructs an authenticator module initialized using specified info.

Parameters:

info - consists in fields host, port, prompt, scheme, username and password joined using the newline char ('\n'), then converted to UTF-8 bytes, then encoded in base 64. All fields except username and password can be left empty.

Throws:

IllegalArgumentException - if specified info cannot be successfully decoded and then parsed.

See Also:

SimpleAuthenticatorModule(String, int, String, String, String, char[]), encodeCredentials(java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, char[])

SimpleAuthenticatorModule

public SimpleAuthenticatorModule(String host,
                                 int port,
                                 String prompt,
                                 String scheme,
                                 String username,
                                 char[] password)

Constructs an authenticator module initialized using specified fields.

Parameters:

host - The hostname or address of the host for which credentials are to be returned. null matches any host.

port - The port of the service for which credentials are to be returned. A negative or null number matches any port.

prompt - The prompt (AKA realm) used by the service for which credentials are to be returned. null matches any prompt.

scheme - The authentication scheme (BASIC, DIGEST, etc) used by the service for which credentials are to be returned. null matches any scheme.

username - The username of the authenticated user.

password - The password of the authenticated user.

See Also:

SimpleAuthenticatorModule(String)

Method Detail

setModularAuthenticator

public void setModularAuthenticator(ModularAuthenticator authenticator)

Description copied from interface: AuthenticatorModule

Invoked by the modular authenticator to specify to its module to which ``parent'' it belongs.

Specified by:

setModularAuthenticator in interface AuthenticatorModule

getModularAuthenticator

public ModularAuthenticator getModularAuthenticator()

Description copied from interface: AuthenticatorModule

Returns the modular authenticator to which this module belongs.

Specified by:

getModularAuthenticator in interface AuthenticatorModule

clearCredentials

public void clearCredentials()

Description copied from interface: AuthenticatorModule

If usernames/passwords are cached, invoking this method definitely clears such cached information.

Specified by:

clearCredentials in interface AuthenticatorModule

getPasswordAuthentication

public PasswordAuthentication getPasswordAuthentication()

Description copied from interface: AuthenticatorModule

Returns the PasswordAuthentication found for the context which can be queried using the ModularAuthenticator interface. Returns null if, given this context, this module cannot determine the PasswordAuthentication object.

Specified by:

getPasswordAuthentication in interface AuthenticatorModule

toString

public String toString()

Overrides:

toString in class Object

encodeCredentials

public static String encodeCredentials(String host,
                                       int portNumber,
                                       String prompt,
                                       String scheme,
                                       String username,
                                       char[] password)

Returns a string for use by the -auth command-line option.

Parameters:

host - The hostname or address of the host for which credentials are to be returned. null matches any host.

portNumber - The port of the service for which credentials are to be returned. A negative or null number matches any port.

prompt - The prompt (AKA realm) used by the service for which credentials are to be returned. null matches any prompt.

scheme - The authentication scheme (BASIC, DIGEST, etc) used by the service for which credentials are to be returned. null matches any scheme.

username - The username of the authenticated user.

password - The password of the authenticated user.

Returns:

a string encoding authentication credentials in the format expected by SimpleAuthenticatorModule(String).

main

public static void main(String[] args)
                 throws Exception

Command-line utility which may be used to encode authentication credentials in the format expected by SimpleAuthenticatorModule(String).

Throws:

Exception

See Also:

encodeCredentials(java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, char[])