Package javax.jcr

Class SimpleCredentials

java.lang.Object
javax.jcr.SimpleCredentials
All Implemented Interfaces:
Serializable, Credentials
public final class SimpleCredentials extends Object implements Credentials
SimpleCredentials implements the Credentials interface and represents simple user ID/password credentials.
See Also:

  • Constructor Details

    • SimpleCredentials

      public SimpleCredentials(String userID, char[] password)
      The constructor creates a new SimpleCredentials object, given a user ID and password.

      Note that the given password is cloned before it is stored in the new SimpleCredentials object. This should avoid the risk of having unnecessary references to password data lying around in memory.

      Parameters:
      userID - the user ID
      password - the user's password

  • Method Details

    • getPassword

      public char[] getPassword()
      Returns the user password.

      Note that this method returns a reference to the password. It is the caller's responsibility to zero out the password information after it is no longer needed.

      Returns:
      the password

    • getUserID

      public String getUserID()
      Returns the user ID.
      Returns:
      the user ID.

    • setAttribute

      public void setAttribute(String name, Object value)
      Stores an attribute in this credentials instance.
      Parameters:
      name - a String specifying the name of the attribute
      value - the Object to be stored

    • getAttribute

      public Object getAttribute(String name)
      Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
      Parameters:
      name - a String specifying the name of the attribute
      Returns:
      an Object containing the value of the attribute, or null if the attribute does not exist

    • removeAttribute

      public void removeAttribute(String name)
      Removes an attribute from this credentials instance.
      Parameters:
      name - a String specifying the name of the attribute to remove

    • getAttributeNames

      public String[] getAttributeNames()
      Returns the names of the attributes available to this credentials instance. This method returns an empty array if the credentials instance has no attributes available to it.
      Returns:
      a string array containing the names of the stored attributes