View Javadoc

1   /*
2    * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.xml.signature;
18  
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xml.ElementExtensibleXMLObject;
23  import org.opensaml.xml.util.XMLConstants;
24  import org.opensaml.xml.validation.ValidatingXMLObject;
25  
26  /**
27   * XMLObject representing XML Digital Signature, version 20020212, DigestMethod element.
28   */
29  public interface DigestMethod extends ValidatingXMLObject, ElementExtensibleXMLObject {
30      
31      /** Element local name. */
32      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "DigestMethod";
33      
34      /** Default element name. */
35      public static final QName DEFAULT_ELEMENT_NAME = new QName(XMLConstants.XMLSIG_NS, DEFAULT_ELEMENT_LOCAL_NAME, XMLConstants.XMLSIG_PREFIX);
36      
37      /** Local name of the XSI type. */
38      public static final String TYPE_LOCAL_NAME = "DigestMethodType"; 
39          
40      /** QName of the XSI type. */
41      public static final QName TYPE_NAME = new QName(XMLConstants.XMLSIG_NS, TYPE_LOCAL_NAME, XMLConstants.XMLSIG_PREFIX);
42      
43      /** Algorithm attribute name. */
44      public static final String ALGORITHM_ATTRIB_NAME = "Algorithm";
45      
46      /**
47       * Get the Algorithm URI attribute value.
48       *  
49       * @return the Algorithm URI attribute value
50       */
51      public String getAlgorithm();
52      
53      /**
54       * 
55       * Set the Algorithm URI attribute value.
56       *  
57       * @param newAlgorithm the new Algorithm URI attribute value
58       */
59      public void setAlgorithm(String newAlgorithm);
60      
61  }