Save This Page
Home » openjdk-7 » javax » xml » crypto » dsig » [javadoc | source]
    1   /*
    2    * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Oracle designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Oracle in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   22    * or visit www.oracle.com if you need additional information or have any
   23    * questions.
   24    */
   25   /*
   26    * $Id: DigestMethod.java,v 1.6 2005/05/10 16:03:46 mullan Exp $
   27    */
   28   package javax.xml.crypto.dsig;
   29   
   30   import javax.xml.crypto.AlgorithmMethod;
   31   import javax.xml.crypto.XMLStructure;
   32   import javax.xml.crypto.dsig.spec.DigestMethodParameterSpec;
   33   import java.security.spec.AlgorithmParameterSpec;
   34   
   35   /**
   36    * A representation of the XML <code>DigestMethod</code> element as
   37    * defined in the <a href="http://www.w3.org/TR/xmldsig-core/">
   38    * W3C Recommendation for XML-Signature Syntax and Processing</a>.
   39    * The XML Schema Definition is defined as:
   40    * <p>
   41    * <pre>
   42    *   &lt;element name="DigestMethod" type="ds:DigestMethodType"/&gt;
   43    *     &lt;complexType name="DigestMethodType" mixed="true"&gt;
   44    *       &lt;sequence&gt;
   45    *         &lt;any namespace="##any" minOccurs="0" maxOccurs="unbounded"/&gt;
   46    *           &lt;!-- (0,unbounded) elements from (1,1) namespace --&gt;
   47    *       &lt;/sequence&gt;
   48    *       &lt;attribute name="Algorithm" type="anyURI" use="required"/&gt;
   49    *     &lt;/complexType&gt;
   50    * </pre>
   51    *
   52    * A <code>DigestMethod</code> instance may be created by invoking the
   53    * {@link XMLSignatureFactory#newDigestMethod newDigestMethod} method
   54    * of the {@link XMLSignatureFactory} class.
   55    *
   56    * @author Sean Mullan
   57    * @author JSR 105 Expert Group
   58    * @since 1.6
   59    * @see XMLSignatureFactory#newDigestMethod(String, DigestMethodParameterSpec)
   60    */
   61   public interface DigestMethod extends XMLStructure, AlgorithmMethod {
   62   
   63       /**
   64        * The <a href="http://www.w3.org/2000/09/xmldsig#sha1">
   65        * SHA1</a> digest method algorithm URI.
   66        */
   67       static final String SHA1 = "http://www.w3.org/2000/09/xmldsig#sha1";
   68   
   69       /**
   70        * The <a href="http://www.w3.org/2001/04/xmlenc#sha256">
   71        * SHA256</a> digest method algorithm URI.
   72        */
   73       static final String SHA256 = "http://www.w3.org/2001/04/xmlenc#sha256";
   74   
   75       /**
   76        * The <a href="http://www.w3.org/2001/04/xmlenc#sha512">
   77        * SHA512</a> digest method algorithm URI.
   78        */
   79       static final String SHA512 = "http://www.w3.org/2001/04/xmlenc#sha512";
   80   
   81       /**
   82        * The <a href="http://www.w3.org/2001/04/xmlenc#ripemd160">
   83        * RIPEMD-160</a> digest method algorithm URI.
   84        */
   85       static final String RIPEMD160 = "http://www.w3.org/2001/04/xmlenc#ripemd160";
   86   
   87       /**
   88        * Returns the algorithm-specific input parameters associated with this
   89        * <code>DigestMethod</code>.
   90        *
   91        * <p>The returned parameters can be typecast to a {@link
   92        * DigestMethodParameterSpec} object.
   93        *
   94        * @return the algorithm-specific parameters (may be <code>null</code> if
   95        *    not specified)
   96        */
   97       AlgorithmParameterSpec getParameterSpec();
   98   }

Save This Page
Home » openjdk-7 » javax » xml » crypto » dsig » [javadoc | source]