javax.xml.crypto.dsig.SignatureMethod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.xmlsec
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar file.
The newest version!
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
/*
 * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
 */
/*
 * $Id: SignatureMethod.java 1333869 2012-05-04 10:42:44Z coheigea $
 */
package javax.xml.crypto.dsig;

import javax.xml.crypto.AlgorithmMethod;
import javax.xml.crypto.XMLStructure;
import java.security.spec.AlgorithmParameterSpec;

/**
 * A representation of the XML SignatureMethod element 
 * as defined in the 
 * W3C Recommendation for XML-Signature Syntax and Processing.
 * The XML Schema Definition is defined as:
 * 
 * 
 *   <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>
 * 
 *
 * A SignatureMethod 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
 * @see XMLSignatureFactory#newSignatureMethod(String, SignatureMethodParameterSpec)
 */
public interface SignatureMethod extends XMLStructure, AlgorithmMethod {

    /**
     * The DSAwithSHA1
     * (DSS) signature method algorithm URI.
     */
    String DSA_SHA1 =
        "http://www.w3.org/2000/09/xmldsig#dsa-sha1";

    /**
     * The RSAwithSHA1
     * (PKCS #1) signature method algorithm URI.
     */
    String RSA_SHA1 = 
        "http://www.w3.org/2000/09/xmldsig#rsa-sha1";

    /**
     * The HMAC-SHA1
     * MAC signature method algorithm URI 
     */
    String HMAC_SHA1 =
        "http://www.w3.org/2000/09/xmldsig#hmac-sha1";

    /**
     * Returns the algorithm-specific input parameters of this  
     * SignatureMethod.
     *
     * The returned parameters can be typecast to a {@link
     * javax.xml.crypto.dsig.spec.SignatureMethodParameterSpec} object.
     *
     * @return the algorithm-specific input parameters of this 
     *    SignatureMethod (may be null if not 
     *    specified)
     */
    AlgorithmParameterSpec getParameterSpec();
}