Package org.apache.archiva.redback.keys.memory

Class MemoryKeyManager

java.lang.Object

org.apache.archiva.redback.keys.AbstractKeyManager

org.apache.archiva.redback.keys.memory.MemoryKeyManager

All Implemented Interfaces:

KeyManager

@Service("keyManager#memory")
public class MemoryKeyManager
extends AbstractKeyManager

KeyManager backed by an in-memory only store.

Author:

Joakim Erdfelt

Field Summary

Fields inherited from class org.apache.archiva.redback.keys.AbstractKeyManager

log

Constructor Summary

Constructors

Constructor	Description
MemoryKeyManager()

Method Summary

Modifier and Type	Method	Description
AuthenticationKey	addKey(AuthenticationKey key)
AuthenticationKey	createKey(String principal, String purpose, int expirationMinutes)	Create a key (and save it to the store) for the specified principal.
void	deleteKey(String key)	Delete a key from the underlying store.
void	deleteKey(AuthenticationKey authkey)	Delete a key from the underlying store.
void	eraseDatabase()
AuthenticationKey	findKey(String key)	Attempt to find a specific key in the store.
List<AuthenticationKey>	getAllKeys()
String	getId()	String identifying the key manager implementation.

Methods inherited from class org.apache.archiva.redback.keys.AbstractKeyManager

assertNotExpired, generateUUID, getNowGMT, isRandomMode, removeExpiredKeys, setRandomMode

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryKeyManager

public MemoryKeyManager()

Method Detail

createKey

public AuthenticationKey createKey(String principal,
                                   String purpose,
                                   int expirationMinutes)
                            throws KeyManagerException

Description copied from interface: KeyManager

Create a key (and save it to the store) for the specified principal.

Parameters:

principal - the principal to generate the key for.

purpose - the purpose of the key. (Example: "selfservice password reset", "new user validation", "remember me") This is a purely informational field .

expirationMinutes - the amount in minutes until this key expires. (-1 means no expiration)

Returns:

the key created

Throws:

KeyManagerException - if there is a fundamental problem with the KeyManager implementation.

findKey

public AuthenticationKey findKey(String key)
                          throws KeyNotFoundException,
                                 KeyManagerException

Description copied from interface: KeyManager

Attempt to find a specific key in the store. NOTE: Implementations of this interface should never return an expired key.

Parameters:

key - the key to find.

Returns:

the actual key found.

Throws:

KeyNotFoundException - when the requested, unexpired, key cannot be found.

KeyManagerException - when there is a fundamental problem with the KeyManager implementation.

deleteKey

public void deleteKey(AuthenticationKey authkey)
               throws KeyManagerException

Description copied from interface: KeyManager

Delete a key from the underlying store.

Parameters:

authkey - the key to delete.

Throws:

KeyManagerException

deleteKey

public void deleteKey(String key)
               throws KeyManagerException

Description copied from interface: KeyManager

Delete a key from the underlying store.

Parameters:

key - the key to delete.

Throws:

KeyManagerException

getAllKeys

public List<AuthenticationKey> getAllKeys()

addKey

public AuthenticationKey addKey(AuthenticationKey key)

eraseDatabase

public void eraseDatabase()

getId

public String getId()

Description copied from interface: KeyManager

String identifying the key manager implementation.

Returns:

the key manager implementation id.