de.schlichtherle.truezip.key.pbe.swing

Class SwingSafePbeParametersView<S extends KeyStrength,P extends SafePbeParameters<S,P>>

java.lang.Object

de.schlichtherle.truezip.key.pbe.SafePbeParametersView<P>

de.schlichtherle.truezip.key.pbe.swing.SwingSafePbeParametersView<S,P>

All Implemented Interfaces:

PromptingKeyProvider.View<P>

Direct Known Subclasses:

AesCipherParametersView, SwingAesPbeParametersView

@ThreadSafe
public abstract class SwingSafePbeParametersView<S extends KeyStrength,P extends SafePbeParameters<S,P>>
extends SafePbeParametersView<P>

A Swing based user interface to prompt for passwords or key files.

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_FILE_LEN This is the number of bytes to load from the beginning of a key file.

Constructor Summary

Constructors

Constructor and Description
SwingSafePbeParametersView()

Method Summary

Modifier and Type	Method and Description
void	promptReadKey(PromptingKeyProvider.Controller<P> controller, boolean invalid) Prompts the user for the key for reading the contents of an existing protected resource.
void	promptWriteKey(PromptingKeyProvider.Controller<P> controller) Prompts the user for the key for (over)writing the contents of a new or existing protected resource.

Methods inherited from class de.schlichtherle.truezip.key.pbe.SafePbeParametersView

newPbeParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_FILE_LEN

public static final int KEY_FILE_LEN

This is the number of bytes to load from the beginning of a key file. A valid key file for encryption must contain at least this number of bytes!

See Also:

Constant Field Values

Constructor Detail

SwingSafePbeParametersView

public SwingSafePbeParametersView()

Method Detail

promptReadKey

public void promptReadKey(PromptingKeyProvider.Controller<P> controller,
                          boolean invalid)
                   throws UnknownKeyException

Description copied from interface: PromptingKeyProvider.View

Prompts the user for the key for reading the contents of an existing protected resource. Upon return, the implementation should have updated the key property of the given controller.

If the implementation has called PromptingKeyProvider.Controller.setKey(K) with a non-null parameter, then a clone of this object will be used as the key.

Otherwise, if the implementation has called PromptingKeyProvider.Controller.setKey(K) with a null parameter or throws a KeyPromptingCancelledException, then prompting for the key is permanently disabled and each subsequent call to SafeKeyProvider.getWriteKey() or SafeKeyProvider.getReadKey(boolean) results in a KeyPromptingCancelledException until PromptingKeyProvider.resetCancelledKey() or PromptingKeyProvider.resetUnconditionally() gets called.

Otherwise, the state of the key provider is not changed and this method gets called again.

Parameters:

controller - The key controller for storing the result.

invalid - true iff a previous call to this method resulted in an invalid key.

Throws:

KeyPromptingCancelledException - if key prompting has been cancelled by the user.

UnknownKeyException - if key prompting fails for any other reason.

promptWriteKey

public void promptWriteKey(PromptingKeyProvider.Controller<P> controller)
                    throws UnknownKeyException

Description copied from interface: PromptingKeyProvider.View

Prompts the user for the key for (over)writing the contents of a new or existing protected resource. Upon return, the implementation should have updated the key property of the given controller.

If the implementation has called PromptingKeyProvider.Controller.setKey(K) with a non-null parameter, then a clone of this object will be used as the key.

Otherwise, prompting for a key is permanently disabled and each subsequent call to SafeKeyProvider.getWriteKey() or SafeKeyProvider.getReadKey(boolean) results in a KeyPromptingCancelledException until PromptingKeyProvider.resetCancelledKey() or PromptingKeyProvider.resetUnconditionally() gets called.

Parameters:

controller - The key controller for storing the result.

Throws:

UnknownKeyException - if key prompting fails for any reason.