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 java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  import org.opensaml.xml.util.XMLConstants;
24  import org.opensaml.xml.validation.ValidatingXMLObject;
25  
26  /**
27   * XMLObject representing XML Encryption, version 20021210, EncryptionProperties element.
28   */
29  public interface EncryptionProperties extends ValidatingXMLObject {
30      
31      /** Element local name. */
32      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "EncryptionProperties";
33      
34      /** Default element name. */
35      public static final QName DEFAULT_ELEMENT_NAME = new QName(XMLConstants.XMLENC_NS, DEFAULT_ELEMENT_LOCAL_NAME, 
36              XMLConstants.XMLENC_PREFIX);
37      
38      /** Local name of the XSI type. */
39      public static final String TYPE_LOCAL_NAME = "EncryptionPropertiesType"; 
40          
41      /** QName of the XSI type. */
42      public static final QName TYPE_NAME = new QName(XMLConstants.XMLENC_NS, TYPE_LOCAL_NAME, 
43              XMLConstants.XMLENC_PREFIX);
44      
45      /** ID attribute name. */
46      public static final String ID_ATTRIB_NAME = "Id";
47      
48      /**
49       * Get the ID attribute that uniquely identifies this element.
50       * 
51       * @return ID attribute
52       */
53      public String getID();
54      
55      /**
56       * Set the ID attribute that uniquely identifies this element.
57       * 
58       * @param newID the new ID attribute value
59       */
60      public void setID(String newID);
61      
62      /**
63       * Get the list of EncryptionProperty child elements.
64       * 
65       * @return the List of EncryptionProperty child elements
66       */
67      public List<EncryptionProperty> getEncryptionProperties();
68      
69  }