Class Identity

java.lang.Object
java.security.Identity
All Implemented Interfaces:
Serializable,Principal
Direct Known Subclasses:
IdentityScope,Signer
@Deprecated(since="1.2",forRemoval=true)public abstract classIdentityextendsObjectimplementsPrincipal,Serializable
Deprecated, for removal: This API element is subject to removal in a future version.
This class is deprecated and subject to removal in a future version of Java SE. It has been replaced byjava.security.KeyStore, thejava.security.cert package, andjava.security.Principal.

This class represents identities: real-world objects such as people, companies or organizations whose identities can be authenticated using their public keys. Identities may also be more abstract (or concrete) constructs, such as daemon threads or smart cards.

AllIdentity objects have a name and a public key. Names are immutable. Identities may also be scoped. That is, if anIdentity is specified to have a particular scope, then the name and public key of theIdentity are unique within that scope.

AnIdentity also has a set of certificates (all certifying its own public key). The Principal names specified in these certificates need not be the same, only the key.

AnIdentity can be subclassed, to include postal and email addresses, telephone numbers, images of faces and logos, and so on.

Since:
1.1
See Also:

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor for serialization only.
     
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs anIdentity with the specified name and no scope.
     
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs anIdentity with the specified name and scope.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds a certificate for thisIdentity.
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a copy of all the certificates for thisIdentity.
    final boolean
    equals(Object identity)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tests for equality between the specified object and thisIdentity.
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns general information previously specified for thisIdentity.
    finalString
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns this identity's name.
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns this identity's public key.
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns this identity's scope.
    int
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the hashcode for thisIdentity.
    protected boolean
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tests for equality between the specifiedIdentity and thisIdentity.
    void
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes a certificate from thisIdentity.
    void
    Deprecated, for removal: This API element is subject to removal in a future version.
    Specifies a general information string for thisIdentity.
    void
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets this identity's public key.
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a short string describing thisIdentity, telling its name and its scope (if any).
    toString(boolean detailed)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a string representation of thisIdentity, with optionally more details than that provided by thetoString method without any arguments.

    Methods declared in class java.lang.Object

    clone,finalize,getClass,notify,notifyAll,wait,wait,wait

    Methods declared in interface java.security.Principal

    implies

  • Constructor Details

    • Identity

      protected Identity()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor for serialization only.

    • Identity

      public Identity(String name,IdentityScope scope) throwsKeyManagementException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs anIdentity with the specified name and scope.
      Parameters:
      name - theIdentity name.
      scope - the scope of theIdentity.
      Throws:
      KeyManagementException - if there is already anIdentity with the same name in the scope.

    • Identity

      public Identity(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs anIdentity with the specified name and no scope.
      Parameters:
      name - the identity name.

  • Method Details

    • getName

      public final String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns this identity's name.
      Specified by:
      getName in interface Principal
      Returns:
      the name of thisIdentity.

    • getScope

      public final IdentityScope getScope()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns this identity's scope.
      Returns:
      the scope of thisIdentity.

    • getPublicKey

      public PublicKey getPublicKey()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns this identity's public key.
      Returns:
      the public key for thisIdentity.
      See Also:

    • setPublicKey

      public void setPublicKey(PublicKey key) throwsKeyManagementException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets this identity's public key. The old key and all of this identity's certificates are removed by this operation.
      Parameters:
      key - the public key for thisIdentity.
      Throws:
      KeyManagementException - if another identity in the identity's scope has the same public key, or if another exception occurs.
      See Also:

    • setInfo

      public void setInfo(String info)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specifies a general information string for thisIdentity.
      Parameters:
      info - the information string.
      See Also:

    • getInfo

      public String getInfo()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns general information previously specified for thisIdentity.
      Returns:
      general information about thisIdentity.
      See Also:

    • addCertificate

      public void addCertificate(Certificate certificate) throwsKeyManagementException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds a certificate for thisIdentity. If theIdentity has a public key, the public key in the certificate must be the same, and if theIdentity does not have a public key, the identity's public key is set to be that specified in the certificate.
      Parameters:
      certificate - the certificate to be added.
      Throws:
      KeyManagementException - if the certificate is not valid, if the public key in the certificate being added conflicts with this identity's public key, or if another exception occurs.

    • removeCertificate

      public void removeCertificate(Certificate certificate) throwsKeyManagementException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes a certificate from thisIdentity.
      Parameters:
      certificate - the certificate to be removed.
      Throws:
      KeyManagementException - if the certificate is missing, or if another exception occurs.

    • certificates

      public Certificate[] certificates()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a copy of all the certificates for thisIdentity.
      Returns:
      a copy of all the certificates for thisIdentity.

    • equals

      public final boolean equals(Object identity)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tests for equality between the specified object and thisIdentity. This first tests to see if the entities actually refer to the same object, in which case it returnstrue. Next, it checks to see if the entities have the same name and the same scope. If they do, the method returnstrue. Otherwise, it callsidentityEquals, which subclasses should override.
      Specified by:
      equals in interface Principal
      Overrides:
      equals in class Object
      Parameters:
      identity - the object to test for equality with thisIdentity.
      Returns:
      true if the objects are considered equal,false otherwise.
      See Also:

    • identityEquals

      protected boolean identityEquals(Identity identity)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tests for equality between the specifiedIdentity and thisIdentity. This method should be overridden by subclasses to test for equality. The default behavior is to returntrue if the names and public keys are equal.
      Parameters:
      identity - the identity to test for equality with thisidentity.
      Returns:
      true if the identities are considered equal,false otherwise.
      See Also:

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a short string describing thisIdentity, telling its name and its scope (if any).
      Specified by:
      toString in interface Principal
      Overrides:
      toString in class Object
      Returns:
      information about thisIdentity, such as its name and the name of its scope (if any).

    • toString

      public String toString(boolean detailed)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a string representation of thisIdentity, with optionally more details than that provided by thetoString method without any arguments.
      Parameters:
      detailed - whether or not to provide detailed information.
      Returns:
      information about thisIdentity. Ifdetailed istrue, then this method returns more information than that provided by thetoString method without any arguments.
      See Also:

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the hashcode for thisIdentity.
      Specified by:
      hashCode in interface Principal
      Overrides:
      hashCode in class Object
      Returns:
      the hashcode for thisIdentity
      See Also: