12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.xml.soap;
27
28 import javax.xml.namespace.QName;
29
30 /**
31 * The definition of constants pertaining to the SOAP protocol.
32 */
33 public interface SOAPConstants {
34 /**
35 * Used to create <code>MessageFactory</code> instances that create
36 * <code>SOAPMessages</code> whose concrete type is based on the
37 * <code>Content-Type</code> MIME header passed to the
38 * <code>createMessage</code> method. If no <code>Content-Type</code>
39 * header is passed then the <code>createMessage</code> may throw an
40 * <code>IllegalArgumentException</code> or, in the case of the no
41 * argument version of <code>createMessage</code>, an
42 * <code>UnsupportedOperationException</code>.
43 *
44 * @since SAAJ 1.3
45 */
46 public static final String DYNAMIC_SOAP_PROTOCOL = "Dynamic Protocol";
47
48 /**
49 * Used to create <code>MessageFactory</code> instances that create
50 * <code>SOAPMessages</code> whose behavior supports the SOAP 1.1 specification.
51 *
52 * @since SAAJ 1.3
53 */
54 public static final String SOAP_1_1_PROTOCOL = "SOAP 1.1 Protocol";
55
56 /**
57 * Used to create <code>MessageFactory</code> instances that create
58 * <code>SOAPMessages</code> whose behavior supports the SOAP 1.2
59 * specification
60 *
61 * @since SAAJ 1.3
62 */
63 public static final String SOAP_1_2_PROTOCOL = "SOAP 1.2 Protocol";
64
65 /**
66 * The default protocol: SOAP 1.1 for backwards compatibility.
67 *
68 * @since SAAJ 1.3
69 */
70 public static final String DEFAULT_SOAP_PROTOCOL = SOAP_1_1_PROTOCOL;
71
72 /**
73 * The namespace identifier for the SOAP 1.1 envelope.
74 * @since SAAJ 1.3
75 */
76 public static final String
77 URI_NS_SOAP_1_1_ENVELOPE = "http://schemas.xmlsoap.org/soap/envelope/";
78 /**
79 * The namespace identifier for the SOAP 1.2 envelope.
80 * @since SAAJ 1.3
81 */
82 public static final String
83 URI_NS_SOAP_1_2_ENVELOPE = "http://www.w3.org/2003/05/soap-envelope";
84
85 /**
86 * The namespace identifier for the SOAP 1.1 envelope, All SOAPElements in this
87 * namespace are defined by the SOAP 1.1 specification.
88 */
89 public static final String
90 URI_NS_SOAP_ENVELOPE = URI_NS_SOAP_1_1_ENVELOPE;
91
92 /**
93 * The namespace identifier for the SOAP 1.1 encoding.
94 * An attribute named <code>encodingStyle</code> in the
95 * <code>URI_NS_SOAP_ENVELOPE</code> namespace and set to the value
96 * <code>URI_NS_SOAP_ENCODING</code> can be added to an element to indicate
97 * that it is encoded using the rules in section 5 of the SOAP 1.1
98 * specification.
99 */
100 public static final String
101 URI_NS_SOAP_ENCODING = "http://schemas.xmlsoap.org/soap/encoding/";
102
103 /**
104 * The namespace identifier for the SOAP 1.2 encoding.
105 * @since SAAJ 1.3
106 */
107 public static final String
108 URI_NS_SOAP_1_2_ENCODING = "http://www.w3.org/2003/05/soap-encoding";
109
110 /**
111 * The media type of the <code>Content-Type</code> MIME header in SOAP 1.1.
112 * @since SAAJ 1.3
113 */
114 public static final String
115 SOAP_1_1_CONTENT_TYPE = "text/xml";
116
117 /**
118 * The media type of the <code>Content-Type</code> MIME header in SOAP 1.2.
119 * @since SAAJ 1.3
120 */
121 public static final String
122 SOAP_1_2_CONTENT_TYPE = "application/soap+xml";
123
124 /**
125 * The URI identifying the next application processing a SOAP request as the intended
126 * actor for a SOAP 1.1 header entry (see section 4.2.2 of the SOAP 1.1 specification).
127 * <p>
128 * This value can be passed to
129 * {@link SOAPHeader#examineMustUnderstandHeaderElements(String)},
130 * {@link SOAPHeader#examineHeaderElements(String)} and
131 * {@link SOAPHeader#extractHeaderElements(String)}
132 */
133 public static final String
134 URI_SOAP_ACTOR_NEXT = "http://schemas.xmlsoap.org/soap/actor/next";
135
136 /**
137 * The URI identifying the next application processing a SOAP request as the intended
138 * role for a SOAP 1.2 header entry (see section 2.2 of part 1 of the SOAP 1.2
139 * specification).
140 * @since SAAJ 1.3
141 */
142 public static final String
143 URI_SOAP_1_2_ROLE_NEXT = URI_NS_SOAP_1_2_ENVELOPE + "/role/next";
144
145 /**
146 * The URI specifying the role None in SOAP 1.2.
147 * @since SAAJ 1.3
148 */
149 public static final String
150 URI_SOAP_1_2_ROLE_NONE = URI_NS_SOAP_1_2_ENVELOPE + "/role/none";
151
152 /**
153 * The URI identifying the ultimate receiver of the SOAP 1.2 message.
154 * @since SAAJ 1.3
155 */
156 public static final String
157 URI_SOAP_1_2_ROLE_ULTIMATE_RECEIVER =
158 URI_NS_SOAP_1_2_ENVELOPE + "/role/ultimateReceiver";
159
160 /**
161 * The default namespace prefix for http://www.w3.org/2003/05/soap-envelope
162 * @since SAAJ 1.3
163 */
164 public static final String SOAP_ENV_PREFIX = "env";
165
166 /**
167 * SOAP 1.2 VersionMismatch Fault
168 * @since SAAJ 1.3
169 */
170 public static final QName SOAP_VERSIONMISMATCH_FAULT =
171 new QName(URI_NS_SOAP_1_2_ENVELOPE, "VersionMismatch", SOAP_ENV_PREFIX);
172
173 /**
174 * SOAP 1.2 MustUnderstand Fault
175 * @since SAAJ 1.3
176 */
177 public static final QName SOAP_MUSTUNDERSTAND_FAULT =
178 new QName(URI_NS_SOAP_1_2_ENVELOPE, "MustUnderstand", SOAP_ENV_PREFIX);
179
180 /**
181 * SOAP 1.2 DataEncodingUnknown Fault
182 * @since SAAJ 1.3
183 */
184 public static final QName SOAP_DATAENCODINGUNKNOWN_FAULT =
185 new QName(URI_NS_SOAP_1_2_ENVELOPE, "DataEncodingUnknown", SOAP_ENV_PREFIX);
186
187 /**
188 * SOAP 1.2 Sender Fault
189 * @since SAAJ 1.3
190 */
191 public static final QName SOAP_SENDER_FAULT =
192 new QName(URI_NS_SOAP_1_2_ENVELOPE, "Sender", SOAP_ENV_PREFIX);
193
194 /**
195 * SOAP 1.2 Receiver Fault
196 * @since SAAJ 1.3
197 */
198 public static final QName SOAP_RECEIVER_FAULT =
199 new QName(URI_NS_SOAP_1_2_ENVELOPE, "Receiver", SOAP_ENV_PREFIX);
200
201 }
|
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.xml.soap;
27
28 import javax.xml.namespace.QName;
29
30 /**
31 * The definition of constants pertaining to the SOAP protocol.
32 *
33 * @since 1.6
34 */
35 public interface SOAPConstants {
36 /**
37 * Used to create <code>MessageFactory</code> instances that create
38 * <code>SOAPMessages</code> whose concrete type is based on the
39 * <code>Content-Type</code> MIME header passed to the
40 * <code>createMessage</code> method. If no <code>Content-Type</code>
41 * header is passed then the <code>createMessage</code> may throw an
42 * <code>IllegalArgumentException</code> or, in the case of the no
43 * argument version of <code>createMessage</code>, an
44 * <code>UnsupportedOperationException</code>.
45 *
46 * @since 1.6, SAAJ 1.3
47 */
48 public static final String DYNAMIC_SOAP_PROTOCOL = "Dynamic Protocol";
49
50 /**
51 * Used to create <code>MessageFactory</code> instances that create
52 * <code>SOAPMessages</code> whose behavior supports the SOAP 1.1 specification.
53 *
54 * @since 1.6, SAAJ 1.3
55 */
56 public static final String SOAP_1_1_PROTOCOL = "SOAP 1.1 Protocol";
57
58 /**
59 * Used to create <code>MessageFactory</code> instances that create
60 * <code>SOAPMessages</code> whose behavior supports the SOAP 1.2
61 * specification
62 *
63 * @since 1.6, SAAJ 1.3
64 */
65 public static final String SOAP_1_2_PROTOCOL = "SOAP 1.2 Protocol";
66
67 /**
68 * The default protocol: SOAP 1.1 for backwards compatibility.
69 *
70 * @since 1.6, SAAJ 1.3
71 */
72 public static final String DEFAULT_SOAP_PROTOCOL = SOAP_1_1_PROTOCOL;
73
74 /**
75 * The namespace identifier for the SOAP 1.1 envelope.
76 * @since 1.6, SAAJ 1.3
77 */
78 public static final String
79 URI_NS_SOAP_1_1_ENVELOPE = "http://schemas.xmlsoap.org/soap/envelope/";
80 /**
81 * The namespace identifier for the SOAP 1.2 envelope.
82 * @since 1.6, SAAJ 1.3
83 */
84 public static final String
85 URI_NS_SOAP_1_2_ENVELOPE = "http://www.w3.org/2003/05/soap-envelope";
86
87 /**
88 * The namespace identifier for the SOAP 1.1 envelope, All SOAPElements in this
89 * namespace are defined by the SOAP 1.1 specification.
90 */
91 public static final String
92 URI_NS_SOAP_ENVELOPE = URI_NS_SOAP_1_1_ENVELOPE;
93
94 /**
95 * The namespace identifier for the SOAP 1.1 encoding.
96 * An attribute named <code>encodingStyle</code> in the
97 * <code>URI_NS_SOAP_ENVELOPE</code> namespace and set to the value
98 * <code>URI_NS_SOAP_ENCODING</code> can be added to an element to indicate
99 * that it is encoded using the rules in section 5 of the SOAP 1.1
100 * specification.
101 */
102 public static final String
103 URI_NS_SOAP_ENCODING = "http://schemas.xmlsoap.org/soap/encoding/";
104
105 /**
106 * The namespace identifier for the SOAP 1.2 encoding.
107 * @since 1.6, SAAJ 1.3
108 */
109 public static final String
110 URI_NS_SOAP_1_2_ENCODING = "http://www.w3.org/2003/05/soap-encoding";
111
112 /**
113 * The media type of the <code>Content-Type</code> MIME header in SOAP 1.1.
114 * @since 1.6, SAAJ 1.3
115 */
116 public static final String
117 SOAP_1_1_CONTENT_TYPE = "text/xml";
118
119 /**
120 * The media type of the <code>Content-Type</code> MIME header in SOAP 1.2.
121 * @since 1.6, SAAJ 1.3
122 */
123 public static final String
124 SOAP_1_2_CONTENT_TYPE = "application/soap+xml";
125
126 /**
127 * The URI identifying the next application processing a SOAP request as the intended
128 * actor for a SOAP 1.1 header entry (see section 4.2.2 of the SOAP 1.1 specification).
129 * <p>
130 * This value can be passed to
131 * {@link SOAPHeader#examineMustUnderstandHeaderElements(String)},
132 * {@link SOAPHeader#examineHeaderElements(String)} and
133 * {@link SOAPHeader#extractHeaderElements(String)}
134 */
135 public static final String
136 URI_SOAP_ACTOR_NEXT = "http://schemas.xmlsoap.org/soap/actor/next";
137
138 /**
139 * The URI identifying the next application processing a SOAP request as the intended
140 * role for a SOAP 1.2 header entry (see section 2.2 of part 1 of the SOAP 1.2
141 * specification).
142 * @since 1.6, SAAJ 1.3
143 */
144 public static final String
145 URI_SOAP_1_2_ROLE_NEXT = URI_NS_SOAP_1_2_ENVELOPE + "/role/next";
146
147 /**
148 * The URI specifying the role None in SOAP 1.2.
149 * @since 1.6, SAAJ 1.3
150 */
151 public static final String
152 URI_SOAP_1_2_ROLE_NONE = URI_NS_SOAP_1_2_ENVELOPE + "/role/none";
153
154 /**
155 * The URI identifying the ultimate receiver of the SOAP 1.2 message.
156 * @since 1.6, SAAJ 1.3
157 */
158 public static final String
159 URI_SOAP_1_2_ROLE_ULTIMATE_RECEIVER =
160 URI_NS_SOAP_1_2_ENVELOPE + "/role/ultimateReceiver";
161
162 /**
163 * The default namespace prefix for http://www.w3.org/2003/05/soap-envelope
164 * @since 1.6, SAAJ 1.3
165 */
166 public static final String SOAP_ENV_PREFIX = "env";
167
168 /**
169 * SOAP 1.2 VersionMismatch Fault
170 * @since 1.6, SAAJ 1.3
171 */
172 public static final QName SOAP_VERSIONMISMATCH_FAULT =
173 new QName(URI_NS_SOAP_1_2_ENVELOPE, "VersionMismatch", SOAP_ENV_PREFIX);
174
175 /**
176 * SOAP 1.2 MustUnderstand Fault
177 * @since 1.6, SAAJ 1.3
178 */
179 public static final QName SOAP_MUSTUNDERSTAND_FAULT =
180 new QName(URI_NS_SOAP_1_2_ENVELOPE, "MustUnderstand", SOAP_ENV_PREFIX);
181
182 /**
183 * SOAP 1.2 DataEncodingUnknown Fault
184 * @since 1.6, SAAJ 1.3
185 */
186 public static final QName SOAP_DATAENCODINGUNKNOWN_FAULT =
187 new QName(URI_NS_SOAP_1_2_ENVELOPE, "DataEncodingUnknown", SOAP_ENV_PREFIX);
188
189 /**
190 * SOAP 1.2 Sender Fault
191 * @since 1.6, SAAJ 1.3
192 */
193 public static final QName SOAP_SENDER_FAULT =
194 new QName(URI_NS_SOAP_1_2_ENVELOPE, "Sender", SOAP_ENV_PREFIX);
195
196 /**
197 * SOAP 1.2 Receiver Fault
198 * @since 1.6, SAAJ 1.3
199 */
200 public static final QName SOAP_RECEIVER_FAULT =
201 new QName(URI_NS_SOAP_1_2_ENVELOPE, "Receiver", SOAP_ENV_PREFIX);
202
203 }
|