EncryptionProperties


1   /*
2    * Copyright  2003-2004 The Apache Software Foundation.
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 com.sun.org.apache.xml.internal.security.encryption;
18  
19  
20  import java.util.Iterator  ;
21  
22  
23  /**
24   * <code>EncryptionProperties</code> can hold additional information concerning
25   * the generation of the <code>EncryptedData</code> or
26   * <code>EncryptedKey</code>. This information is wraped int an
27   * <code>EncryptionProperty</code> element. Examples of additional information
28   * is e.g., a date/time stamp or the serial number of cryptographic hardware
29   * used during encryption).
30   * <p>
31   * It is defined as follows:
32   * <xmp>
33   * <element name='EncryptionProperties' type='xenc:EncryptionPropertiesType'/>
34   * <complexType name='EncryptionPropertiesType'>
35   *     <sequence>
36   *         <element ref='xenc:EncryptionProperty' maxOccurs='unbounded'/>
37   *     </sequence>
38   *     <attribute name='Id' type='ID' use='optional'/>
39   * </complexType>
40   * </xmp>
41   *
42   * @author Axl Mattheus
43   */
44  public interface EncryptionProperties {
45      /**
46       * Returns the <code>EncryptionProperties</code>' id.
47       *
48       * @return the id.
49       */
50      String   getId();
51  
52      /**
53       * Sets the id.
54       *
55       * @param id the id.
56       */
57      void setId(String   id);
58  
59      /**
60       * Returns an <code>Iterator</code> over all the
61       * <code>EncryptionPropterty</code> elements contained in this
62       * <code>EncryptionProperties</code>.
63       *
64       * @return an <code>Iterator</code> over all the encryption properties.
65       */
66      Iterator   getEncryptionProperties();
67  
68      /**
69       * Adds an <code>EncryptionProperty</code>.
70       *
71       * @param property.
72       */
73      void addEncryptionProperty(EncryptionProperty property);
74  
75      /**
76       * Removes the specified <code>EncryptionProperty</code>.
77       *
78       * @param property.
79       */
80      void removeEncryptionProperty(EncryptionProperty property);
81  }
82  
83
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags