PromptingKeyManager (TrueZIP Driver ZIP 7.3.3 API)

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

Type Parameters:: K - The type of the keys.

All Implemented Interfaces:: KeyManager<K>

@ThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public final class PromptingKeyManager<K extends SafeKey<K>>
extends SafeKeyManager<K,PromptingKeyProvider<K>>

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

Author:: Christian Schlichtherle
See Also:: PromptingKeyProvider

Field Summary

Fields
Modifier and Type Field and Description

private PromptingKeyProvider.View<K> view

Fields
Modifier and Type	Field and Description
`private PromptingKeyProvider.View<K>`	`view`

Constructor Summary

Constructors
Constructor and Description

PromptingKeyManager(PromptingKeyProvider.View<K> view)
Constructs a new prompting key manager.

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

Method Summary

Methods
Modifier and Type	Method and Description
`PromptingKeyProvider<K>`	`getKeyProvider(URI resource)` Returns the mapped key provider for the given protected resource.
`PromptingKeyProvider<K>`	`getMappedKeyProvider(URI resource)` Returns the key provider which is mapped for the given `resource` or `null` if no key provider is mapped.
`(package private) PromptingKeyProvider.View<K>`	`getView()`
`PromptingKeyProvider<K>`	`moveKeyProvider(URI oldResource, URI newResource)` Moves the mapped key provider from the URI `oldResource` to `newResource`.
`protected PromptingKeyProvider<K>`	`newKeyProvider()` Returns a new prompting key provider.
`PromptingKeyProvider<K>`	`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 de.schlichtherle.truezip.key.SafeKeyManager
getPriority

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

- Field Detail
  - view
```
private final PromptingKeyProvider.View<K extends SafeKey<K>> view
```
- Constructor Detail
  - PromptingKeyManager
```
public PromptingKeyManager(PromptingKeyProvider.View<K> view)
```
    Constructs a new prompting key manager.
    
    Parameters:
    view - the view instance for prompting for keys.
- Method Detail
  - getKeyProvider
```
public PromptingKeyProvider<K> 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>>
    
    Overrides:
    
    getKeyProvider in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>
    
    Parameters:
    resource - the URI of the protected resource.
    
    Returns:
    The key provider mapped for the protected resource.
  - getMappedKeyProvider
```
@Nullable
public PromptingKeyProvider<K> getMappedKeyProvider(URI resource)
```
    Description copied from class: SafeKeyManager
    
    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.
    
    Overrides:
    
    getMappedKeyProvider in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>
    
    Parameters:
    resource - the nullable URI of the protected resource.
    
    Returns:
    The key provider mapped for the protected resource.
  - getView
```
final PromptingKeyProvider.View<K> getView()
```
  - moveKeyProvider
```
public PromptingKeyProvider<K> 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>>
    
    Overrides:
    
    moveKeyProvider in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<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 PromptingKeyProvider<K> newKeyProvider()
```
    Returns a new prompting key provider.
    
    Specified by:
    
    newKeyProvider in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>
    
    Returns:
    A new prompting key provider.
    Since:
    
    TrueZIP 7.2
  - removeKeyProvider
```
public PromptingKeyProvider<K> removeKeyProvider(URI resource)
```
    Description copied from class: SafeKeyManager
    
    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>>
    
    Overrides:
    
    removeKeyProvider in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<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 SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>

Class PromptingKeyManager<K extends SafeKey<K>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.key.SafeKeyManager

Methods inherited from class java.lang.Object

Field Detail

view

Constructor Detail

PromptingKeyManager

Method Detail

getKeyProvider

getMappedKeyProvider

getView

moveKeyProvider

newKeyProvider

removeKeyProvider

toString