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.Name;
19  
20  import org.apache.axis.message.PrefixedQName;
21  
22  /**
23   * WS-Addressing constants.
24   *
25   * @author Davanum Srinivas
26   * @version $Revision: 14 $
27   */
28  public interface Constants {
29  
30    /**
31     * A prefix for the WSA namespace.
32     */
33    String NS_PREFIX_ADDRESSING = "wsa";
34  
35    /**
36     * Namespace for 2003/03 revision of WSA schema.
37     */
38    String NS_URI_ADDRESSING_2003_03 = "http://schemas.xmlsoap.org/ws/2003/03/addressing";
39  
40    /**
41     * Namespace for 2004/03 revision of WSA schema.
42     */
43    String NS_URI_ADDRESSING_2004_03 = "http://schemas.xmlsoap.org/ws/2004/03/addressing";
44  
45    /**
46     * Namespace for 2004/08 revision of WSA schema.
47     */
48    String NS_URI_ADDRESSING_2004_08 = "http://schemas.xmlsoap.org/ws/2004/08/addressing";
49  
50    /**
51     * Namespace for 2005/08 revision of WSA schema (CR version too).
52     */
53    String NS_URI_ADDRESSING_2005_08 = "http://www.w3.org/2005/08/addressing";
54  
55    /**
56     * Default WSA namespace to use when serializing EPRs or WSA headers.
57     */
58    String NS_URI_ADDRESSING_DEFAULT = NS_URI_ADDRESSING_2004_08;
59  
60    /**
61     * Default WSA namespace to use when serializing EPRs or WSA headers.
62     *
63     * @deprecated Use NS_URI_ADDRESSING_DEFAULT instead.
64     */
65    @Deprecated
66    String NS_URI_ADDRESSING = NS_URI_ADDRESSING_DEFAULT;
67  
68    /**
69     * Anonymous target URI.
70     */
71    String URI_ANONYMOUS_W3C_CR = "http://www.w3.org/2005/08/addressing/anonymous";
72  
73    /**
74     * None URI.
75     */
76    String URI_NONE_W3C_CR = "http://www.w3.org/2005/08/addressing/none";
77  
78    /**
79     * Reply URI.
80     */
81    String URI_REPLY = "http://www.w3.org/2005/08/addressing/reply";
82  
83    /**
84     * Field ENDPOINT_REFERENCE.
85     */
86    String ENDPOINT_REFERENCE = "EndpointReference";
87  
88    /**
89     * Field MESSAGE_ID.
90     */
91    String MESSAGE_ID = "MessageID";
92  
93    /**
94     * Field RELATES_TO.
95     */
96    String RELATES_TO = "RelatesTo";
97  
98    /**
99     * Field RELATIONSHIP_TYPE.
100    */
101   String RELATIONSHIP_TYPE = "RelationshipType";
102 
103   /**
104    * Field ACTION.
105    */
106   String ACTION = "Action";
107 
108   /**
109    * The localName of the Address EPR element.
110    */
111   String ADDRESS = "Address";
112 
113   /**
114    * The localName of the ReferenceProperties EPR element.
115    */
116   String REFERENCE_PROPERTIES = "ReferenceProperties";
117 
118   /**
119    * The localName of the ReferenceParameters EPR element.
120    */
121   String REFERENCE_PARAMETERS = "ReferenceParameters";
122 
123   /**
124    * The localName of the ServiceName EPR element.
125    */
126   String SERVICE_NAME = "ServiceName";
127 
128   /**
129    * The name of the PortName attribute of the ServiceName EPR element.
130    */
131   String PORT_NAME = "PortName";
132 
133   /**
134    * The localName of the PortType EPR element.
135    */
136   String PORT_TYPE = "PortType";
137 
138   /**
139    * Field RESPONSE.
140    */
141   String RESPONSE = "Response";
142 
143   /**
144    * Field REPLY.
145    */
146   String REPLY = "Reply";
147 
148   /**
149    * Field TO.
150    */
151   String TO = "To";
152 
153   /**
154    * Field REPLY_TO.
155    */
156   String REPLY_TO = "ReplyTo";
157 
158   /**
159    * Field FAULT_TO.
160    */
161   String FAULT_TO = "FaultTo";
162 
163   /**
164    * Field FROM.
165    */
166   String FROM = "From";
167 
168   /**
169    * Fault-Detail end-point reference field name.
170    */
171   String FAULT_DETAIL = "FaultDetail";
172 
173   /**
174    * Field RECIPIENT.
175    */
176   String RECIPIENT = "Recipient";
177 
178   /**
179    * Metadata End-point reference field name.
180    */
181   String METADATA = "Metadata";
182 
183   /**
184    * Internal property for passing some WSA headers from the generated Stub
185    * class to the handlers.
186    */
187   String ENV_ADDRESSING_SHARED_HEADERS
188     = "org.apache.axis.message.addressing.SHARED_HEADERS";
189 
190   /**
191    * Field ENV_ADDRESSING_REQUEST_HEADERS.
192    */
193   String ENV_ADDRESSING_REQUEST_HEADERS
194     = "org.apache.axis.message.addressing.REQUEST.HEADERS";
195 
196   /**
197    * Field ENV_ADDRESSING_RESPONSE_HEADERS.
198    */
199   String ENV_ADDRESSING_RESPONSE_HEADERS
200     = "org.apache.axis.message.addressing.RESPONSE.HEADERS";
201 
202   /**
203    * SOAP message context prop that contains the namespace URI of the WSA
204    * version being used by the current request. Value is a String.
205    */
206   String ENV_ADDRESSING_NAMESPACE_URI = "addressing.namespace.URI";
207 
208   /**
209    * SOAP message context prop with default value for wsa:From header for
210    * outgoing request messages.
211    */
212   String ENV_ADDRESSING_FROM_URI = "addressing.from.URI";
213 
214   /**
215    * SOAP message context prop with default value for wsa:ReplyTo header for
216    * outgoing request messages.
217    */
218   String ENV_ADDRESSING_REPLYTO_URI = "addressing.replyTo.URI";
219 
220   /**
221    * SOAP message context prop with default value for wsa:FaultTo header for
222    * outgoing request messages.
223    */
224   String ENV_ADDRESSING_FAULTTO_URI = "addressing.faultTo.URI";
225 
226   /**
227    * SOAP message context prop that expects a value of "true" or "false".
228    */
229   String ENV_ADDRESSING_SET_MUST_UNDERSTAND = "addressing.setMustUnderstand";
230 
231   /**
232    * SOAP message context prop that expects a value of "true" or "false".
233    */
234   String ENV_ADDRESSING_SEND_REPLYTO = "addressing.sendReplyTo";
235 
236   /**
237    * MessageContext property name for setting the response action. Will only
238    * work if an action is not already included in the response AddressingHeaders
239    * (see AddressingHandler.java).
240    */
241   String ENV_ADDRESSING_RESP_ACTION = "addressing.responseAction";
242 
243   /**
244    * MC property for setting the "requiredness" of WS-Addr. If true, the
245    * AddressingHandler will fault if there are no WSA headers in received
246    * messages.
247    */
248   String ENV_ADDRESSING_REQUIRED = "addressing.required";
249 
250   /**
251    * Configuration property.
252    */
253   String SEND_DEFAULT_FROM = "addressing.sendDefaultFrom";
254 
255   /**
256    * Configuration property.
257    */
258   String SEND_DEFAULT_MESSAGEID = "addressing.sendDefaultID";
259 
260   /**
261    * Configuration property.
262    */
263   String SEND_DEFAULT_TO = "addressing.sendDefaultTo";
264 
265   /**
266    * Field QNAME_ACTION.
267    */
268   String WSDL_ATTRIB_ACTION = "Action";
269 
270   /**
271    * IsReferenceParameter attribute Name.
272    */
273   Name ATTR_REFP = new PrefixedQName(NS_URI_ADDRESSING_2005_08, "IsReferenceParameter",
274     "wsa");
275 }