Method Detail

• enabled

  boolean enabled​()

  Check whether this provider can be used in the current JVM session. If integrating a native keyring, this should attempt to load related libraries and check whether they can be found. This method will be called at most once per JVM session, prior to any other methods in this interface being called.

  Returns:

  true if this provider should be used, false if not

• read

  char[] read​(java.lang.String key)

  Read a key from the ring.

  Parameters:

  key - the identifier of the key

  Returns:

  its value if found (elements may be later nulled out), else null if not present

• save

  void save​(java.lang.String key,
            char[] password,
            java.lang.String description)

  Save a key to the ring. If it could not be saved, do nothing. If the key already existed, overwrite the password.

  Parameters:

  key - a key identifier

  password - the password or other sensitive information associated with the key (elements will be later nulled out)

  description - a user-visible description of the key (may be null)

• delete

  void delete​(java.lang.String key)

  Delete a key from the ring. If the key was not in the ring to begin with, do nothing.

  Parameters:

  key - a key identifier