PromptingKeyProvider (TrueZIP Driver ZIP 7.3.4 API)

java.lang.Object
- de.schlichtherle.truezip.key.SafeKeyProvider<K>
- - de.schlichtherle.truezip.key.PromptingKeyProvider<K>

Type Parameters:
K - The type of the keys.

All Implemented Interfaces:

KeyProvider<K>
```
@ThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public final class PromptingKeyProvider<K extends SafeKey<K>>
extends SafeKeyProvider<K>
```
A "safe" key provider which prompts the user for a key for its protected resource. The user is prompted via an instance of the PromptingKeyProvider.View interface. The view may then display the resource URI by calling getResource() on this instance and set the key by using the given PromptingKeyProvider.Controller.

Author:

Christian Schlichtherle

See Also:
PromptingKeyManager

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`PromptingKeyProvider.BaseController` Proxies access to the secret key for `PromptingKeyProvider.View` implementations.
`static interface`	`PromptingKeyProvider.Controller<K extends SafeKey<K>>` Proxies access to the key for `PromptingKeyProvider.View` implementations.
`private class`	`PromptingKeyProvider.ReadController` The controller to use when promting for a secret key to decrypt a protected resource.
`private static class`	`PromptingKeyProvider.State` Implements the behavior strategy of its enclosing class.
`static interface`	`PromptingKeyProvider.View<K extends SafeKey<K>>` Used for the actual prompting of the user for a key (a password for example) which is required to access a protected resource.
`private class`	`PromptingKeyProvider.WriteController` The controller to use when promting for a secret key to encrypt a protected resource.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`changeRequested`
`private CacheableUnknownKeyException`	`exception`
`private PromptingKeyManager<K>`	`manager`
`private URI`	`resource` The resource identifier for the protected resource.
`private PromptingKeyProvider.State`	`state`

Fields inherited from class de.schlichtherle.truezip.key.SafeKeyProvider
MIN_KEY_RETRY_DELAY

Constructor Summary

Constructors
Constructor and Description

PromptingKeyProvider(PromptingKeyManager<K> manager)

Constructors
Constructor and Description
`PromptingKeyProvider(PromptingKeyManager<K> manager)`

Method Summary

Methods
Modifier and Type	Method and Description
`private CacheableUnknownKeyException`	`getException()`
`protected K`	`getKey()`
`private K`	`getKey0()`
`URI`	`getResource()` Returns the unique resource identifier (resource ID) of the protected resource for which this key provider is used.
`private PromptingKeyProvider.State`	`getState()`
`private PromptingKeyProvider.View<K>`	`getView()`
`private boolean`	`isChangeRequested()` Returns whether or not the user shall get prompted for a new key upon the next call to `SafeKeyProvider.getWriteKey()`, provided that the key has been `set` before.
`private void`	`reset()`
`void`	`resetCancelledKey()` Resets the state of this key provider, its current key and the value of its `changeRequested` property if and only if prompting for a key has been cancelled.
`void`	`resetUnconditionally()` Resets the state of this key provider, its current key and the value of its `changeRequested` property unconditionally.
`protected void`	`retrieveReadKey(boolean invalid)` Retrieves the secret key for the decryption of a protected resource.
`protected void`	`retrieveWriteKey()` Retrieves the secret key for the encryption of a protected resource.
`private void`	`setChangeRequested(boolean changeRequested)`
`private void`	`setException(CacheableUnknownKeyException exception)`
`void`	`setKey(K key)` Sets the secret key programmatically.
`private void`	`setKey0(K key)`
`(package private) void`	`setResource(URI resource)` Returns the unique resource identifier (resource ID) of the protected resource for which this key provider is used.
`private void`	`setState(PromptingKeyProvider.State state)`

Methods inherited from class de.schlichtherle.truezip.key.SafeKeyProvider
getReadKey, getWriteKey

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

- Field Detail
  - changeRequested
```
private volatile boolean changeRequested
```
  - exception
```
@CheckForNull
private volatile CacheableUnknownKeyException exception
```
  - manager
```
private final PromptingKeyManager<K extends SafeKey<K>> manager
```
  - resource
```
@CheckForNull
private volatile URI resource
```
    The resource identifier for the protected resource.
  - state
```
private volatile PromptingKeyProvider.State state
```
- Constructor Detail
  - PromptingKeyProvider
