Serializable
, Principal
IdentityScope
, Signer
KeyStore
, the
java.security.cert
package, and
Principal
.
This class is subject to removal in a future version of Java SE.@Deprecated(since="1.2", forRemoval=true) public abstract class Identity extends Object implements Principal, Serializable
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.
All Identity objects have a name and a public key. Names are immutable. Identities may also be scoped. That is, if an Identity is specified to have a particular scope, then the name and public key of the Identity are unique within that scope.
An Identity 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.
An Identity can be subclassed, to include postal and email addresses, telephone numbers, images of faces and logos, and so on.
IdentityScope
,
Signer
,
Principal
,
Serialized FormModifier | Constructor | Description |
---|---|---|
protected |
Identity() |
Deprecated, for removal: This API element is subject to removal in a future version.
Constructor for serialization only.
|
|
Identity(String name) |
Deprecated, for removal: This API element is subject to removal in a future version.
Constructs an identity with the specified name and no scope.
|
|
Identity(String name,
IdentityScope scope) |
Deprecated, for removal: This API element is subject to removal in a future version.
Constructs an identity with the specified name and scope.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addCertificate(Certificate certificate) |
Deprecated, for removal: This API element is subject to removal in a future version.
Adds a certificate for this identity.
|
Certificate[] |
certificates() |
Deprecated, for removal: This API element is subject to removal in a future version.
Returns a copy of all the certificates for this identity.
|
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 this identity.
|
String |
getInfo() |
Deprecated, for removal: This API element is subject to removal in a future version.
Returns general information previously specified for this identity.
|
String |
getName() |
Deprecated, for removal: This API element is subject to removal in a future version.
Returns this identity's name.
|
PublicKey |
getPublicKey() |
Deprecated, for removal: This API element is subject to removal in a future version.
Returns this identity's public key.
|
IdentityScope |
getScope() |
Deprecated, for removal: This API element is subject to removal in a future version.
Returns this identity's scope.
|
int |
hashCode() |
Deprecated, for removal: This API element is subject to removal in a future version.
Returns a hashcode for this identity.
|
protected boolean |
identityEquals(Identity identity) |
Deprecated, for removal: This API element is subject to removal in a future version.
Tests for equality between the specified identity and this identity.
|
void |
removeCertificate(Certificate certificate) |
Deprecated, for removal: This API element is subject to removal in a future version.
Removes a certificate from this identity.
|
void |
setInfo(String info) |
Deprecated, for removal: This API element is subject to removal in a future version.
Specifies a general information string for this identity.
|
void |
setPublicKey(PublicKey key) |
Deprecated, for removal: This API element is subject to removal in a future version.
Sets this identity's public key.
|
String |
toString() |
Deprecated, for removal: This API element is subject to removal in a future version.
Returns a short string describing this identity, telling its
name and its scope (if any).
|
String |
toString(boolean detailed) |
Deprecated, for removal: This API element is subject to removal in a future version.
Returns a string representation of this identity, with
optionally more details than that provided by the
toString method without any arguments. |
protected Identity()
public Identity(String name, IdentityScope scope) throws KeyManagementException
name
- the identity name.scope
- the scope of the identity.KeyManagementException
- if there is already an identity
with the same name in the scope.public Identity(String name)
name
- the identity name.public final String getName()
public final IdentityScope getScope()
public PublicKey getPublicKey()
setPublicKey(java.security.PublicKey)
public void setPublicKey(PublicKey key) throws KeyManagementException
First, if there is a security manager, its checkSecurityAccess
method is called with "setIdentityPublicKey"
as its argument to see if it's ok to set the public key.
key
- the public key for this identity.KeyManagementException
- if another identity in the
identity's scope has the same public key, or if another exception occurs.SecurityException
- if a security manager exists and its
checkSecurityAccess
method doesn't allow
setting the public key.getPublicKey()
,
SecurityManager.checkSecurityAccess(java.lang.String)
public void setInfo(String info)
First, if there is a security manager, its checkSecurityAccess
method is called with "setIdentityInfo"
as its argument to see if it's ok to specify the information string.
info
- the information string.SecurityException
- if a security manager exists and its
checkSecurityAccess
method doesn't allow
setting the information string.getInfo()
,
SecurityManager.checkSecurityAccess(java.lang.String)
public String getInfo()
setInfo(java.lang.String)
public void addCertificate(Certificate certificate) throws KeyManagementException
First, if there is a security manager, its checkSecurityAccess
method is called with "addIdentityCertificate"
as its argument to see if it's ok to add a certificate.
certificate
- the certificate to be added.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.SecurityException
- if a security manager exists and its
checkSecurityAccess
method doesn't allow
adding a certificate.SecurityManager.checkSecurityAccess(java.lang.String)
public void removeCertificate(Certificate certificate) throws KeyManagementException
First, if there is a security manager, its checkSecurityAccess
method is called with "removeIdentityCertificate"
as its argument to see if it's ok to remove a certificate.
certificate
- the certificate to be removed.KeyManagementException
- if the certificate is
missing, or if another exception occurs.SecurityException
- if a security manager exists and its
checkSecurityAccess
method doesn't allow
removing a certificate.SecurityManager.checkSecurityAccess(java.lang.String)
public Certificate[] certificates()
public final boolean equals(Object identity)
identityEquals
, which subclasses should
override.equals
in interface Principal
equals
in class Object
identity
- the object to test for equality with this identity.identityEquals(java.security.Identity)
protected boolean identityEquals(Identity identity)
identity
- the identity to test for equality with this identity.equals(java.lang.Object)
public String toString()
First, if there is a security manager, its checkSecurityAccess
method is called with "printIdentity"
as its argument to see if it's ok to return the string.
toString
in interface Principal
toString
in class Object
SecurityException
- if a security manager exists and its
checkSecurityAccess
method doesn't allow
returning a string describing this identity.SecurityManager.checkSecurityAccess(java.lang.String)
public String toString(boolean detailed)
toString
method without any arguments.
First, if there is a security manager, its checkSecurityAccess
method is called with "printIdentity"
as its argument to see if it's ok to return the string.
detailed
- whether or not to provide detailed information.detailed
is true, then this method returns more information than that
provided by the toString
method without any arguments.SecurityException
- if a security manager exists and its
checkSecurityAccess
method doesn't allow
returning a string describing this identity.toString()
,
SecurityManager.checkSecurityAccess(java.lang.String)
public int hashCode()
hashCode
in interface Principal
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-Ubuntu+0-9b154-1