APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xml.internal.security.algorithms

public Class SignatureAlgorithm

extends Algorithm
Class Inheritance
Imports
java.lang.reflect.Constructor, .InvocationTargetException, java.security.Key, .Provider, .SecureRandom, java.security.spec.AlgorithmParameterSpec, java.util.Map, java.util.concurrent.ConcurrentHashMap, com.sun.org.apache.xml.internal.security.algorithms.implementations.IntegrityHmac, .SignatureBaseRSA, .SignatureDSA, .SignatureECDSA, .SignatureEDDSA, com.sun.org.apache.xml.internal.security.exceptions.AlgorithmAlreadyRegisteredException, .XMLSecurityException, com.sun.org.apache.xml.internal.security.signature.XMLSignature, .XMLSignatureException, com.sun.org.apache.xml.internal.security.utils.Constants, .JavaUtils, org.w3c.dom.Attr, .Document, .Element
Allows selection of digital signature's algorithm, private keys, other security parameters, and algorithm's ID.

Field Summary

Modifier and TypeField and Description
private static Map<String, Class<? extends SignatureAlgorithmSpi>>
algorithmHash

All available algorithm classes are registered here

private final String
algorithmURI

private static final Logger
LOG

Hides com.sun.org.apache.xml.internal.security.utils.ElementProxy.LOG.

private final SignatureAlgorithmSpi
signatureAlgorithmSpi

Field signatureAlgorithm

Constructor Summary

AccessConstructor and Description
public
SignatureAlgorithm(Document doc, String algorithmURI)

Constructor SignatureAlgorithm

public
SignatureAlgorithm(Document doc, String algorithmURI, Provider provider)

public
SignatureAlgorithm(Document doc, String algorithmURI, Provider provider, AlgorithmParameterSpec parameterSpec)

public
SignatureAlgorithm(Document doc, String algorithmURI, int hmacOutputLength)

Constructor SignatureAlgorithm

public
SignatureAlgorithm(Document doc, String algorithmURI, int hmacOutputLength, Provider provider)

public
SignatureAlgorithm(Element element, String baseURI)

Constructor SignatureAlgorithm

public
SignatureAlgorithm(Element element, String baseURI, Provider provider)

public
SignatureAlgorithm(Element element, String baseURI, boolean secureValidation)

Constructor SignatureAlgorithm

public
SignatureAlgorithm(Element element, String baseURI, boolean secureValidation, Provider provider)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

Local name
getBaseLocalName()

Implements abstract com.sun.org.apache.xml.internal.security.utils.ElementProxy.getBaseLocalName.

Method getBaseLocalName

public String

Returns:

URI of this element
getBaseNamespace()

Overrides com.sun.org.apache.xml.internal.security.utils.SignatureElementProxy.getBaseNamespace.

Method getBaseNamespace

public String

Returns:

the result of the java.security.Signature#getAlgorithm method
getJCEAlgorithmString()

Proxy method for java.security.Signature#getAlgorithm which is executed on the internal java.security.Signature object.

public String

Returns:

The Provider of this Signature Algorithm
getJCEProviderName()

Method getJCEProviderName

private static SignatureAlgorithmSpi
getSignatureAlgorithmSpi(String algorithmURI, Provider provider)

Get a SignatureAlgorithmSpi object corresponding to the algorithmURI argument

public final String

Returns:

the URI representation of Transformation algorithm
getURI()

Returns the URI representation of Transformation algorithm

public void
initSign(Key signingKey)

Proxy method for java.security.Signature#initSign(java.security.PrivateKey) which is executed on the internal java.security.Signature object.

public void
initSign(Key signingKey, SecureRandom secureRandom)

Proxy method for java.security.Signature#initSign(java.security.PrivateKey, java.security.SecureRandom) which is executed on the internal java.security.Signature object.

public void
initSign(Key signingKey, AlgorithmParameterSpec algorithmParameterSpec)

Proxy method for java.security.Signature#initSign(java.security.PrivateKey) which is executed on the internal java.security.Signature object.

public void
initVerify(Key verificationKey)

Proxy method for java.security.Signature#initVerify(java.security.PublicKey) which is executed on the internal java.security.Signature object.

public static void
register(String
algorithmURI URI representation of SignatureAlgorithm.
algorithmURI, String
implementingClass the implementing class of SignatureAlgorithmSpi
implementingClass)

