/*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
*/
/*
* $Id: SignatureMethod.java,v 1.5 2005/05/10 16:03:46 mullan Exp $
*/
package javax.xml.crypto.dsig;
import javax.xml.crypto.AlgorithmMethod;
import javax.xml.crypto.XMLStructure;
import javax.xml.crypto.dsig.spec.SignatureMethodParameterSpec;
import java.security.spec.AlgorithmParameterSpec;
/**
* A representation of the XML <code>SignatureMethod</code> element
* as defined in the <a href="http://www.w3.org/TR/xmldsig-core/">
* W3C Recommendation for XML-Signature Syntax and Processing</a>.
* The XML Schema Definition is defined as:
* <p>
* <pre>
* <element name="SignatureMethod" type="ds:SignatureMethodType"/>
* <complexType name="SignatureMethodType" mixed="true">
* <sequence>
* <element name="HMACOutputLength" minOccurs="0" type="ds:HMACOutputLengthType"/>
* <any namespace="##any" minOccurs="0" maxOccurs="unbounded"/>
* <!-- (0,unbounded) elements from (1,1) namespace -->
* </sequence>
* <attribute name="Algorithm" type="anyURI" use="required"/>
* </complexType>
* </pre>
*
* A <code>SignatureMethod</code> instance may be created by invoking the
* {@link XMLSignatureFactory#newSignatureMethod newSignatureMethod} method
* of the {@link XMLSignatureFactory} class.
*
* @author Sean Mullan
* @author JSR 105 Expert Group
* @since 1.6
* @see XMLSignatureFactory#newSignatureMethod(String, SignatureMethodParameterSpec)
*/
public interface SignatureMethod extends XMLStructure, AlgorithmMethod {
/**
* The <a href="http://www.w3.org/2000/09/xmldsig#dsa-sha1">DSAwithSHA1</a>
* (DSS) signature method algorithm URI.
*/
static final String DSA_SHA1 =
"http://www.w3.org/2000/09/xmldsig#dsa-sha1";
/**
* The <a href="http://www.w3.org/2000/09/xmldsig#rsa-sha1">RSAwithSHA1</a>
* (PKCS #1) signature method algorithm URI.
*/
static final String RSA_SHA1 =
"http://www.w3.org/2000/09/xmldsig#rsa-sha1";
/**
* The <a href="http://www.w3.org/2000/09/xmldsig#hmac-sha1">HMAC-SHA1</a>
* MAC signature method algorithm URI
*/
static final String HMAC_SHA1 =
"http://www.w3.org/2000/09/xmldsig#hmac-sha1";
/**
* Returns the algorithm-specific input parameters of this
* <code>SignatureMethod</code>.
*
* <p>The returned parameters can be typecast to a {@link
* SignatureMethodParameterSpec} object.
*
* @return the algorithm-specific input parameters of this
* <code>SignatureMethod</code> (may be <code>null</code> if not
* specified)
*/
AlgorithmParameterSpec getParameterSpec();
}