Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.security

Class Identity

Implemented Interfaces:
Principal, Serializable
Known Direct Subclasses:
IdentityScope, Signer
public abstract class Identity
extends Object
implements Principal, Serializable
The Identity class is used to represent people and companies that can be authenticated using public key encryption. The identities can also be abstract objects such as smart cards.

Identity objects store a name and public key for each identity. The names cannot be changed and the identities can be scoped. Each identity (name and public key) within a scope are unique to that scope.

Each identity has a set of ceritificates which all specify the same public key, but not necessarily the same name.

The Identity class can be subclassed to allow additional information to be attached to it.

See Also:
IdentityScope, Signer, Principal, Serialized Form

Constructor Summary

Identity()
Constructor for serialization only.
Identity(String name)
Constructs a new instance of Identity with the specified name and no scope.
Identity(String name, IdentityScope scope)
Constructs a new instance of Identity with the specified name and scope.

Method Summary

void
addCertificate(Certificate certificate)
Adds a certificate to the list of ceritificates for this identity.
Certificate[]
certificates()
boolean
equals(Object identity)
Checks for equality between this Identity and a specified object.
String
getInfo()
String
getName()
PublicKey
getPublicKey()
IdentityScope
getScope()
int
hashCode()
protected boolean
identityEquals(Identity identity)
Checks for equality between this Identity and a specified object.
void
removeCertificate(Certificate certificate)
Removes a certificate from the list of ceritificates for this identity.
void
setInfo(String info)
Sets the general information string.
void
setPublicKey(PublicKey key)
Sets the public key for this identity.
String
toString()
Returns a string representation of this Identity.
String
toString(boolean detailed)
Returns a detailed string representation of this Identity.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Identity

protected Identity()
Constructor for serialization only.

Identity

public Identity(String name)
Constructs a new instance of Identity with the specified name and no scope.
Parameters:
name - the name to use.

Identity

public Identity(String name,
                IdentityScope scope)
            throws KeyManagementException
Constructs a new instance of Identity with the specified name and scope.
Parameters:
name - the name to use.
scope - the scope to use.
Throws:
KeyManagementException - if the identity is already present.

Method Details

addCertificate

public void addCertificate(Certificate certificate)
            throws KeyManagementException
Adds a certificate to the list of ceritificates for this identity. The public key in this certificate must match the existing public key if it exists.
Parameters:
certificate - the certificate to add.
Throws:
KeyManagementException - if the certificate is invalid, or the public key conflicts.
SecurityException - if a SecurityManager is installed which disallows this operation.

certificates

public Certificate[] certificates()
Returns:
an array of Certificates for this identity.

equals

public final boolean equals(Object identity)
Checks for equality between this Identity and a specified object. It first checks if they are the same object, then if the name and scope match and returns true if successful. If these tests fail, the identityEquals(Identity) method is called.
Specified by:
equals in interface Principal
Overrides:
equals in interface Object
Returns:
true if they are equal, false otherwise.

getInfo

public String getInfo()
Returns:
the general information string of this identity.
See Also:
setInfo(String)

getName

public final String getName()
Specified by:
getName in interface Principal
Returns:
the name of this identity.

getPublicKey

public PublicKey getPublicKey()
Returns:
the public key of this identity.
See Also:
setPublicKey(PublicKey)

getScope

public final IdentityScope getScope()
Returns:
the scope of this identity.

hashCode

public int hashCode()
Specified by:
hashCode in interface Principal
Overrides:
hashCode in interface Object
Returns:
a hashcode of this identity.

identityEquals

protected boolean identityEquals(Identity identity)
Checks for equality between this Identity and a specified object. A subclass should override this method. The default behavior is to return true if the public key and names match.
Returns:
true if they are equal, false otherwise.

removeCertificate

public void removeCertificate(Certificate certificate)
            throws KeyManagementException
Removes a certificate from the list of ceritificates for this identity.
Parameters:
certificate - the certificate to remove.
Throws:
KeyManagementException - if the certificate is invalid.
SecurityException - if a SecurityManager is installed which disallows this operation.

setInfo

public void setInfo(String info)
Sets the general information string.
Parameters:
info - the general information string.
Throws:
SecurityException - if a SecurityManager is installed which disallows this operation.

setPublicKey

public void setPublicKey(PublicKey key)
            throws KeyManagementException
Sets the public key for this identity. The old key and all certificates are removed.
Parameters:
key - the public key to use.
Throws:
KeyManagementException - if this public key is used by another identity in the current scope.
SecurityException - if a SecurityManager is installed which disallows this operation.

toString

public String toString()
Returns a string representation of this Identity.
Specified by:
toString in interface Principal
Overrides:
toString in interface Object
Returns:
a string representation of this Identity.
Throws:
SecurityException - if a SecurityManager is installed which disallows this operation.

toString

public String toString(boolean detailed)
Returns a detailed string representation of this Identity.
Parameters:
detailed - indicates whether or detailed information is desired.
Returns:
a string representation of this Identity.
Throws:
SecurityException - if a SecurityManager is installed which disallows this operation.
Identity.java --- Identity Class Copyright (C) 1999, 2003, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About