SafeKeyManager (TrueVFS KeyManager Specification 0.9 API)

java.lang.Object
- net.java.truevfs.key.spec.KeyManager<K>
- - net.java.truevfs.key.spec.SafeKeyManager<K,P>

Type Parameters:
K - the type of the safe keys.
P - the type of the safe key providers.

Direct Known Subclasses:

PromptingKeyManager
```
@ThreadSafe
public abstract class SafeKeyManager<K extends SafeKey<K>,P extends SafeKeyProvider<K>>
extends KeyManager<K>
```
Uses a map to hold the safe key providers managed by this instance.

Author:

Christian Schlichtherle

Constructor Summary

Constructors
Modifier Constructor and Description

protected SafeKeyManager()
Constructs a new safe key manager.

Constructors
Modifier	Constructor and Description
`protected`	`SafeKeyManager()` Constructs a new safe key manager.

Method Summary

Methods
Modifier and Type	Method and Description
`P`	`delete(URI resource)` Deletes the mapped key provider for the given protected resource.
`P`	`get(URI resource)` Returns the mapped key provider for the given protected resource or `null` if no key provider is mapped yet.
`P`	`make(URI resource)` Returns the mapped key provider for the given protected resource.
`P`	`move(URI oldResource, URI newResource)` Moves the mapped key provider from the URI `oldResource` to `newResource`.
`protected abstract P`	`newKeyProvider()` Returns a new key provider.

Methods inherited from class net.java.truevfs.key.spec.KeyManager
toString, unlock

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SafeKeyManager
```
protected SafeKeyManager()
```
    Constructs a new safe key manager.
- Method Detail
  - delete
```
@CheckForNull
public P delete(URI resource)
```
    Deletes the mapped key provider for the given protected resource. It is an error to use the returned key provider.
    The returned key provider is invalidated and will behave as if prompting for the secret key had been disabled or cancelled by the user.
    
    Specified by:
    
    delete in class KeyManager<K extends SafeKey<K>>
    
    Parameters:
    resource - the URI of the protected resource.
    
    Returns:
    The key provider which was previously mapped for the protected resource.
  - get
```
@CheckForNull
public P get(URI resource)
```
    Description copied from class: KeyManager
    
    Returns the mapped key provider for the given protected resource or null if no key provider is mapped yet.
    
    Specified by:
    
    get in class KeyManager<K extends SafeKey<K>>
    
    Parameters:
    resource - the URI of the protected resource.
    
    Returns:
    The mapped key provider for the given protected resource or null if no key provider is mapped yet.
  - make
```
public P make(URI resource)
```
    Description copied from class: KeyManager
    
    Returns the mapped key provider for the given protected resource. If no key provider is mapped yet, then a new key provider gets created and returned.
    
    Specified by:
    
    make in class KeyManager<K extends SafeKey<K>>
    
    Parameters:
    resource - the URI of the protected resource.
    
    Returns:
    The mapped key provider for the given protected resource.
  - move
```
@CheckForNull
public P move(URI oldResource,
                  URI newResource)
```
    Description copied from class: KeyManager
    
    Moves the mapped key provider from the URI oldResource to newResource.
    
    Specified by:
    
    move in class KeyManager<K extends SafeKey<K>>
    
    Parameters:
    oldResource - the old URI of the protected resource.
    newResource - the new URI of the protected resource.
    
    Returns:
    The key provider which was previously mapped for the protected resource newResource.
  - newKeyProvider
```
protected abstract P newKeyProvider()
```
    Returns a new key provider.
    
    Returns:
    A new key provider.

Class SafeKeyManager<K extends SafeKey<K>,P extends SafeKeyProvider<K>>

Constructor Summary

Method Summary

Methods inherited from class net.java.truevfs.key.spec.KeyManager

Methods inherited from class java.lang.Object

Constructor Detail

SafeKeyManager

Method Detail

delete

get

make

move

newKeyProvider