View Javadoc

1   /*
2    * Copyright  2003-2004 The Apache Software Foundation.
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  
18  package org.apache.ws.security;
19  
20  import javax.xml.namespace.QName;
21  import java.io.Serializable;
22  
23  /***
24   * An interface definining SOAP constants.  This allows various parts of the
25   * engine to avoid hardcoding dependence on a particular SOAP version and its
26   * associated URIs, etc.
27   * <p/>
28   * This might be fleshed out later to encapsulate factories for behavioral
29   * objects which act differently depending on the SOAP version, but for now
30   * it just supplies common namespaces + QNames.
31   *
32   * @author Glen Daniels (gdaniels@apache.org)
33   * @author Andras Avar (andras.avar@nokia.com)
34   */
35  public interface SOAPConstants extends Serializable {
36      /***
37       * SOAP 1.1 constants - thread-safe and shared
38       */
39      public SOAP11Constants SOAP11_CONSTANTS = new SOAP11Constants();
40      /***
41       * SOAP 1.2 constants - thread-safe and shared
42       */
43      public SOAP12Constants SOAP12_CONSTANTS = new SOAP12Constants();
44  
45      /***
46       * Obtain the envelope namespace for this version of SOAP
47       */
48      public String getEnvelopeURI();
49  
50      /***
51       * Obtain the QName for the Header element
52       */
53      public QName getHeaderQName();
54  
55      /***
56       * Obtain the QName for the Body element
57       */
58      public QName getBodyQName();
59  
60      /***
61       * Obtain the QName for the role attribute (actor/role)
62       */
63      public QName getRoleAttributeQName();
64  
65      /***
66       * Obtain the "next" role/actor URI
67       */
68      public String getNextRoleURI();
69  
70      /***
71       * Obtain the "next" role/actor URI
72       */
73      public String getMustunderstand();
74  
75  }