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.util.XMLConstants;
22  import org.opensaml.xml.validation.ValidatingXMLObject;
23  
24  /**
25   * XMLObject representing XML Encryption, version 20021210, CipherData element.
26   */
27  public interface CipherData extends ValidatingXMLObject {
28  
29      /** Element local name. */
30      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "CipherData";
31  
32      /** Default element name. */
33      public static final QName DEFAULT_ELEMENT_NAME = new QName(XMLConstants.XMLENC_NS, DEFAULT_ELEMENT_LOCAL_NAME,
34              XMLConstants.XMLENC_PREFIX);
35  
36      /** Local name of the XSI type. */
37      public static final String TYPE_LOCAL_NAME = "CipherDataType";
38  
39      /** QName of the XSI type. */
40      public static final QName TYPE_NAME = new QName(XMLConstants.XMLENC_NS, TYPE_LOCAL_NAME, 
41              XMLConstants.XMLENC_PREFIX);
42  
43      /**
44       * Get the base64-encoded data representing the the encrypted form of the plaintext data.
45       * 
46       * @return base64-encoded encrypted value
47       */
48      public CipherValue getCipherValue();
49  
50      /**
51       * Set the base64-encoded data representing the the encrypted form of the plaintext data.
52       * 
53       * @param newCipherValue the new base64-encoded encrypted data
54       */
55      public void setCipherValue(CipherValue newCipherValue);
56  
57      /**
58       * Get the CipherReference which points to the location encrypted data.
59       * 
60       * @return CipherReference child element representing the encrypted data
61       */
62      public CipherReference getCipherReference();
63  
64      /**
65       * Get the CipherReference which points to the location encrypted data.
66       * 
67       * @param newCipherReference the new CipherReference child element
68       */
69      public void setCipherReference(CipherReference newCipherReference);
70  }