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 java.util.List;
21
22 import javax.xml.namespace.QName;
23
24 import org.opensaml.xml.XMLObject;
25 import org.opensaml.xml.util.XMLConstants;
26 import org.opensaml.xml.validation.ValidatingXMLObject;
27
28 /**
29 * XMLObject representing XML Digital Signature, version 20020212, Transform element.
30 */
31 public interface Transform extends ValidatingXMLObject {
32
33 /** Element local name */
34 public final static String DEFAULT_ELEMENT_LOCAL_NAME = "Transform";
35
36 /** Default element name */
37 public final static QName DEFAULT_ELEMENT_NAME = new QName(XMLConstants.XMLSIG_NS, DEFAULT_ELEMENT_LOCAL_NAME, XMLConstants.XMLSIG_PREFIX);
38
39 /** Local name of the XSI type */
40 public final static String TYPE_LOCAL_NAME = "TransformType";
41
42 /** QName of the XSI type */
43 public final static QName TYPE_NAME = new QName(XMLConstants.XMLSIG_NS, TYPE_LOCAL_NAME, XMLConstants.XMLSIG_PREFIX);
44
45 /** Algorithm attribute name */
46 public final static String ALGORITHM_ATTRIB_NAME = "Algorithm";
47
48 /**
49 * Get the Algorithm URI attribute value
50 *
51 * @return the Algorithm URI attribute value
52 */
53 public String getAlgorithm();
54
55 /**
56 *
57 * Set the Algorithm URI attribute value
58 *
59 * @param newAlgorithm the new Algorithm URI attribute value
60 */
61 public void setAlgorithm(String newAlgorithm);
62
63 /**
64 * Get the list of XMLObject children that match a particular QName
65 *
66 * @param typeOrName the QName of the statements to return
67 *
68 * @return the list of XMLObject children that match the given QName
69 */
70 public List<XMLObject> getXMLObjects(QName typeOrName);
71
72 /**
73 * Get the list of XPath child elements
74 *
75 * @return list of XPath child elements
76 */
77 public List<XPath> getXPaths();
78
79 /**
80 * Gets the ordered list of all XMLObject child elements of this element.
81 *
82 * @return list of XMLObject children
83 */
84 public List<XMLObject> getAllChildren();
85
86 }