PromptingKeyManager (TrueCommons KeyManager Specification 2.3.4 API)

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 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.

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

Method Summary

Methods
Modifier and Type	Method and Description
`PromptingKey.View<K>`	`getView()`
`void`	`link(URI oldResource, URI newResource)` Notifies this key manager that a protected resource has been linked.
`PromptingKeyProvider<K>`	`provider(URI resource)` Returns a key provider for accessing the identified protected resource.
`void`	`release(URI resource)` Notifies this key manager that a protected resource has been released.
`protected void`	`resetCancelledKey(URI resource)` Resets the state of the key provider for the given protected resource if and only if prompting for the key has been cancelled.
`protected void`	`resetUnconditionally(URI resource)` Resets the state of the key provider for the given protected resource unconditionally.
`String`	`toString()` Returns a string representation of this object for logging and debugging purposes.
`void`	`unlink(URI resource)` 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
  - getView
```
public final PromptingKey.View<K> getView()
```
  - link
```
public void link(URI oldResource,
        URI newResource)
```
    Description copied from interface: KeyManager
    
    Notifies this key manager that a protected resource has been linked.
    
    Parameters:
    oldResource - the old URI of the protected resource.
    newResource - the new URI of the protected resource.
  - provider
```
public PromptingKeyProvider<K> provider(URI resource)
```
    Description copied from interface: KeyManager
    
    Returns a key provider for accessing the identified protected resource.
    
    Parameters:
    resource - the URI of the protected resource.
  - release
```
public void release(URI resource)
```
    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 forwards the call to resetCancelledKey(URI).
    
    Parameters:
    resource - the URI of the protected resource.
  - resetCancelledKey
```
protected void resetCancelledKey(URI resource)
```
    Resets the state of the key provider for the given protected resource if and only if prompting for the key has been cancelled.
    
    Parameters:
    resource - the URI of the protected resource.
  - resetUnconditionally
```
protected void resetUnconditionally(URI resource)
```
    Resets the state of the key provider for the given protected resource unconditionally.
    
    Parameters:
    resource - 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 resource)
```
    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:
    resource - the URI of the protected resource.

Class PromptingKeyManager<K extends PromptingKey<K>>

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

PromptingKeyManager

Method Detail

getView

link

provider

release

resetCancelledKey

resetUnconditionally

toString

unlink