Interface Principal

All Known Subinterfaces:
GroupPrincipal,UserPrincipal
All Known Implementing Classes:
Identity,IdentityScope,JMXPrincipal,KerberosPrincipal,Signer,X500Principal
public interfacePrincipal
This interface represents the abstract notion of aPrincipal, which can be used to represent any entity, such as an individual, a corporation, and a login id.
Since:
1.1
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object another)
    Compares thisPrincipal to the specified object.
    Returns the name of thisPrincipal.
    int
    Returns a hashcode for thisPrincipal.
    default boolean
    implies(Subject subject)
    Returnstrue if the specified subject is implied by thisPrincipal.
    Returns a string representation of thisPrincipal.

  • Method Details

    • equals

      boolean equals(Object another)
      Compares thisPrincipal to the specified object. Returnstrue if the object passed in matches thePrincipal represented by the implementation of this interface.
      Overrides:
      equals in class Object
      Parameters:
      another -Principal to compare with.
      Returns:
      true if thePrincipal passed in is the same as that encapsulated by thisPrincipal, andfalse otherwise.
      See Also:

    • toString

      String toString()
      Returns a string representation of thisPrincipal.
      Overrides:
      toString in class Object
      Returns:
      a string representation of thisPrincipal.

    • hashCode

      int hashCode()
      Returns a hashcode for thisPrincipal.
      Overrides:
      hashCode in class Object
      Returns:
      a hashcode for thisPrincipal
      See Also:

    • getName

      String getName()
      Returns the name of thisPrincipal.
      Returns:
      the name of thisPrincipal.

    • implies

      default boolean implies(Subject subject)
      Returnstrue if the specified subject is implied by thisPrincipal.
      Implementation Requirements:
      The default implementation of this method returnstrue ifsubject is non-null and contains at least onePrincipal that is equal to thisPrincipal.

      Subclasses may override this with a different implementation, if necessary.

      Parameters:
      subject - theSubject
      Returns:
      true ifsubject is non-null and is implied by thisPrincipal, or false otherwise.
      Since:
      1.8