View Javadoc

1   /*
2    * Copyright 2009 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.ws.wssecurity;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.ws.soap.soap11.ActorBearing;
22  import org.opensaml.ws.soap.soap11.MustUnderstandBearing;
23  import org.opensaml.ws.soap.soap12.RelayBearing;
24  import org.opensaml.ws.soap.soap12.RoleBearing;
25  import org.opensaml.xml.encryption.EncryptedData;
26  
27  /**
28   * The <wsse:EncryptedHeader> element.
29   * 
30   * @see EncryptedHeader
31   * @see "WS-Security, Chapter 9.3 EncryptedHeader"
32   * 
33   */
34  public interface EncryptedHeader extends IdBearing, MustUnderstandBearing, ActorBearing,
35          org.opensaml.ws.soap.soap12.MustUnderstandBearing, RoleBearing, RelayBearing, WSSecurityObject {
36      
37      /** Element local name. */
38      public static final String ELEMENT_LOCAL_NAME = "EncryptedHeader";
39  
40      /** Qualified element name. */
41      public static final QName ELEMENT_NAME =
42          new QName(WSSecurityConstants.WSSE11_NS, ELEMENT_LOCAL_NAME, WSSecurityConstants.WSSE11_PREFIX);
43      
44      /** Local name of the XSI type. */
45      public static final String TYPE_LOCAL_NAME = "EncryptedHeaderType"; 
46          
47      /** QName of the XSI type. */
48      public static final QName TYPE_NAME = 
49          new QName(WSSecurityConstants.WSSE11_NS, TYPE_LOCAL_NAME, WSSecurityConstants.WSSE11_PREFIX);
50      
51      /**
52       * Gets the EncryptedData child element.
53       * 
54       * @return the EncryptedData child element
55       */
56      public EncryptedData getEncryptedData();
57      
58      /**
59       * Sets the EncryptedData child element.
60       * 
61       * @param newEncryptedData the new EncryptedData child element
62       */
63      public void setEncryptedData(EncryptedData newEncryptedData);
64  
65  }