Constructor Detail

• PromptingKeyManager

  public PromptingKeyManager(PromptingKeyProvider.View<K> view)

  Constructs a new prompting key manager.

  Parameters:

  view - the view instance for prompting for keys.

Method Detail

• delete

  @CheckForNull
  public final PromptingKeyProvider<K> delete(URI resource)

  Description copied from class: SafeKeyManager
  Deletes the mapped key provider for the given protected resource. It is an error to use the returned key provider.

  The returned key provider is invalidated and will behave as if prompting for the secret key had been disabled or cancelled by the user.

  Overrides:

  delete in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>

  Parameters:

  resource - the URI of the protected resource.

  Returns:

  The key provider which was previously mapped for the protected resource.

• get

  @CheckForNull
  public final PromptingKeyProvider<K> get(URI resource)

  Description copied from class: KeyManager
  Returns the mapped key provider for the given protected resource or null if no key provider is mapped yet.

  Overrides:

  get in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>

  Parameters:

  resource - the URI of the protected resource.

  Returns:

  The mapped key provider for the given protected resource or null if no key provider is mapped yet.

• make

  public final PromptingKeyProvider<K> make(URI resource)

  Description copied from class: KeyManager
  Returns the mapped key provider for the given protected resource. If no key provider is mapped yet, then a new key provider gets created and returned.

  Overrides:

  make in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>

  Parameters:

  resource - the URI of the protected resource.

  Returns:

  The mapped key provider for the given protected resource.

• move

  @CheckForNull
  public final PromptingKeyProvider<K> move(URI oldResource,
                                          URI newResource)

  Description copied from class: KeyManager
  Moves the mapped key provider from the URI oldResource to newResource.

  Overrides:

  move in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>

  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.

• newKeyProvider

  protected final PromptingKeyProvider<K> newKeyProvider()

  Returns a new prompting key provider.

  Specified by:

  newKeyProvider in class SafeKeyManager<K extends SafeKey<K>,PromptingKeyProvider<K extends SafeKey<K>>>

  Returns:

  A new prompting key provider.

• toString

  public String toString()

  Returns a string representation of this object for debugging and logging purposes.

  Overrides:

  toString in class KeyManager<K extends SafeKey<K>>

• unlock

  public void unlock(URI resource)

  Description copied from class: KeyManager
  If and only if this key manager prompts users for keys, e.g. a password, and prompting for the key for the given protected resources had been cancelled by the user, then the key provider shall get reset to a state so that the user will get prompted again the next time a key is requested from the provider. Otherwise, this method shall have no effect.

  This method is typically used once a file system has been synced in order to give the user a chance to enter the key the next time the file system will get accessed again. Otherwise the key provider would forever stay in its cancelled state.

  Specified by:

  unlock in class KeyManager<K extends SafeKey<K>>