@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)

Package de.schlichtherle.truezip.key

Provides an extensible manager for generic keys required to create or open protected resources.

See: Description

Interface Summary

Interface	Description
KeyManager<K>	A container for key providers for reading and writing protected resources.
KeyManagerProvider	A service for key managers for secret key classes.
KeyProvider<K>	Manages the life cycle of a generic secret key for reading and writing protected resources.
PromptingKeyProvider.Controller<K extends SafeKey<K>>	Proxies access to the key for PromptingKeyProvider.View implementations.
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.
SafeKey<K>	A safe secret key for the encryption and decryption of protected resources.

Class Summary

Class	Description
AbstractKeyManagerProvider	An abstract key manager provider.
PromptingKeyManager<K extends SafeKey<K>>	A key manager which prompts the user for a key if required.
PromptingKeyProvider<K extends SafeKey<K>>	A "safe" key provider which prompts the user for a key for its protected resource.
SafeKeyManager<K extends SafeKey<K>,P extends SafeKeyProvider<K>>	Uses a map to hold the safe key providers managed by this instance.
SafeKeyProvider<K extends SafeKey<K>>	Provides the base functionality required to implement a "safe" key provider.

Exception Summary

Exception	Description
CacheableUnknownKeyException	Thrown to indicate that the retrieval of the key to open or create a protected resource has failed and that this exception is cacheable.
KeyPromptingCancelledException	Thrown to indicate that the retrieval of the key to open or create a protected resource has been cancelled.
KeyPromptingDisabledException	Thrown to indicate that the retrieval of the key to open or create a protected resource has been disabled.
KeyPromptingInterruptedException	Thrown to indicate that prompting for a key to open or create a protected resource has been interrupted.
KeyPromptingTimeoutException	Thrown to indicate that prompting for a key to open or create a protected resource has timed out.
UnknownKeyException	Thrown to indicate that the retrieval of the key to open or create a protected resource has failed.

Package de.schlichtherle.truezip.key Description

Provides an extensible manager for generic keys required to create or open protected resources. Its primary objective is to decouple...

• the process to retrieve keys required to open or create protected resources from...
• the process to use and verify these keys.

The process to retrieve keys is executed by the (abstract) classes and interfaces in this package.

The process to use and optionally authenticate keys is executed by the users of this package - called client applications or clients for short.

A protected resource can be anything which can be referenced by a URI: As an example, it could be a URL to an AES encrypted file which the client application is going to create or overwrite. The key could be a password or a key file entered or selected by the user.