This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.security
class Signer

java.lang.Object extended by java.security.Identity extended by java.security.Signer
All Implemented Interfaces:
Serializable, Principal
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.

Constructor Summary
protected
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.
 void
setKeyPair(KeyPair pair)

          Sets the key pair (public key and private key) for this signer.
 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 Detail

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 Detail

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.

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.

toString

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

Overrides:
toString in class Identity
Returns:
a string of information about the signer.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.