SafeKeyManager (TrueZIP Driver ZIP 7.7.5 API)

java.lang.Object
- de.schlichtherle.truezip.key.SafeKeyManager<K,P>

All Implemented Interfaces:

KeyManager<K>

Direct Known Subclasses:

PromptingKeyManager
```
@ThreadSafe
public abstract class SafeKeyManager<K extends SafeKey<K>,P extends SafeKeyProvider<K>>
extends Object
implements 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`	`getKeyProvider(URI resource)` Returns the mapped key provider for the given protected resource.
`P`	`getMappedKeyProvider(URI resource)` Returns the key provider which is mapped for the given `resource` or `null` if no key provider is mapped.
`int`	`getPriority()` Returns a priority to help the key manager service locator.
`P`	`moveKeyProvider(URI oldResource, URI newResource)` Moves the mapped key provider from the URI `oldResource` to `newResource`.
`protected abstract P`	`newKeyProvider()` Returns a new key provider.
`P`	`removeKeyProvider(URI resource)` Removes the mapped key provider for the given protected resource.
`String`	`toString()` Returns a string representation of this object for debugging and logging purposes.

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.
    
    Since:
    
    TrueZIP 7.2
- Method Detail
  - getKeyProvider
```
public P getKeyProvider(URI resource)
```
    Description copied from interface: KeyManager
    
    Returns the mapped key provider for the given protected resource. If no key provider is mapped yet, a new key provider is created and returned.
    
    Specified by:
    
    getKeyProvider in interface KeyManager<K extends SafeKey<K>>
    
    Parameters:
    resource - the URI of the protected resource.
    
    Returns:
    The key provider mapped for the protected resource.
  - getMappedKeyProvider
```
@Nullable
public P getMappedKeyProvider(URI resource)
```
    Returns the key provider which is mapped for the given resource or null if no key provider is mapped.
    TODO: Make this part of the interface KeyManager in the next major version.
    
    Parameters:
    resource - the nullable URI of the protected resource.
    
    Returns:
    The key provider mapped for the protected resource.
  - getPriority
```
public int getPriority()
```
    Description copied from interface: KeyManager
    
    Returns a priority to help the key manager service locator. The greater number wins! The default value should be 0.
    
    Specified by:
    
    getPriority in interface KeyManager<K extends SafeKey<K>>
    
    Returns:
    A priority to help the key manager service locator.
  - moveKeyProvider
```
public P moveKeyProvider(URI oldResource,
                URI newResource)
```
    Description copied from interface: KeyManager
    
    Moves the mapped key provider from the URI oldResource to newResource.
    
    Specified by:
    
    moveKeyProvider in interface 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.
    Since:
    
    TrueZIP 7.2
  - removeKeyProvider
```
public P removeKeyProvider(URI resource)
```
    Removes 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:
    
    removeKeyProvider in interface 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.
  - toString
```
public String toString()
```
    Returns a string representation of this object for debugging and logging purposes.
    
    Overrides:
    
    toString in class Object

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SafeKeyManager

Method Detail

getKeyProvider

getMappedKeyProvider

getPriority

moveKeyProvider

newKeyProvider

removeKeyProvider

toString