java.security

Class Signer

Implemented Interfaces:
Principal, Serializable

public abstract class Signer
extends Identity

This class is used to represent an Identity that can also digitally sign data.

The management of a signer's private keys is an important and sensitive issue that should be handled by subclasses as appropriate to their intended use.

See Also:
Serialized Form

Constructor Summary

Signer()
Creates a Signer.
Signer(String name)
Creates a Signer with the specified identity name.
Signer(String name, IdentityScope scope)
Creates a Signer with the specified identity name and scope.

Method Summary

PrivateKey
getPrivateKey()
Returns this signer's private key.

First, if there is a security manager, its checkSecurityAccess() method is called with "getSignerPrivateKey" as its argument to see if it's ok to return the private key.

void
setKeyPair(KeyPair pair)
Sets the key pair (public key and private key) for this signer.

First, if there is a security manager, its checkSecurityAccess() method is called with "setSignerKeyPair" as its argument to see if it's ok to set the key pair.

String
toString()
Returns a string of information about the signer.

Methods inherited from class java.security.Identity

addCertificate, certificates, equals, getInfo, getName, getPublicKey, getScope, hashCode, identityEquals, removeCertificate, setInfo, setPublicKey, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Signer

protected Signer()
Creates a Signer. This constructor should only be used for serialization.

Signer

public Signer(String name)
Creates a Signer with the specified identity name.
Parameters:
name - the identity name.

Signer

public Signer(String name,
              IdentityScope scope)
            throws KeyManagementException
Creates a Signer with the specified identity name and scope.
Parameters:
name - the identity name.
scope - the scope of the identity.
Throws:
KeyManagementException - if there is already an identity with the same name in the scope.

Method Details

getPrivateKey

public PrivateKey getPrivateKey()
Returns this signer's private key.

First, if there is a security manager, its checkSecurityAccess() method is called with "getSignerPrivateKey" as its argument to see if it's ok to return the private key.

Returns:
this signer's private key, or null if the private key has not yet been set.
Throws:
SecurityException - if a security manager exists and its checkSecurityAccess() method doesn't allow returning the private key.

setKeyPair

public final void setKeyPair(KeyPair pair)
            throws InvalidParameterException,
                   KeyException
Sets the key pair (public key and private key) for this signer.

First, if there is a security manager, its checkSecurityAccess() method is called with "setSignerKeyPair" as its argument to see if it's ok to set the key pair.

Parameters:
pair - an initialized key pair.
Throws:
InvalidParameterException - if the key pair is not properly initialized.
KeyException - if the key pair cannot be set for any other reason.
SecurityException - if a security manager exists and its checkSecurityAccess() method doesn't allow setting the key pair.

toString

public String toString()
Returns a string of information about the signer.
Specified by:
toString in interface Principal
Overrides:
toString in interface Identity
Returns:
a string of information about the signer.

Signer.java --- Signer 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.