View Javadoc
1   /*
2    * Copyright 2006 the original author or authors.
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.springframework.ws.soap;
18  
19  /**
20   * Represents the <code>Envelope</code> element in a SOAP message. The header contains the optional
21   * <code>SoapHeader</code> and <code>SoapBody</code>.
22   *
23   * @author Arjen Poutsma
24   * @since 1.0.0
25   */
26  public interface SoapEnvelope extends SoapElement {
27  
28      /**
29       * Returns the <code>SoapHeader</code>. Returns <code>null</code> if no header is present.
30       *
31       * @return the <code>SoapHeader</code>, or <code>null</code>
32       * @throws SoapHeaderException if the header cannot be returned
33       */
34      SoapHeader getHeader() throws SoapHeaderException;
35  
36      /**
37       * Returns the <code>SoapBody</code>.
38       *
39       * @return the <code>SoapBody</code>
40       * @throws SoapBodyException if the header cannot be returned
41       */
42      SoapBody getBody() throws SoapBodyException;
43  
44  }