```
PromptingKeyProvider(PromptingKeyManager<K> manager)
```
- Method Detail
  - getException
```
@CheckForNull
private CacheableUnknownKeyException getException()
```
  - getKey
```
protected K getKey()
```
    Overrides:
    
    getKey in class SafeKeyProvider<K extends SafeKey<K>>
  - getKey0
```
@CheckForNull
private K getKey0()
```
  - getResource
```
@CheckForNull
public URI getResource()
```
    Returns the unique resource identifier (resource ID) of the protected resource for which this key provider is used. May be null.
  - getState
```
private PromptingKeyProvider.State getState()
```
  - getView
```
private PromptingKeyProvider.View<K> getView()
```
  - isChangeRequested
```
private boolean isChangeRequested()
```
    Returns whether or not the user shall get prompted for a new key upon the next call to SafeKeyProvider.getWriteKey(), provided that the key has been set before.
    
    Returns:
    Whether or not the user shall get prompted for a new key upon the next call to SafeKeyProvider.getWriteKey(), provided that the key has been set before.
  - reset
```
private void reset()
```
  - resetCancelledKey
```
public void resetCancelledKey()
```
    Resets the state of this key provider, its current key and the value of its changeRequested property if and only if prompting for a key has been cancelled.
  - resetUnconditionally
```
public void resetUnconditionally()
```
    Resets the state of this key provider, its current key and the value of its changeRequested property unconditionally.
  - retrieveReadKey
```
protected void retrieveReadKey(boolean invalid)
                        throws UnknownKeyException
```
    Description copied from class: SafeKeyProvider
    
    Retrieves the secret key for the decryption of a protected resource.
    Subsequent calls to this method may return the same object.
    
    Specified by:
    
    retrieveReadKey in class SafeKeyProvider<K extends SafeKey<K>>
    
    Throws:
    
    UnknownKeyException - If the secret key is unknown. At the subclasses discretion, this may mean that prompting for the key has been disabled or cancelled by the user.
    See Also:
    SafeKeyProvider.getReadKey(boolean)
  - retrieveWriteKey
```
protected void retrieveWriteKey()
                         throws UnknownKeyException
```
    Description copied from class: SafeKeyProvider
    
    Retrieves the secret key for the encryption of a protected resource.
    Subsequent calls to this method may return the same object.
    
    Specified by:
    
    retrieveWriteKey in class SafeKeyProvider<K extends SafeKey<K>>
    
    Throws:
    
    UnknownKeyException - If the secret key is unknown. At the subclasses discretion, this may mean that prompting for the key has been disabled or cancelled by the user.
    See Also:
    SafeKeyProvider.getWriteKey()
  - setChangeRequested
```
private void setChangeRequested(boolean changeRequested)
```
  - setException
```
private void setException(@CheckForNull
                CacheableUnknownKeyException exception)
```
  - setKey
```
public void setKey(@CheckForNull
          K key)
```
    Description copied from interface: KeyProvider
    
    Sets the secret key programmatically. This can get used after a call to KeyProvider.getReadKey(boolean) in order to update some properties of the secret key after it has been validated by the client.
    Implementations should make a protective copy of the given key in order to protect against subsequent modifications by the client.
    
    Specified by:
    
    setKey in interface KeyProvider<K extends SafeKey<K>>
    
    Overrides:
    
    setKey in class SafeKeyProvider<K extends SafeKey<K>>
    
    Parameters:
    key - the secret key. If this is null, this key provider is set to a state as if prompting for the secret key had been cancelled.
  - setKey0
```
private void setKey0(@CheckForNull
           K key)
```
  - setResource
```
void setResource(@CheckForNull
               URI resource)
```
    Returns the unique resource identifier (resource ID) of the protected resource for which this key provider is used. May be null.
  - setState
```
private void setState(PromptingKeyProvider.State state)
```

Class PromptingKeyProvider<K extends SafeKey<K>>

Nested Class Summary

Field Summary

Fields inherited from class de.schlichtherle.truezip.key.SafeKeyProvider

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

changeRequested

exception

manager

resource

state

Constructor Detail

PromptingKeyProvider

Method Detail

getException

getKey

getKey0

getResource

getState

getView

isChangeRequested

reset

resetCancelledKey

resetUnconditionally

retrieveReadKey

retrieveWriteKey

setChangeRequested

setException

setKey

setKey0

setResource

setState