Package com.ibm.wsspi.webservices.handler

Interface GlobalHandlerMessageContext

public interface GlobalHandlerMessageContext
The interface GlobalHandlerMessageContext abstracts the message context that is processed by a global handler in the handle method.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> T
    adapt(Class<T> clazz)
    Using this method to adapt the GlobalHandlerMessageContext to jakarta.xml.ws.handler.soap.SOAPMessageContext or jakarta.xml.ws.handler.LogicalMessageContext.
    boolean
    containsProperty(String name)
    Retrieve whether this GlobalHandlerMessageContext object contains the specified property.
    String
    getEngineType()
    Retrieves the engine type of the processing.
    String
    getFlowType()
    Retrieves flow type of the processing.
    jakarta.servlet.http.HttpServletRequest
    getHttpServletRequest()
    Retrieve HttpServletRequest from this GlobalHandlerMessageContext object
    jakarta.servlet.http.HttpServletResponse
    getHttpServletResponse()
    Retrieve HttpServletResponse from this GlobalHandlerMessageContext object.
    Object
    getProperty(String name)
    Retrieves value of the specified property.
    Iterator<String>
    getPropertyNames()
    Retrieves all the property names available in this GlobalHandlerMessageContext object.
    boolean
    isClientSide()
    Retrieves whether the processing is in ClientSide.
    boolean
    isServerSide()
    Retrieves whether the processing is in ServerSide.
    void
    removeProperty(String name)
    Remove the specified property from this GlobalHandlerMessageContext object.
    void
    setProperty(String name, Object value)
    Associates the specified value with the specified property.

  • Method Details

    • isServerSide

      boolean isServerSide()
      Retrieves whether the processing is in ServerSide.
      Returns:
      true if is in Server side; false otherwise.

    • isClientSide

      boolean isClientSide()
      Retrieves whether the processing is in ClientSide.
      Returns:
      true if is in Client side; false otherwise.

    • getEngineType

      String getEngineType()
      Retrieves the engine type of the processing.
      Returns:
      Engine Type of the processing, the possible value is : "JAX_WS", "JAX_RS", "ALL"

    • getFlowType

      String getFlowType()
      Retrieves flow type of the processing.
      Returns:
      Flow Type of the processing, the possible value is : "IN", "OUT", "INOUT"

    • getProperty

      Object getProperty(String name)
      Retrieves value of the specified property.
      Parameters:
      name - the name of the property to retrieve.
      Returns:
      the value associated with the named property or null if no such property exists.

    • setProperty

      void setProperty(String name, Object value)
      Associates the specified value with the specified property. If there was already a value associated with this property, the old value is replaced.
      Parameters:
      name - the property with which the specified value is to be associated.
      value - the value to be associated with the specified property.

    • getPropertyNames

      Iterator<String> getPropertyNames()
      Retrieves all the property names available in this GlobalHandlerMessageContext object.
      Returns:
      an iterator over all the property names in this GlobalHandlerMessageContext.

    • removeProperty

      void removeProperty(String name)
      Remove the specified property from this GlobalHandlerMessageContext object.
      Parameters:
      name - the property names which will be removed from this GlobalHandlerMessageContext.

    • containsProperty

      boolean containsProperty(String name)
      Retrieve whether this GlobalHandlerMessageContext object contains the specified property.
      Parameters:
      name - the property name
      Returns:
      true is this GlobalHandlerMessageContext object contains the specified property; false otherwise.

    • getHttpServletRequest

      jakarta.servlet.http.HttpServletRequest getHttpServletRequest()
      Retrieve HttpServletRequest from this GlobalHandlerMessageContext object
      Returns:
      the HttpServletRequest from this GlobalHandlerMessageContext or null if no HttpServletRequest exists

    • getHttpServletResponse

      jakarta.servlet.http.HttpServletResponse getHttpServletResponse()
      Retrieve HttpServletResponse from this GlobalHandlerMessageContext object.
      Returns:
      the HttpServletResponse from this GlobalHandlerMessageContext or null if no HttpServletRequest exists.

    • adapt

      <T> T adapt(Class<T> clazz)
      Using this method to adapt the GlobalHandlerMessageContext to jakarta.xml.ws.handler.soap.SOAPMessageContext or jakarta.xml.ws.handler.LogicalMessageContext.
      Parameters:
      clazz - the class which this GlobalHandlerMessageContext will be adpat to
      Returns:
      The apapted messageContext or null if the clazz is none of above.