net.java.truecommons.key.spec.prompting

Class PromptingKeyManager<K extends PromptingKey<K>>

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truecommons.key.spec.AbstractKeyManager<K>

net.java.truecommons.key.spec.prompting.PromptingKeyManager<K>

Type Parameters:

K - the type of the prompting keys.

All Implemented Interfaces:

KeyManager<K>

@ThreadSafe
public final class PromptingKeyManager<K extends PromptingKey<K>>
extends AbstractKeyManager<K>

A key manager which prompts the user for a secret key if required.

Since:

TrueCommons 2.2

Author:

Christian Schlichtherle

See Also:

PromptingKeyManagerMap

Constructor Summary

Constructors

Constructor and Description
PromptingKeyManager(PromptingKey.View<K> view) Constructs a new prompting key manager.

Method Summary

Modifier and Type	Method and Description
void	link(URI originUri, URI targetUri) Notifies this key manager that a protected resource has been linked.
KeyProvider<K>	provider(URI uri) Returns a key provider for accessing the identified protected resource.
void	release(URI uri) Notifies this key manager that a protected resource has been released.
String	toString() Returns a string representation of this object for logging and debugging purposes.
void	unlink(URI uri) Notifies this key manager that a protected resource has been unlinked.

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PromptingKeyManager

public PromptingKeyManager(PromptingKey.View<K> view)

Constructs a new prompting key manager.

Parameters:

view - the view for key prompting.

Method Detail

link

public void link(URI originUri,
                 URI targetUri)

Description copied from interface: KeyManager

Notifies this key manager that a protected resource has been linked.

Parameters:

originUri - the origin URI of the protected resource.

targetUri - the target URI of the protected resource.

provider

public KeyProvider<K> provider(URI uri)

Description copied from interface: KeyManager

Returns a key provider for accessing the identified protected resource.

Parameters:

uri - the URI of the protected resource.

Returns:

a consistent (but not necessarily always the same) key provider for accessing the identified protected resource.

release

public void release(URI uri)

Notifies this key manager that a protected resource has been released. Clients should call this method only if they wish to reset or dispose the key provider which may be associated with the protected resource. Implementations may completely ignore this call or chose to reset or dispose the associated key provider based on its state. For example, an implementation may reset the key provider only if the user had cancelled the prompting for the key.

The implementation in the class PromptingKeyManager resets the state of the key provider for the given protected resource if and only if prompting for the key has been cancelled.

Parameters:

uri - the URI of the protected resource.

toString

public String toString()

Returns a string representation of this object for logging and debugging purposes.

Overrides:

toString in class AbstractKeyManager<K extends PromptingKey<K>>

unlink

public void unlink(URI uri)

Description copied from interface: KeyManager

Notifies this key manager that a protected resource has been unlinked. This implies a KeyManager.release(java.net.URI).

Parameters:

uri - the URI of the protected resource.