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  
20  import javax.xml.namespace.QName;
21  
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, EncryptionMethod element.
28   */
29  public interface EncryptionMethod extends ValidatingXMLObject, ElementExtensibleXMLObject {
30      
31      /** Element local name. */
32      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "EncryptionMethod";
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 = "EncryptionMethodType"; 
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      /** Algorithm attribute name. */
46      public static final String ALGORITHM_ATTRIB_NAME = "Algorithm";
47      
48     
49      /**
50       * Gets the algorithm URI attribute used in this EncryptionMethod.
51       * 
52       * @return the Algorithm attribute URI attribute string
53       */
54      public String getAlgorithm();
55   
56      /**
57       * Sets the algorithm URI attribute used in this EncryptionMethod.
58       * 
59       * @param newAlgorithm the new Algorithm URI attribute string
60       */
61      public void setAlgorithm(String newAlgorithm);
62      
63      /**
64       * Gets the KeySize child element.
65       * 
66       * @return the KeySize child element
67       */
68      public KeySize getKeySize();
69      
70      /**
71       * Sets the KeySize child element.
72       * 
73       * @param newKeySize the new KeySize child element
74       */
75      public void setKeySize(KeySize newKeySize);
76      
77      /**
78       * Gets the OAEPparams child element.
79       * 
80       * @return the OAEPparams child element
81       */
82      public OAEPparams getOAEPparams();
83      
84      /**
85       * Sets the OAEPparams child element.
86       * 
87       * @param newOAEPparams the new OAEPparams child element
88       */
89      public void setOAEPparams(OAEPparams newOAEPparams);
90      
91  }