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.ws.soap.soap11;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.ws.soap.common.SOAPObject;
22  import org.opensaml.ws.soap.util.SOAPConstants;
23  import org.opensaml.xml.AttributeExtensibleXMLObject;
24  import org.opensaml.xml.ElementExtensibleXMLObject;
25  
26  /**
27   * SOAP 1.1 Envelope.
28   */
29  public interface Envelope extends SOAPObject, ElementExtensibleXMLObject, AttributeExtensibleXMLObject {
30  
31      /** Element local name. */
32      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Envelope";
33      
34      /** Default element name. */
35      public static final QName DEFAULT_ELEMENT_NAME = 
36          new QName(SOAPConstants.SOAP11_NS, DEFAULT_ELEMENT_LOCAL_NAME, SOAPConstants.SOAP11_PREFIX);
37      
38      /** Local name of the XSI type. */
39      public static final String TYPE_LOCAL_NAME = "Envelope"; 
40          
41      /** QName of the XSI type. */
42      public static final QName TYPE_NAME = 
43          new QName(SOAPConstants.SOAP11_NS, TYPE_LOCAL_NAME, SOAPConstants.SOAP11_PREFIX);
44      
45      /**
46       * Gets the header of this envelope.
47       * 
48       * @return the header of this envelope
49       */
50      public Header getHeader();
51      
52      /**
53       * Sets the header of this envelope.
54       * 
55       * @param newHeader the header of this envelope
56       */
57      public void setHeader(Header newHeader);
58      
59      /**
60       * Gets the body of this envelope.
61       * 
62       * @return the body of this envelope
63       */
64      public Body getBody();
65      
66      /**
67       * Sets the body of this envelope.
68       * 
69       * @param newBody the body of this envelope
70       */
71      public void setBody(Body newBody);
72  }