Registers implementing class of the SignatureAlgorithm with algorithmURI

public static void
register(String
algorithmURI URI representation of SignatureAlgorithm.
algorithmURI, Class<? extends SignatureAlgorithmSpi>
implementingClass the implementing class of SignatureAlgorithmSpi
implementingClass)

Registers implementing class of the SignatureAlgorithm with algorithmURI

public static void
registerDefaultAlgorithms()

This method registers the default algorithms.

public void
setParameter(AlgorithmParameterSpec params)

Proxy method for java.security.Signature#setParameter( java.security.spec.AlgorithmParameterSpec) which is executed on the internal java.security.Signature object.

public byte[]

Returns:

the result of the java.security.Signature#sign() method
sign()

Proxy method for java.security.Signature#sign() which is executed on the internal java.security.Signature object.

public void
update(byte[] input)

Proxy method for java.security.Signature#update(byte[]) which is executed on the internal java.security.Signature object.

public void
update(byte input)

Proxy method for java.security.Signature#update(byte) which is executed on the internal java.security.Signature object.

public void
update(byte[] buf, int offset, int len)

Proxy method for java.security.Signature#update(byte[], int, int) which is executed on the internal java.security.Signature object.

public boolean

Returns:

true if the signature is valid.
verify(byte[] signature)

Proxy method for java.security.Signature#verify(byte[]) which is executed on the internal java.security.Signature object.

Inherited from com.sun.org.apache.xml.internal.security.algorithms.Algorithm:
getAlgorithmURIsetAlgorithmURI

Field Detail

algorithmHashback to summary
private static Map<String, Class<? extends SignatureAlgorithmSpi>> algorithmHash

All available algorithm classes are registered here

algorithmURIback to summary
private final String algorithmURI
LOGback to summary
private static final Logger LOG

Hides com.sun.org.apache.xml.internal.security.utils.ElementProxy.LOG.

signatureAlgorithmSpiback to summary
private final SignatureAlgorithmSpi signatureAlgorithmSpi

Field signatureAlgorithm

Constructor Detail

SignatureAlgorithmback to summary
public SignatureAlgorithm(Document doc, String algorithmURI) throws XMLSecurityException

Constructor SignatureAlgorithm

SignatureAlgorithmback to summary
public SignatureAlgorithm(Document doc, String algorithmURI, Provider provider) throws XMLSecurityException
SignatureAlgorithmback to summary
public SignatureAlgorithm(Document doc, String algorithmURI, Provider provider, AlgorithmParameterSpec parameterSpec) throws XMLSecurityException
SignatureAlgorithmback to summary
public SignatureAlgorithm(Document doc, String algorithmURI, int hmacOutputLength) throws XMLSecurityException

Constructor SignatureAlgorithm

SignatureAlgorithmback to summary
public SignatureAlgorithm(Document doc, String algorithmURI, int hmacOutputLength, Provider provider) throws XMLSecurityException
SignatureAlgorithmback to summary
public SignatureAlgorithm(Element element, String baseURI) throws XMLSecurityException

Constructor SignatureAlgorithm

SignatureAlgorithmback to summary
public SignatureAlgorithm(Element element, String baseURI, Provider provider) throws XMLSecurityException
SignatureAlgorithmback to summary
public SignatureAlgorithm(Element element, String baseURI, boolean secureValidation) throws XMLSecurityException

Constructor SignatureAlgorithm

SignatureAlgorithmback to summary
public SignatureAlgorithm(Element element, String baseURI, boolean secureValidation, Provider provider) throws XMLSecurityException

Method Detail

getBaseLocalNameback to summary
public String getBaseLocalName()

Implements abstract com.sun.org.apache.xml.internal.security.utils.ElementProxy.getBaseLocalName.

Method getBaseLocalName

Returns:String

Local name

Annotations
@Override
getBaseNamespaceback to summary
public String getBaseNamespace()

Overrides com.sun.org.apache.xml.internal.security.utils.SignatureElementProxy.getBaseNamespace.

Method getBaseNamespace

Returns:String

URI of this element

Annotations
@Override
getJCEAlgorithmStringback to summary
public String getJCEAlgorithmString()

