de.schlichtherle.truezip.key

Interface PromptingKeyProvider.Controller<K extends SafeKey<K>>

Enclosing class:

PromptingKeyProvider<K extends SafeKey<K>>

@NotThreadSafe
public static interface PromptingKeyProvider.Controller<K extends SafeKey<K>>

Proxies access to the key for PromptingKeyProvider.View implementations.

Method Summary

Modifier and Type	Method and Description
K	getKey() Returns the protected resource's key.
URI	getResource() Returns the unique resource identifier (resource ID) of the protected resource for which this controller is used.
void	setChangeRequested(boolean changeRequested) Requests to prompt the user for a new key upon the next call to SafeKeyProvider.getWriteKey(), provided that the key is set by then.
void	setKey(K key) Sets the protected resource's key to a clone of the given key.

Method Detail

getKey

@CheckForNull
K getKey()

Returns the protected resource's key.

Returns:

The protected resource's key.

Throws:

IllegalStateException - if getting key is not legal in the current state.

getResource

URI getResource()

Returns the unique resource identifier (resource ID) of the protected resource for which this controller is used.

Throws:

IllegalStateException - if getting this property is not legal in the current state.

setChangeRequested

void setChangeRequested(boolean changeRequested)

Requests to prompt the user for a new key upon the next call to SafeKeyProvider.getWriteKey(), provided that the key is set by then.

Parameters:

changeRequested - whether or not the user shall get prompted for a new key upon the next call to SafeKeyProvider.getWriteKey(), provided that the key is set then.

Throws:

IllegalStateException - if setting this property is not legal in the current state.

setKey

void setKey(@CheckForNull
            K key)

Sets the protected resource's key to a clone of the given key.

Parameters:

key - The key to clone to use for the protected resource.

Throws:

IllegalStateException - if setting key is not legal in the current state.