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  import javax.xml.namespace.QName;
20  
21  import org.opensaml.xml.util.XMLConstants;
22  import org.opensaml.xml.validation.ValidatingXMLObject;
23  
24  /**
25   * XMLObject representing XML Digital Signature, version 20020212, RetrievalMethod element.
26   */
27  public interface RetrievalMethod extends ValidatingXMLObject {
28      
29      /** Element local name */
30      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "RetrievalMethod";
31      
32      /** Default element name */
33      public final static QName DEFAULT_ELEMENT_NAME = new QName(XMLConstants.XMLSIG_NS, DEFAULT_ELEMENT_LOCAL_NAME, XMLConstants.XMLSIG_PREFIX);
34      
35      /** Local name of the XSI type */
36      public final static String TYPE_LOCAL_NAME = "RetrievalMethodType"; 
37          
38      /** QName of the XSI type */
39      public final static QName TYPE_NAME = new QName(XMLConstants.XMLSIG_NS, TYPE_LOCAL_NAME, XMLConstants.XMLSIG_PREFIX);
40      
41      /** URI attribute name */
42      public static final String URI_ATTRIB_NAME = "URI";
43      
44      /** Type attribute name */
45      public static final String TYPE_ATTRIB_NAME = "Type";
46      
47      /**
48       * Get the URI attribute value
49       * 
50       * @return the URI attribute value
51       */
52      public String getURI();
53      
54      /**
55       * Set the URI attribute value
56       * 
57       * @param newURI the new URI attribute value
58       */
59      public void setURI(String newURI);
60      
61      /**
62       * Set the Type attribute value
63       * 
64       * @return the Type attribute value
65       */
66      public String getType();
67      
68      /**
69       * Set the Type attribute value 
70       * 
71       * @param newType the new Type attribute value
72       */
73      public void setType(String newType);
74      
75      /**
76       * Get the Transforms child element
77       * 
78       * @return the Transforms child element
79       */
80      public Transforms getTransforms();
81      
82      /**
83       * Set the Transforms child element
84       * 
85       * @param newTransforms the new Transforms child element
86       */
87      public void setTransforms(Transforms newTransforms);
88      
89  }