View Javadoc

1   /*
2    *  Copyright (c) 2008 Rodrigo Ruiz
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  package org.apache.axis.message.addressing;
17  
18  import javax.xml.soap.SOAPEnvelope;
19  import javax.xml.soap.SOAPException;
20  import javax.xml.soap.SOAPHeaderElement;
21  
22  /**
23   * Common methods to all SOAP Header Element types.
24   *
25   * @author Rodrigo Ruiz
26   * @version $Revision: 14 $
27   */
28  public interface AddressingHeaderItem {
29  
30    /**
31     * Gets a SOAP Header Element from this instance.
32     *
33     * @param version  WS-Addressing version to use
34     * @param env      SOAP envelope to append to
35     * @param actorURI Actor URI
36     * @return Header Element
37     * @throws SOAPException If an error occurs
38     */
39    SOAPHeaderElement toSOAPHeaderElement(AddressingVersion version,
40      SOAPEnvelope env, String actorURI) throws SOAPException;
41  
42    /**
43     * Gets a SOAP Header Element from this instance.
44     *
45     * @param env SOAP envelope to append to
46     * @param actorURI Actor URI
47     * @return Header Element
48     * @throws SOAPException If an error occurs
49     */
50    SOAPHeaderElement toSOAPHeaderElement(SOAPEnvelope env, String actorURI)
51      throws SOAPException;
52  
53  }