de.unkrig.commons.lang.crypto

Interface PasswordAuthenticationStore

All Superinterfaces:

Destroyable

public interface PasswordAuthenticationStore
extends Destroyable

Stores username/password pairs, persistently or not. Suitable for being used with Authenticator and PasswordAuthentication.

Field Summary

Fields

Modifier and Type	Field and Description
static PasswordAuthenticationStore	NOP A password store that discards all data stored in it.

Method Summary

Modifier and Type	Method and Description
char[]	getPassword(String key, String userName)
String	getUserName(String key)
void	put(String key, String userName) Updates the userName and removes the password for the given key.
void	put(String key, String userName, char[] password) Updates the userName and the password for the given key.
void	remove(String key) Removes both the user name and the password for the given key.

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Field Detail

NOP

static final PasswordAuthenticationStore NOP

A password store that discards all data stored in it.

Method Detail

getUserName

@Nullable
String getUserName(String key)

Returns:

The least recently put userName for the key, or null if a user name for the given key is not in this store

getPassword

@Nullable
char[] getPassword(String key,
                              String userName)

Parameters:

userName - Must equal the userName provided with put(String, String, char[])

Returns:

The least recently put password for the key, or null if a password for the given key is not in this store; the caller is responsible for clearing the returned char[]

put

void put(String key,
         String userName)
  throws IOException

Updates the userName and removes the password for the given key. Depending on whether this store is persistent or not, the new values will not or will be forgotten when the JVM exits.

Throws:

IOException

put

void put(String key,
         String userName,
         char[] password)
  throws IOException

Updates the userName and the password for the given key. Depending on whether this store is persistent or not, the new values will not or will be forgotten when the JVM exits.

This method clears the password character array before it returns.

Throws:

IOException

remove

void remove(String key)
     throws IOException

Removes both the user name and the password for the given key. Depending on whether this store is persistent or not, the removal will not or will be forgotten when the JVM exits.

Throws:

IOException