jaxws/src/share/jaxws_classes/javax/xml/soap/SOAPConstants.java
changeset 25840 c2002453eec3
parent 22679 d785acd84a14
equal deleted inserted replaced
25686:615e5efca19c 25840:c2002453eec3
    27 
    27 
    28 import javax.xml.namespace.QName;
    28 import javax.xml.namespace.QName;
    29 
    29 
    30 /**
    30 /**
    31  * The definition of constants pertaining to the SOAP protocol.
    31  * The definition of constants pertaining to the SOAP protocol.
       
    32  *
       
    33  * @since 1.6
    32  */
    34  */
    33 public interface SOAPConstants {
    35 public interface SOAPConstants {
    34     /**
    36     /**
    35      * Used to create <code>MessageFactory</code> instances that create
    37      * Used to create <code>MessageFactory</code> instances that create
    36      * <code>SOAPMessages</code> whose concrete type is based on the
    38      * <code>SOAPMessages</code> whose concrete type is based on the
    39      * header is passed then the <code>createMessage</code> may throw an
    41      * header is passed then the <code>createMessage</code> may throw an
    40      * <code>IllegalArgumentException</code> or, in the case of the no
    42      * <code>IllegalArgumentException</code> or, in the case of the no
    41      * argument version of <code>createMessage</code>, an
    43      * argument version of <code>createMessage</code>, an
    42      * <code>UnsupportedOperationException</code>.
    44      * <code>UnsupportedOperationException</code>.
    43      *
    45      *
    44      * @since  SAAJ 1.3
    46      * @since  1.6, SAAJ 1.3
    45      */
    47      */
    46     public static final String DYNAMIC_SOAP_PROTOCOL = "Dynamic Protocol";
    48     public static final String DYNAMIC_SOAP_PROTOCOL = "Dynamic Protocol";
    47 
    49 
    48     /**
    50     /**
    49      * Used to create <code>MessageFactory</code> instances that create
    51      * Used to create <code>MessageFactory</code> instances that create
    50      * <code>SOAPMessages</code> whose behavior supports the SOAP 1.1  specification.
    52      * <code>SOAPMessages</code> whose behavior supports the SOAP 1.1  specification.
    51      *
    53      *
    52      * @since  SAAJ 1.3
    54      * @since  1.6, SAAJ 1.3
    53      */
    55      */
    54     public static final String SOAP_1_1_PROTOCOL = "SOAP 1.1 Protocol";
    56     public static final String SOAP_1_1_PROTOCOL = "SOAP 1.1 Protocol";
    55 
    57 
    56     /**
    58     /**
    57      * Used to create <code>MessageFactory</code> instances that create
    59      * Used to create <code>MessageFactory</code> instances that create
    58      * <code>SOAPMessages</code> whose behavior supports the SOAP 1.2
    60      * <code>SOAPMessages</code> whose behavior supports the SOAP 1.2
    59      * specification
    61      * specification
    60      *
    62      *
    61      * @since  SAAJ 1.3
    63      * @since  1.6, SAAJ 1.3
    62      */
    64      */
    63     public static final String SOAP_1_2_PROTOCOL = "SOAP 1.2 Protocol";
    65     public static final String SOAP_1_2_PROTOCOL = "SOAP 1.2 Protocol";
    64 
    66 
    65     /**
    67     /**
    66      * The default protocol: SOAP 1.1 for backwards compatibility.
    68      * The default protocol: SOAP 1.1 for backwards compatibility.
    67      *
    69      *
    68      * @since SAAJ 1.3
    70      * @since 1.6, SAAJ 1.3
    69      */
    71      */
    70     public static final String DEFAULT_SOAP_PROTOCOL = SOAP_1_1_PROTOCOL;
    72     public static final String DEFAULT_SOAP_PROTOCOL = SOAP_1_1_PROTOCOL;
    71 
    73 
    72     /**
    74     /**
    73      * The namespace identifier for the SOAP 1.1 envelope.
    75      * The namespace identifier for the SOAP 1.1 envelope.
    74      * @since SAAJ 1.3
    76      * @since 1.6, SAAJ 1.3
    75      */
    77      */
    76     public static final String
    78     public static final String
    77                 URI_NS_SOAP_1_1_ENVELOPE = "http://schemas.xmlsoap.org/soap/envelope/";
    79                 URI_NS_SOAP_1_1_ENVELOPE = "http://schemas.xmlsoap.org/soap/envelope/";
    78     /**
    80     /**
    79      * The namespace identifier for the SOAP 1.2 envelope.
    81      * The namespace identifier for the SOAP 1.2 envelope.
    80      * @since SAAJ 1.3
    82      * @since 1.6, SAAJ 1.3
    81      */
    83      */
    82     public static final String
    84     public static final String
    83                 URI_NS_SOAP_1_2_ENVELOPE = "http://www.w3.org/2003/05/soap-envelope";
    85                 URI_NS_SOAP_1_2_ENVELOPE = "http://www.w3.org/2003/05/soap-envelope";
    84 
    86 
    85     /**
    87     /**
   100     public static final String
   102     public static final String
   101         URI_NS_SOAP_ENCODING = "http://schemas.xmlsoap.org/soap/encoding/";
   103         URI_NS_SOAP_ENCODING = "http://schemas.xmlsoap.org/soap/encoding/";
   102 
   104 
   103     /**
   105     /**
   104      * The namespace identifier for the SOAP 1.2 encoding.
   106      * The namespace identifier for the SOAP 1.2 encoding.
   105      * @since SAAJ 1.3
   107      * @since 1.6, SAAJ 1.3
   106      */
   108      */
   107     public static final String
   109     public static final String
   108         URI_NS_SOAP_1_2_ENCODING = "http://www.w3.org/2003/05/soap-encoding";
   110         URI_NS_SOAP_1_2_ENCODING = "http://www.w3.org/2003/05/soap-encoding";
   109 
   111 
   110     /**
   112     /**
   111      * The media type  of the <code>Content-Type</code> MIME header in SOAP 1.1.
   113      * The media type  of the <code>Content-Type</code> MIME header in SOAP 1.1.
   112      * @since SAAJ 1.3
   114      * @since 1.6, SAAJ 1.3
   113      */
   115      */
   114     public static final String
   116     public static final String
   115         SOAP_1_1_CONTENT_TYPE = "text/xml";
   117         SOAP_1_1_CONTENT_TYPE = "text/xml";
   116 
   118 
   117     /**
   119     /**
   118      * The media type  of the <code>Content-Type</code> MIME header in SOAP 1.2.
   120      * The media type  of the <code>Content-Type</code> MIME header in SOAP 1.2.
   119      * @since SAAJ 1.3
   121      * @since 1.6, SAAJ 1.3
   120      */
   122      */
   121     public static final String
   123     public static final String
   122         SOAP_1_2_CONTENT_TYPE = "application/soap+xml";
   124         SOAP_1_2_CONTENT_TYPE = "application/soap+xml";
   123 
   125 
   124     /**
   126     /**
   135 
   137 
   136     /**
   138     /**
   137      * The URI identifying the next application processing a SOAP request as the intended
   139      * 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
   140      * role for a SOAP 1.2 header entry (see section 2.2 of part 1 of the SOAP 1.2
   139      * specification).
   141      * specification).
   140      * @since SAAJ 1.3
   142      * @since 1.6, SAAJ 1.3
   141      */
   143      */
   142     public static final String
   144     public static final String
   143         URI_SOAP_1_2_ROLE_NEXT = URI_NS_SOAP_1_2_ENVELOPE + "/role/next";
   145         URI_SOAP_1_2_ROLE_NEXT = URI_NS_SOAP_1_2_ENVELOPE + "/role/next";
   144 
   146 
   145     /**
   147     /**
   146      * The URI specifying the role None in SOAP 1.2.
   148      * The URI specifying the role None in SOAP 1.2.
   147      * @since SAAJ 1.3
   149      * @since 1.6, SAAJ 1.3
   148      */
   150      */
   149     public static final String
   151     public static final String
   150         URI_SOAP_1_2_ROLE_NONE = URI_NS_SOAP_1_2_ENVELOPE + "/role/none";
   152         URI_SOAP_1_2_ROLE_NONE = URI_NS_SOAP_1_2_ENVELOPE + "/role/none";
   151 
   153 
   152     /**
   154     /**
   153      * The URI identifying the ultimate receiver of the SOAP 1.2 message.
   155      * The URI identifying the ultimate receiver of the SOAP 1.2 message.
   154      * @since SAAJ 1.3
   156      * @since 1.6, SAAJ 1.3
   155      */
   157      */
   156     public static final String
   158     public static final String
   157         URI_SOAP_1_2_ROLE_ULTIMATE_RECEIVER =
   159         URI_SOAP_1_2_ROLE_ULTIMATE_RECEIVER =
   158             URI_NS_SOAP_1_2_ENVELOPE + "/role/ultimateReceiver";
   160             URI_NS_SOAP_1_2_ENVELOPE + "/role/ultimateReceiver";
   159 
   161 
   160     /**
   162     /**
   161      * The default namespace prefix for http://www.w3.org/2003/05/soap-envelope
   163      * The default namespace prefix for http://www.w3.org/2003/05/soap-envelope
   162      * @since SAAJ 1.3
   164      * @since 1.6, SAAJ 1.3
   163      */
   165      */
   164     public static final String SOAP_ENV_PREFIX = "env";
   166     public static final String SOAP_ENV_PREFIX = "env";
   165 
   167 
   166     /**
   168     /**
   167      * SOAP 1.2 VersionMismatch Fault
   169      * SOAP 1.2 VersionMismatch Fault
   168      * @since SAAJ 1.3
   170      * @since 1.6, SAAJ 1.3
   169      */
   171      */
   170     public static final QName SOAP_VERSIONMISMATCH_FAULT =
   172     public static final QName SOAP_VERSIONMISMATCH_FAULT =
   171          new QName(URI_NS_SOAP_1_2_ENVELOPE, "VersionMismatch", SOAP_ENV_PREFIX);
   173          new QName(URI_NS_SOAP_1_2_ENVELOPE, "VersionMismatch", SOAP_ENV_PREFIX);
   172 
   174 
   173     /**
   175     /**
   174      * SOAP 1.2 MustUnderstand Fault
   176      * SOAP 1.2 MustUnderstand Fault
   175      * @since SAAJ 1.3
   177      * @since 1.6, SAAJ 1.3
   176      */
   178      */
   177     public static final QName SOAP_MUSTUNDERSTAND_FAULT =
   179     public static final QName SOAP_MUSTUNDERSTAND_FAULT =
   178          new QName(URI_NS_SOAP_1_2_ENVELOPE, "MustUnderstand", SOAP_ENV_PREFIX);
   180          new QName(URI_NS_SOAP_1_2_ENVELOPE, "MustUnderstand", SOAP_ENV_PREFIX);
   179 
   181 
   180     /**
   182     /**
   181      * SOAP 1.2 DataEncodingUnknown Fault
   183      * SOAP 1.2 DataEncodingUnknown Fault
   182      * @since SAAJ 1.3
   184      * @since 1.6, SAAJ 1.3
   183      */
   185      */
   184     public static final QName SOAP_DATAENCODINGUNKNOWN_FAULT =
   186     public static final QName SOAP_DATAENCODINGUNKNOWN_FAULT =
   185          new QName(URI_NS_SOAP_1_2_ENVELOPE, "DataEncodingUnknown", SOAP_ENV_PREFIX);
   187          new QName(URI_NS_SOAP_1_2_ENVELOPE, "DataEncodingUnknown", SOAP_ENV_PREFIX);
   186 
   188 
   187     /**
   189     /**
   188      * SOAP 1.2 Sender Fault
   190      * SOAP 1.2 Sender Fault
   189      * @since SAAJ 1.3
   191      * @since 1.6, SAAJ 1.3
   190      */
   192      */
   191     public static final QName SOAP_SENDER_FAULT =
   193     public static final QName SOAP_SENDER_FAULT =
   192          new QName(URI_NS_SOAP_1_2_ENVELOPE, "Sender", SOAP_ENV_PREFIX);
   194          new QName(URI_NS_SOAP_1_2_ENVELOPE, "Sender", SOAP_ENV_PREFIX);
   193 
   195 
   194     /**
   196     /**
   195      * SOAP 1.2 Receiver Fault
   197      * SOAP 1.2 Receiver Fault
   196      * @since SAAJ 1.3
   198      * @since 1.6, SAAJ 1.3
   197      */
   199      */
   198     public static final QName SOAP_RECEIVER_FAULT =
   200     public static final QName SOAP_RECEIVER_FAULT =
   199          new QName(URI_NS_SOAP_1_2_ENVELOPE, "Receiver", SOAP_ENV_PREFIX);
   201          new QName(URI_NS_SOAP_1_2_ENVELOPE, "Receiver", SOAP_ENV_PREFIX);
   200 
   202 
   201 }
   203 }