de.schlichtherle.truezip.key (TrueZIP Driver ZIP.RAES (TZP) 7.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

TrueZIP Driver ZIP.RAES (TZP) 7.1

PREV PACKAGE NEXT PACKAGE

FRAMES NO FRAMES

Package de.schlichtherle.truezip.key

A generic, extensible manager for keys of arbitrary type required to create or open protected resources.

See:
Description

Interface Summary
KeyManager<K>	A container for key providers for protected resources which need to get created or opened by client applications.
KeyManagerProvider	A service for the singleton key manager for given key type.
KeyProvider<K>	A general purpose interface used by client applications to retrieve a key which is required for write or read access to a protected resource.
KeyProvider.Factory<P extends KeyProvider<?>>	A factory for key providers.
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 key for a protected resource.

Class Summary
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.
PromptingKeyProvider.Controller<K extends SafeKey<K>>	Proxies access to the key for `PromptingKeyProvider.View` implementations.
PromptingKeyProvider.Factory<K extends SafeKey<K>>	A factory for `PromptingKeyProvider`s.
PromptingKeyProvider.ReadController<K extends SafeKey<K>>
PromptingKeyProvider.WriteController<K extends SafeKey<K>>
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.
SafeKeyProvider.ThreadLocalLong

Enum Summary
PromptingKeyProvider.State	Implements the behavior strategy of its enclosing class.

Exception Summary
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

A generic, extensible manager for keys of arbitrary type 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.