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.encryption;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.xml.AttributeExtensibleXMLObject;
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 Encryption, version 20021210, EncryptionProperty element.
28   */
29  public interface EncryptionProperty extends ValidatingXMLObject, AttributeExtensibleXMLObject,
30          ElementExtensibleXMLObject {
31  
32      /** Element local name. */
33      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "EncryptionProperty";
34  
35      /** Default element name. */
36      public static final QName DEFAULT_ELEMENT_NAME = new QName(XMLConstants.XMLENC_NS, DEFAULT_ELEMENT_LOCAL_NAME,
37              XMLConstants.XMLENC_PREFIX);
38  
39      /** Local name of the XSI type. */
40      public static final String TYPE_LOCAL_NAME = "EncryptionPropertyType";
41  
42      /** QName of the XSI type. */
43      public static final QName TYPE_NAME = new QName(XMLConstants.XMLENC_NS, TYPE_LOCAL_NAME, 
44              XMLConstants.XMLENC_PREFIX);
45  
46      /** Target attribute name. */
47      public static final String TARGET_ATTRIB_NAME = "Target";
48  
49      /** Id attribute name. */
50      public static final String ID_ATTRIB_NAME = "Id";
51  
52      /**
53       * Get the target URI attribute which specifies to which element this. property applies
54       * 
55       * @return the target URI attribute
56       */
57      public String getTarget();
58  
59      /**
60       * Set the target URI attribute which specifies to which element this property applies.
61       * 
62       * @param newTarget the new target URI attribute
63       */
64      public void setTarget(String newTarget);
65  
66      /**
67       * Get the ID attribute which uniquely identifies this element.
68       * 
69       * @return the ID attribute value
70       */
71      public String getID();
72  
73      /**
74       * Set the ID attribute which uniquely identifies this element.
75       * 
76       * @param newID the new ID attribute
77       */
78      public void setID(String newID);
79  
80  }