Proxy method for java.security.Signature#getAlgorithm which is executed on the internal java.security.Signature object.

Returns:String

the result of the java.security.Signature#getAlgorithm method

getJCEProviderNameback to summary
public String getJCEProviderName()

Method getJCEProviderName

Returns:String

The Provider of this Signature Algorithm

getSignatureAlgorithmSpiback to summary
private static SignatureAlgorithmSpi getSignatureAlgorithmSpi(String algorithmURI, Provider provider) throws XMLSignatureException

Get a SignatureAlgorithmSpi object corresponding to the algorithmURI argument

getURIback to summary
public final String getURI()

Returns the URI representation of Transformation algorithm

Returns:String

the URI representation of Transformation algorithm

initSignback to summary
public void initSign(Key signingKey) throws XMLSignatureException

Proxy method for java.security.Signature#initSign(java.security.PrivateKey) which is executed on the internal java.security.Signature object.

initSignback to summary
public void initSign(Key signingKey, SecureRandom secureRandom) throws XMLSignatureException

Proxy method for java.security.Signature#initSign(java.security.PrivateKey, java.security.SecureRandom) which is executed on the internal java.security.Signature object.

initSignback to summary
public void initSign(Key signingKey, AlgorithmParameterSpec algorithmParameterSpec) throws XMLSignatureException

Proxy method for java.security.Signature#initSign(java.security.PrivateKey) which is executed on the internal java.security.Signature object.

initVerifyback to summary
public void initVerify(Key verificationKey) throws XMLSignatureException

Proxy method for java.security.Signature#initVerify(java.security.PublicKey) which is executed on the internal java.security.Signature object.

registerback to summary
public static void register(String algorithmURI, String implementingClass) throws AlgorithmAlreadyRegisteredException, ClassNotFoundException, XMLSignatureException

Registers implementing class of the SignatureAlgorithm with algorithmURI

Parameters
algorithmURI:String

algorithmURI URI representation of SignatureAlgorithm.

implementingClass:String

implementingClass the implementing class of SignatureAlgorithmSpi

Annotations
@SuppressWarnings:unchecked
Exceptions
AlgorithmAlreadyRegisteredException:
if specified algorithmURI is already registered
SecurityException:
if a security manager is installed and the caller does not have permission to register the signature algorithm
registerback to summary
public static void register(String algorithmURI, Class<? extends SignatureAlgorithmSpi> implementingClass) throws AlgorithmAlreadyRegisteredException, ClassNotFoundException, XMLSignatureException

Registers implementing class of the SignatureAlgorithm with algorithmURI

Parameters
algorithmURI:String

algorithmURI URI representation of SignatureAlgorithm.

implementingClass:Class<? extends SignatureAlgorithmSpi>

implementingClass the implementing class of SignatureAlgorithmSpi

Exceptions
AlgorithmAlreadyRegisteredException:
if specified algorithmURI is already registered
SecurityException:
if a security manager is installed and the caller does not have permission to register the signature algorithm
registerDefaultAlgorithmsback to summary
public static void registerDefaultAlgorithms()

This method registers the default algorithms.

setParameterback to summary
public void setParameter(AlgorithmParameterSpec params) throws XMLSignatureException

Proxy method for java.security.Signature#setParameter( java.security.spec.AlgorithmParameterSpec) which is executed on the internal java.security.Signature object.

signback to summary
public byte[] sign() throws XMLSignatureException

Proxy method for java.security.Signature#sign() which is executed on the internal java.security.Signature object.

Returns:byte[]

the result of the java.security.Signature#sign() method

updateback to summary
public void update(byte[] input) throws XMLSignatureException

Proxy method for java.security.Signature#update(byte[]) which is executed on the internal java.security.Signature object.

updateback to summary
public void update(byte input) throws XMLSignatureException

Proxy method for java.security.Signature#update(byte) which is executed on the internal java.security.Signature object.

updateback to summary
public void update(byte[] buf, int offset, int len) throws XMLSignatureException

Proxy method for java.security.Signature#update(byte[], int, int) which is executed on the internal java.security.Signature object.

verifyback to summary
public boolean verify(byte[] signature) throws XMLSignatureException

Proxy method for java.security.Signature#verify(byte[]) which is executed on the internal java.security.Signature object.

Returns:boolean

true if the signature is valid.