Constructor Detail

• KeyManager

  public KeyManager()

Method Detail

• delete

  @CheckForNull
  public abstract KeyProvider<K> delete(URI resource)

  Deletes the mapped key provider for the given protected resource. It is an error to use the returned key provider.

  Parameters:

  resource - the URI of the protected resource.

  Returns:

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

• get

  @CheckForNull
  public abstract KeyProvider<K> get(URI resource)

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

  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 abstract KeyProvider<K> make(URI resource)

  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.

  Parameters:

  resource - the URI of the protected resource.

  Returns:

  The mapped key provider for the given protected resource.

• move

  @CheckForNull
  public abstract KeyProvider<K> move(URI oldResource,
                                 URI newResource)

  Moves the mapped 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 oldResource compares equal to newResource.

• toString

  public String toString()

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

  Overrides:

  toString in class Object

• unlock

  public abstract void unlock(URI resource)

  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.

  Parameters:

  resource -