Package org.apache.axis2.jaxws

Interface Constants

  • public interface Constants
    Constants that apply to the JAX-WS implementation.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String CHECKED_EXCEPTION
      If a checked exception is thrown by the webservice's webmethod, then the name of the checked exception is placed in the outbound response context.
      static String DISABLE_ENDPOINT_PUBLISH_METHODS
      Context Property: Name: jaxws.endpoint.publish.disable Value: String "false" or "true" Default: null, which is interpreted as "false" Can be set on: - Axis Configuration, which affects all jax-ws endpoints Indicates if the javax.xml.ws.Endpoint.publish methods should be disabled, throwing an exception if they are called.
      static String DISABLE_SOAPFAULT_FOR_LOCAL_EXCEPTION
      Context Property: Name: jaxws.soapfault.local.exceptions.disable Value: String "false" or "true" Default: null, which is interpreted as "false" Can be set on: - Axis Configuration, which affects all jax-ws clients Indicates if local exceptions encountered by a JAX-WS client should be turned into a SOAPFaultException and then call the appropriate JAX-WS application handlers handleFault()methods with that SOAPFault in the message.
      static String DISPATCH_CLIENT_OUTBOUND_RESOLUTION
      Context Property: Name: jaxws.dispatch.outbound.operation.resolution.enable Value: String "false" or "true" Default: null, which is interpreted as "true" Can be set on: - Axis Configuration, which affects operation resolution across all Dispatch clients - Request message context, which affects only the Dispatch client using that context.
      static String ENDPOINT_CONTEXT_MAP  
      static String JAXWS_ENABLE_JAXB_PAYLOAD_STREAMING
      Deprecated.
      see JAXWS_PAYLOAD_HIGH_FIDELITY
      static String JAXWS_INBOUND_SOAP_HEADERS  
      static String JAXWS_JAXB_WRITE_REMOVE_ILLEGAL_CHARS
      Context Property: Name: jaxws.jaxb.write.remove.illegal.chars Value: Boolean.TRUE or Boolean.FALSE Default: null, which is interpreted as FALSE.
      static String JAXWS_MESSAGE_ACCESSOR
      javax.xml.ws.handler.MessageContext Property: Name: jaxws.message.as.string Value: null or MessageAccessor Description: A handler or resource injection @WebServiceContext may use this property to get access to a MessageAccessor object.
      static String JAXWS_OUTBOUND_SOAP_HEADERS  
      static String JAXWS_PAYLOAD_HIGH_FIDELITY
      Context Property: Name: jaxws.payload.highFidelity Value: Boolean.TRUE or Boolean.FALSE Default: null, which is interpreted as FALSE....engine may set this to TRUE in some cases.
      static String JAXWS_PROVIDER_NULL_ONEWAY
      Context Property: Name: jaxws.provider.interpretNullAsOneway Value: Boolean.TRUE or Boolean.FALSE Default: TRUE.
      static String JAXWS_WEBMETHOD_EXCEPTION
      If an exception is thrown by the JAXWS webservice's webmethod, the Throwable object is placed in the service outbound response context.
      static String MEP_CONTEXT  
      static String SOAP_HTTP_BINDING
      This constant introduces an extension for @BindingType annotation.
      static String THROW_EXCEPTION_IF_SOAP_FAULT
      This constant will be used to determine if a Exception will be throw by JAX-WS layer when a SOAP Fault is received on response.
      static String WRITE_HEADER_ELEMENT_IF_NULL
      Context Property: Name: jaxws.header.parameter.isNull.write.element.with.xsi.nil Value: Boolean.TRUE or Boolean.FALSE Default: null, which is interpretted as Boolean.TRUE If the @WebParam indicates that the parameter is mapped to a header and the argument for the parameter is null, this property is queried by the JAX-WS runtime to determine if a) TRUE: A SOAP header element is serialized with an xsi:nil="true" attribute b) FALSE: No SOAP header element is serialized.
      static String WS_CACHE
      This constant will be used to store the location of JAX-WS generated artifacts cache.

    • Field Detail

      • JAXWS_ENABLE_JAXB_PAYLOAD_STREAMING

        static final String JAXWS_ENABLE_JAXB_PAYLOAD_STREAMING
        Deprecated.
        see JAXWS_PAYLOAD_HIGH_FIDELITY
        Value that can be set on a MessageContext. The property value should be a Boolean() If set to false, then JAXB streaming of the XML body is disabled. A value of false will result in slower performance for unmarshalling JAXB objects but is a loss-less transformation. A value of true will cause the JAXB objects to be created when the XML body is initially parsed, which is more performant, but it may loose some information contained in the original XML such as namespace prefixes if the XML stream is recreated from the JAXB objects. The default value is Boolean(true) if this property is not set.
        See Also:
        Constant Field Values

      • JAXWS_PAYLOAD_HIGH_FIDELITY

        static final String JAXWS_PAYLOAD_HIGH_FIDELITY
        Context Property: Name: jaxws.payload.highFidelity Value: Boolean.TRUE or Boolean.FALSE Default: null, which is interpreted as FALSE....engine may set this to TRUE in some cases. Configuration Parameter Name: jaxws.payload.highFidelity Value: String or Boolean representing true or false Default: null, which is interpreted as FALSE Description: If the value is false, the jax-ws engine will transform the message in the most performant manner. In some cases these transformations will cause the loss of some information. For example, JAX-B transformations are lossy. If the value is true, the jax-ws engine will transform the message in the most loss-less manner. In some cases this will result in slower performance. The message in such cases is "high fidelity", which means that it is a close replica of the original message. Customers should accept the default behavior (false), and only set the value to true if it is necessary for a SOAP Handler or other code requires a high fidelity message. The engine will first examine the Context property. If not set, the value of the Configuration property is used.
        See Also:
        Constant Field Values

      • JAXWS_PROVIDER_NULL_ONEWAY

        static final String JAXWS_PROVIDER_NULL_ONEWAY
        Context Property: Name: jaxws.provider.interpretNullAsOneway Value: Boolean.TRUE or Boolean.FALSE Default: TRUE. Configuration Parameter Name: jaxws.provider.interpretNullAsOneway Value: String or Boolean representing true or false Default: true Description: If the value is false, the jax-ws engine will interpret a null response from a provider as an empty response to a two-way operation. As a result it will create a SOAPEnvelope with an empty SOAPBody and send that as a response. If the value is true, the jax-ws engine will intrepret a null return value from a provider as an indication of a one-way operation. As a result, the engine will halt processing on the response. Response handlers will not be invoked. An HTTP acknowledgment will be sent back to the client. No SOAPEnvelope will be sent. You must use one-way client when invoking a Provider which returns null if this property is true. This is only true for operations which are not defined in WSDL. If the operation is defined in WSDL, the WSDL determine the response for a Provider that returns null. If the WSDL defines a two-way operation, a null from a provider will continue to produce a SOAPEnvelope with and empty SOAPBody as the response. The engine will first examine the Context property. If not set, the value of the Configuration property is used.
        See Also:
        Constant Field Values

      • CHECKED_EXCEPTION

        static final String CHECKED_EXCEPTION
        If a checked exception is thrown by the webservice's webmethod, then the name of the checked exception is placed in the outbound response context.
        See Also:
        Constant Field Values

      • JAXWS_WEBMETHOD_EXCEPTION

        static final String JAXWS_WEBMETHOD_EXCEPTION
        If an exception is thrown by the JAXWS webservice's webmethod, the Throwable object is placed in the service outbound response context.
        See Also:
        Constant Field Values

      • SOAP_HTTP_BINDING

        static final String SOAP_HTTP_BINDING
        This constant introduces an extension for @BindingType annotation. When the value of BindingType annotation is set to this constant, the javax.xml.ws.Provider java endpoints will cater to SOAP11 and SOAP12 messages.
        See Also:
        Constant Field Values

      • THROW_EXCEPTION_IF_SOAP_FAULT

        static final String THROW_EXCEPTION_IF_SOAP_FAULT
        This constant will be used to determine if a Exception will be throw by JAX-WS layer when a SOAP Fault is received on response.
        See Also:
        Constant Field Values

      • WRITE_HEADER_ELEMENT_IF_NULL

        static final String WRITE_HEADER_ELEMENT_IF_NULL
        Context Property: Name: jaxws.header.parameter.isNull.write.element.with.xsi.nil Value: Boolean.TRUE or Boolean.FALSE Default: null, which is interpretted as Boolean.TRUE If the @WebParam indicates that the parameter is mapped to a header and the argument for the parameter is null, this property is queried by the JAX-WS runtime to determine if a) TRUE: A SOAP header element is serialized with an xsi:nil="true" attribute b) FALSE: No SOAP header element is serialized. The default is TRUE because the JAX-WS developers feel that this is a safer approach.
        See Also:
        Constant Field Values

      • WS_CACHE

        static final String WS_CACHE
        This constant will be used to store the location of JAX-WS generated artifacts cache.
        See Also:
        Constant Field Values

      • JAXWS_JAXB_WRITE_REMOVE_ILLEGAL_CHARS

        static final String JAXWS_JAXB_WRITE_REMOVE_ILLEGAL_CHARS
        Context Property: Name: jaxws.jaxb.write.remove.illegal.chars Value: Boolean.TRUE or Boolean.FALSE Default: null, which is interpreted as FALSE. Configuration Parameter Name: jaxws.jaxb.write.remove.illegal.chars Value: String or Boolean representing true or false Default: null, which is interpreted as FALSE Description: If the value is true, the jax-ws engine will detect and remove illegal characters (characters not supported in xml) when writing a JAXB data bean associated with a jaxws web method http://www.w3.org/TR/2008/REC-xml-20081126/#NT-Char This extra filter may degrade performance. Customers should accept the default behavior (false), and only set the value to true if the character data produced by their web service is invalid and cannot be filtered by some other mechanism. The engine will first examine the Context property. If not set, the value of the Configuration property is used.
        See Also:
        Constant Field Values

      • JAXWS_MESSAGE_ACCESSOR

        static final String JAXWS_MESSAGE_ACCESSOR
        javax.xml.ws.handler.MessageContext Property: Name: jaxws.message.as.string Value: null or MessageAccessor Description: A handler or resource injection @WebServiceContext may use this property to get access to a MessageAccessor object. The MessageAccessor contains methods to allow a user to get additional attributes from the message (for example getMessageAsString)
        See Also:
        Constant Field Values

      • DISPATCH_CLIENT_OUTBOUND_RESOLUTION

        static final String DISPATCH_CLIENT_OUTBOUND_RESOLUTION
        Context Property: Name: jaxws.dispatch.outbound.operation.resolution.enable Value: String "false" or "true" Default: null, which is interpreted as "true" Can be set on: - Axis Configuration, which affects operation resolution across all Dispatch clients - Request message context, which affects only the Dispatch client using that context. Indicates if a Dispatch message should be parsed to determine the operation indicated in the message, and use that to determine the Action that should be placed in the outgoing message. The Action would be placed in the SOAPAction HTTP header and any WS-Addressing Action headers if WS-Addressing is enabled. Prior to the introduction of this property and associated support, for Dispatch the client would have to set the Action on the Request Message context in order to get a meaningful value set as the Action. Note that parsing the outgoing message in order to determine the operation indicated in the message can be slow. Therefore, this property is provided to disable that operation resolution. The default, however, is to do operation resolution. Operation resolution will also be disabled on a Dispatch client if an Action was set on the request message context.
        See Also:
        BindingProvider.SOAPACTION_USE_PROPERTY, BindingProvider.SOAPACTION_URI_PROPERTY, Constant Field Values

      • DISABLE_SOAPFAULT_FOR_LOCAL_EXCEPTION

        static final String DISABLE_SOAPFAULT_FOR_LOCAL_EXCEPTION
        Context Property: Name: jaxws.soapfault.local.exceptions.disable Value: String "false" or "true" Default: null, which is interpreted as "false" Can be set on: - Axis Configuration, which affects all jax-ws clients Indicates if local exceptions encountered by a JAX-WS client should be turned into a SOAPFaultException and then call the appropriate JAX-WS application handlers handleFault()methods with that SOAPFault in the message. This is new behavior, which is the default behavior indicated by this property not being set or having a value of "false". The previous behavior was for local exceptions to be turned into a WebServiceException that was set on an empty response message. The appropriate JAX-WS application handers handleMessage() methods would be called with that empty message. Setting this property to "true" will revert to this behavior.
        See Also:
        Constant Field Values

      • DISABLE_ENDPOINT_PUBLISH_METHODS

        static final String DISABLE_ENDPOINT_PUBLISH_METHODS
        Context Property: Name: jaxws.endpoint.publish.disable Value: String "false" or "true" Default: null, which is interpreted as "false" Can be set on: - Axis Configuration, which affects all jax-ws endpoints Indicates if the javax.xml.ws.Endpoint.publish methods should be disabled, throwing an exception if they are called. This may be necessary in a managed environment, since as noted in JSR-109 section 5.3.3 "Publishing Endpoints" using publish is non-portable in managed environments, and managed environments may disallow publishing of endpoints dynamciall. If this property is set, the Endpoint.publish methods will throw an UnsupportedOperationException.
        See Also:
        Constant Field Values