/*
 * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.xml.soap;

import javax.xml.namespace.QName;

The definition of constants pertaining to the SOAP protocol.
Since:1.6
/** * The definition of constants pertaining to the SOAP protocol. * * @since 1.6 */
public interface SOAPConstants {
Used to create MessageFactory instances that create SOAPMessages whose concrete type is based on the Content-Type MIME header passed to the createMessage method. If no Content-Type header is passed then the createMessage may throw an IllegalArgumentException or, in the case of the no argument version of createMessage, an UnsupportedOperationException.
Since: 1.6, SAAJ 1.3
/** * Used to create {@code MessageFactory} instances that create * {@code SOAPMessages} whose concrete type is based on the * {@code Content-Type} MIME header passed to the * {@code createMessage} method. If no {@code Content-Type} * header is passed then the {@code createMessage} may throw an * {@code IllegalArgumentException} or, in the case of the no * argument version of {@code createMessage}, an * {@code UnsupportedOperationException}. * * @since 1.6, SAAJ 1.3 */
public static final String DYNAMIC_SOAP_PROTOCOL = "Dynamic Protocol";
Used to create MessageFactory instances that create SOAPMessages whose behavior supports the SOAP 1.1 specification.
Since: 1.6, SAAJ 1.3
/** * Used to create {@code MessageFactory} instances that create * {@code SOAPMessages} whose behavior supports the SOAP 1.1 specification. * * @since 1.6, SAAJ 1.3 */
public static final String SOAP_1_1_PROTOCOL = "SOAP 1.1 Protocol";
Used to create MessageFactory instances that create SOAPMessages whose behavior supports the SOAP 1.2 specification
Since: 1.6, SAAJ 1.3
/** * Used to create {@code MessageFactory} instances that create * {@code SOAPMessages} whose behavior supports the SOAP 1.2 * specification * * @since 1.6, SAAJ 1.3 */
public static final String SOAP_1_2_PROTOCOL = "SOAP 1.2 Protocol";
The default protocol: SOAP 1.1 for backwards compatibility.
Since:1.6, SAAJ 1.3
/** * The default protocol: SOAP 1.1 for backwards compatibility. * * @since 1.6, SAAJ 1.3 */
public static final String DEFAULT_SOAP_PROTOCOL = SOAP_1_1_PROTOCOL;
The namespace identifier for the SOAP 1.1 envelope.
Since:1.6, SAAJ 1.3
/** * The namespace identifier for the SOAP 1.1 envelope. * @since 1.6, SAAJ 1.3 */
public static final String URI_NS_SOAP_1_1_ENVELOPE = "http://schemas.xmlsoap.org/soap/envelope/";
The namespace identifier for the SOAP 1.2 envelope.
Since:1.6, SAAJ 1.3
/** * The namespace identifier for the SOAP 1.2 envelope. * @since 1.6, SAAJ 1.3 */
public static final String URI_NS_SOAP_1_2_ENVELOPE = "http://www.w3.org/2003/05/soap-envelope";
The namespace identifier for the SOAP 1.1 envelope, All SOAPElements in this namespace are defined by the SOAP 1.1 specification.
/** * The namespace identifier for the SOAP 1.1 envelope, All SOAPElements in this * namespace are defined by the SOAP 1.1 specification. */
public static final String URI_NS_SOAP_ENVELOPE = URI_NS_SOAP_1_1_ENVELOPE;
The namespace identifier for the SOAP 1.1 encoding. An attribute named encodingStyle in the URI_NS_SOAP_ENVELOPE namespace and set to the value URI_NS_SOAP_ENCODING can be added to an element to indicate that it is encoded using the rules in section 5 of the SOAP 1.1 specification.
/** * The namespace identifier for the SOAP 1.1 encoding. * An attribute named {@code encodingStyle} in the * {@code URI_NS_SOAP_ENVELOPE} namespace and set to the value * {@code URI_NS_SOAP_ENCODING} can be added to an element to indicate * that it is encoded using the rules in section 5 of the SOAP 1.1 * specification. */
public static final String URI_NS_SOAP_ENCODING = "http://schemas.xmlsoap.org/soap/encoding/";
The namespace identifier for the SOAP 1.2 encoding.
Since:1.6, SAAJ 1.3
/** * The namespace identifier for the SOAP 1.2 encoding. * @since 1.6, SAAJ 1.3 */
public static final String URI_NS_SOAP_1_2_ENCODING = "http://www.w3.org/2003/05/soap-encoding";
The media type of the Content-Type MIME header in SOAP 1.1.
Since:1.6, SAAJ 1.3
/** * The media type of the {@code Content-Type} MIME header in SOAP 1.1. * @since 1.6, SAAJ 1.3 */
public static final String SOAP_1_1_CONTENT_TYPE = "text/xml";
The media type of the Content-Type MIME header in SOAP 1.2.
Since:1.6, SAAJ 1.3
/** * The media type of the {@code Content-Type} MIME header in SOAP 1.2. * @since 1.6, SAAJ 1.3 */
public static final String SOAP_1_2_CONTENT_TYPE = "application/soap+xml";
The URI identifying the next application processing a SOAP request as the intended actor for a SOAP 1.1 header entry (see section 4.2.2 of the SOAP 1.1 specification).

This value can be passed to SOAPHeader.examineMustUnderstandHeaderElements(String), SOAPHeader.examineHeaderElements(String) and SOAPHeader.extractHeaderElements(String)

/** * The URI identifying the next application processing a SOAP request as the intended * actor for a SOAP 1.1 header entry (see section 4.2.2 of the SOAP 1.1 specification). * <p> * This value can be passed to * {@link SOAPHeader#examineMustUnderstandHeaderElements(String)}, * {@link SOAPHeader#examineHeaderElements(String)} and * {@link SOAPHeader#extractHeaderElements(String)} */
public static final String URI_SOAP_ACTOR_NEXT = "http://schemas.xmlsoap.org/soap/actor/next";
The URI identifying the next application processing a SOAP request as the intended role for a SOAP 1.2 header entry (see section 2.2 of part 1 of the SOAP 1.2 specification).
Since:1.6, SAAJ 1.3
/** * The URI identifying the next application processing a SOAP request as the intended * role for a SOAP 1.2 header entry (see section 2.2 of part 1 of the SOAP 1.2 * specification). * @since 1.6, SAAJ 1.3 */
public static final String URI_SOAP_1_2_ROLE_NEXT = URI_NS_SOAP_1_2_ENVELOPE + "/role/next";
The URI specifying the role None in SOAP 1.2.
Since:1.6, SAAJ 1.3
/** * The URI specifying the role None in SOAP 1.2. * @since 1.6, SAAJ 1.3 */
public static final String URI_SOAP_1_2_ROLE_NONE = URI_NS_SOAP_1_2_ENVELOPE + "/role/none";
The URI identifying the ultimate receiver of the SOAP 1.2 message.
Since:1.6, SAAJ 1.3
/** * The URI identifying the ultimate receiver of the SOAP 1.2 message. * @since 1.6, SAAJ 1.3 */
public static final String URI_SOAP_1_2_ROLE_ULTIMATE_RECEIVER = URI_NS_SOAP_1_2_ENVELOPE + "/role/ultimateReceiver";
The default namespace prefix for http://www.w3.org/2003/05/soap-envelope
Since:1.6, SAAJ 1.3
/** * The default namespace prefix for http://www.w3.org/2003/05/soap-envelope * @since 1.6, SAAJ 1.3 */
public static final String SOAP_ENV_PREFIX = "env";
SOAP 1.2 VersionMismatch Fault
Since:1.6, SAAJ 1.3
/** * SOAP 1.2 VersionMismatch Fault * @since 1.6, SAAJ 1.3 */
public static final QName SOAP_VERSIONMISMATCH_FAULT = new QName(URI_NS_SOAP_1_2_ENVELOPE, "VersionMismatch", SOAP_ENV_PREFIX);
SOAP 1.2 MustUnderstand Fault
Since:1.6, SAAJ 1.3
/** * SOAP 1.2 MustUnderstand Fault * @since 1.6, SAAJ 1.3 */
public static final QName SOAP_MUSTUNDERSTAND_FAULT = new QName(URI_NS_SOAP_1_2_ENVELOPE, "MustUnderstand", SOAP_ENV_PREFIX);
SOAP 1.2 DataEncodingUnknown Fault
Since:1.6, SAAJ 1.3
/** * SOAP 1.2 DataEncodingUnknown Fault * @since 1.6, SAAJ 1.3 */
public static final QName SOAP_DATAENCODINGUNKNOWN_FAULT = new QName(URI_NS_SOAP_1_2_ENVELOPE, "DataEncodingUnknown", SOAP_ENV_PREFIX);
SOAP 1.2 Sender Fault
Since:1.6, SAAJ 1.3
/** * SOAP 1.2 Sender Fault * @since 1.6, SAAJ 1.3 */
public static final QName SOAP_SENDER_FAULT = new QName(URI_NS_SOAP_1_2_ENVELOPE, "Sender", SOAP_ENV_PREFIX);
SOAP 1.2 Receiver Fault
Since:1.6, SAAJ 1.3
/** * SOAP 1.2 Receiver Fault * @since 1.6, SAAJ 1.3 */
public static final QName SOAP_RECEIVER_FAULT = new QName(URI_NS_SOAP_1_2_ENVELOPE, "Receiver", SOAP_ENV_PREFIX); }