Identity
abstract classIdentity: Principal, Serializable
kotlin.Any | |
↳ | java.security.Identity |
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.
Summary
Public constructors | |
---|---|
Identity(name: String!, scope: IdentityScope!) Constructs an identity with the specified name and scope. |
|
Constructs an identity with the specified name and no scope. |
Protected constructors | |
---|---|
Identity() Constructor for serialization only. |
Public methods | |
---|---|
open Unit |
addCertificate(certificate: Certificate!) Adds a certificate for this identity. |
open Array<Certificate!>! |
Returns a copy of all the certificates for this identity. |
Boolean |
Tests for equality between the specified object and this identity. |
open String! |
getInfo() Returns general information previously specified for this identity. |
String! |
getName() Returns this identity's name. |
open PublicKey! |
Returns this identity's public key. |
IdentityScope! |
getScope() Returns this identity's scope. |
open Int |
hashCode() Returns a hashcode for this identity. |
open Unit |
removeCertificate(certificate: Certificate!) Removes a certificate from this identity. |
open Unit |
Specifies a general information string for this identity. |
open Unit |
setPublicKey(key: PublicKey!) Sets this identity's public key. |
open String |
toString() Returns a short string describing this identity, telling its name and its scope (if any). |
open String! |
Returns a string representation of this identity, with optionally more details than that provided by the |
Protected methods | |
---|---|
open Boolean |
identityEquals(identity: Identity!) Tests for equality between the specified identity and this identity. |
Inherited functions | |
---|---|
Public constructors
Identity
Identity(
name: String!,
scope: IdentityScope!)
Constructs an identity with the specified name and scope.
Parameters | |
---|---|
name |
String!: the identity name. |
scope |
IdentityScope!: the scope of the identity. |
Exceptions | |
---|---|
java.security.KeyManagementException |
if there is already an identity with the same name in the scope. |
Identity
Identity(name: String!)
Constructs an identity with the specified name and no scope.
Parameters | |
---|---|
name |
String!: the identity name. |
Protected constructors
Public methods
addCertificate
open funaddCertificate(certificate: Certificate!): Unit
Deprecated: Deprecated in Java.
Adds a certificate for this identity. If the identity has a public key, the public key in the certificate must be the same, and if the identity does not have a public key, the identity's public key is set to be that specified in the certificate.
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.
Parameters | |
---|---|
certificate |
Certificate!: the certificate to be added. |
Exceptions | |
---|---|
java.security.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. |
java.lang.SecurityException |
if a security manager exists and its checkSecurityAccess method doesn't allow adding a certificate. |
certificates
open funcertificates(): Array<Certificate!>!
Deprecated: Deprecated in Java.
Returns a copy of all the certificates for this identity.
Return | |
---|---|
Array<Certificate!>! |
a copy of all the certificates for this identity. |
equals
funequals(other: Any?): Boolean
Deprecated: Deprecated in Java.
Tests for equality between the specified object and this identity. This first tests to see if the entities actually refer to the same object, in which case it returns true. Next, it checks to see if the entities have the same name and the same scope. If they do, the method returns true. Otherwise, it calls identityEquals
, which subclasses should override.
Parameters | |
---|---|
obj |
the reference object with which to compare. |
another |
principal to compare with. |
identity |
the object to test for equality with this identity. |
Return | |
---|---|
Boolean |
true if the objects are considered equal, false otherwise. |
See Also
getInfo
open fungetInfo(): String!
Deprecated: Deprecated in Java.
Returns general information previously specified for this identity.
Return | |
---|---|
String! |
general information about this identity. |
See Also
getName
fungetName(): String!
Deprecated: Deprecated in Java.
Returns this identity's name.
Return | |
---|---|
String! |
the name of this identity. |
getPublicKey
open fungetPublicKey(): PublicKey!
Deprecated: Deprecated in Java.
Returns this identity's public key.
Return | |
---|---|
PublicKey! |
the public key for this identity. |
See Also
getScope
fungetScope(): IdentityScope!
Deprecated: Deprecated in Java.
Returns this identity's scope.
Return | |
---|---|
IdentityScope! |
the scope of this identity. |
hashCode
open funhashCode(): Int
Deprecated: Deprecated in Java.
Returns a hashcode for this identity.
Return | |
---|---|
Int |
a hashcode for this identity. |
removeCertificate
open funremoveCertificate(certificate: Certificate!): Unit
Deprecated: Deprecated in Java.
Removes a certificate from this identity.
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.
Parameters | |
---|---|
certificate |
Certificate!: the certificate to be removed. |
Exceptions | |
---|---|
java.security.KeyManagementException |
if the certificate is missing, or if another exception occurs. |
java.lang.SecurityException |
if a security manager exists and its checkSecurityAccess method doesn't allow removing a certificate. |
setInfo
open funsetInfo(info: String!): Unit
Deprecated: Deprecated in Java.
Specifies a general information string for this identity.
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.
Parameters | |
---|---|
info |
String!: the information string. |
Exceptions | |
---|---|
java.lang.SecurityException |
if a security manager exists and its checkSecurityAccess method doesn't allow setting the information string. |
setPublicKey
open funsetPublicKey(key: PublicKey!): Unit
Deprecated: Deprecated in Java.
Sets this identity's public key. The old key and all of this identity's certificates are removed by this operation.
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.
Parameters | |
---|---|
key |
PublicKey!: the public key for this identity. |
Exceptions | |
---|---|
java.security.KeyManagementException |
if another identity in the identity's scope has the same public key, or if another exception occurs. |
java.lang.SecurityException |
if a security manager exists and its checkSecurityAccess method doesn't allow setting the public key. |
toString
open funtoString(): String
Deprecated: Deprecated in Java.
Returns a short string describing this identity, telling its name and its scope (if any).
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.
Return | |
---|---|
String |
information about this identity, such as its name and the name of its scope (if any). |
Exceptions | |
---|---|
java.lang.SecurityException |
if a security manager exists and its checkSecurityAccess method doesn't allow returning a string describing this identity. |
toString
open funtoString(detailed: Boolean): String!
Deprecated: Deprecated in Java.
Returns a string representation of this identity, with optionally more details than that provided by the 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.
Parameters | |
---|---|
detailed |
Boolean: whether or not to provide detailed information. |
Return | |
---|---|
String! |
information about this identity. If detailed is true, then this method returns more information than that provided by the toString method without any arguments. |
Exceptions | |
---|---|
java.lang.SecurityException |
if a security manager exists and its checkSecurityAccess method doesn't allow returning a string describing this identity. |
Protected methods
identityEquals
protected open funidentityEquals(identity: Identity!): Boolean
Deprecated: Deprecated in Java.
Tests for equality between the specified identity and this identity. This method should be overriden by subclasses to test for equality. The default behavior is to return true if the names and public keys are equal.
Parameters | |
---|---|
identity |
Identity!: the identity to test for equality with this identity. |
Return | |
---|---|
Boolean |
true if the identities are considered equal, false otherwise. |
See Also