KeyManager (TrueZIP Driver ZIP.RAES (TZP) 7.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

TrueZIP Driver ZIP.RAES (TZP) 7.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.schlichtherle.truezip.key
Interface KeyManager<K>

@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class) public interface KeyManager<K>

A container for key providers for protected resources which need to get created or opened by client applications.

Implementations must be safe for multi-threading.

Method Summary
`KeyProvider<K>`	`getKeyProvider(URI resource)` Returns the key provider for the given protected resource.
`KeyProvider<K>`	`moveKeyProvider(URI oldResource, URI newResource)` Moves the key provider from the URI `oldResource` to `newResource`.
`KeyProvider<K>`	`removeKeyProvider(URI resource)` Removes the key provider for the given protected resource.

Method Detail

KeyProvider<K> getKeyProvider(URI resource)

Returns the key provider for the given protected resource. If no key provider is mapped, a new key provider is created and returned.

@Nullable
KeyProvider<K> moveKeyProvider(URI oldResource,
                                        URI newResource)

Moves the key provider from the URI oldResource to newResource.

Parameters:: oldResource - the old URI of the protected resource.; newResource - the new URI of the protected resource.
Returns:: The key provider which was previously mapped for the protected resource newResource.
Throws:: IllegalArgumentException - if no key provider exists for oldResource or if oldResource compares equal to newResource.

@Nullable
KeyProvider<K> removeKeyProvider(URI resource)

Removes the key provider for the given protected resource.

Parameters:: resource - the URI of the protected resource.
Returns:: The key provider which was previously mapped for the protected resource.
Throws:: IllegalArgumentException - if no key provider exists for resource.