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  /**
21   * Parameters for encrypting keys.
22   */
23  public class KeyEncryptionParameters extends EncryptionParameters {
24  
25      /** Recipient of the key. */
26      private String recipient;
27  
28      /**
29       * Constructor.
30       */
31      public KeyEncryptionParameters() {
32          super();
33          // The default supplied by the super class doesn't make sense,
34          // can't autogenerate a key encryption key, always needs to be derived
35          // from the key in the (for KEK, mandatory) encryption credential.
36          setAlgorithm(null);
37      }
38  
39      /**
40       * Gets the recipient of the key.
41       * 
42       * When generating an EncryptedKey, this will be used as the value of the Recipient attribute.
43       * 
44       * @return the recipient of the key
45       */
46      public String getRecipient() {
47          return recipient;
48      }
49  
50      /**
51       * Sets the recipient of the key.
52       * 
53       * When generating an EncryptedKey, this will be used as the value of the Recipient attribute.
54       * 
55       * @param newRecipient the recipient of the key
56       */
57      public void setRecipient(String newRecipient) {
58          this.recipient = newRecipient;
59      }
60  }