Class MessageContext

java.lang.Object
org.apache.axis2.jaxws.core.MessageContext

public class MessageContext extends Object
The org.apache.axis2.jaxws.core.MessageContext is an interface that extends the JAX-WS 2.0 jakarta.xml.ws.handler.MessageContext defined in the spec. This encapsulates all of the functionality needed of the MessageContext for the other JAX-WS spec pieces (the handlers for example) and also provides the needed bits of contextual information for the rest of the JAX-WS implementation.

Specifically, this is responsible for providing APIs so that the client and server implementation portions can get to the Message, defined by the Message Model format and also any metadata that is available.

  • Constructor Details

    • MessageContext

      public MessageContext()
      Construct a MessageContext without a prior Axis2 MessageContext (usage outbound dispatch/proxy)
    • MessageContext

      public MessageContext(org.apache.axis2.context.MessageContext mc) throws jakarta.xml.ws.WebServiceException
      Construct a MessageContext with a prior MessageContext (usage inbound client/server or outbound server)
      Parameters:
      mc -
      Throws:
      jakarta.xml.ws.WebServiceException
  • Method Details

    • getInvocationContext

      public InvocationContext getInvocationContext()
    • setInvocationContext

      public void setInvocationContext(InvocationContext ic)
    • getProperties

      public Map<String,Object> getProperties()
    • setProperties

      public void setProperties(Map<String,Object> _properties)
    • getProperty

      public Object getProperty(String key)
    • containsKey

      public boolean containsKey(Object key)
    • setProperty

      public Object setProperty(String key, Object value)
    • setPropertyNoReturn

      public void setPropertyNoReturn(String key, Object value)
      Like getProperty, but does not return prior value. This method should be used in scenarios where the prior value is not needed.
      Parameters:
      key - String
      value - Object
    • getEndpointDescription

      public org.apache.axis2.jaxws.description.EndpointDescription getEndpointDescription()
    • setEndpointDescription

      public void setEndpointDescription(org.apache.axis2.jaxws.description.EndpointDescription ed)
    • getOperationDescription

      public org.apache.axis2.jaxws.description.OperationDescription getOperationDescription()
    • setOperationDescription

      public void setOperationDescription(org.apache.axis2.jaxws.description.OperationDescription od)
    • getMode

      public jakarta.xml.ws.Service.Mode getMode()
    • setMode

      public void setMode(jakarta.xml.ws.Service.Mode m)
    • getOperationName

      public QName getOperationName()
    • setOperationName

      public void setOperationName(QName op)
    • setMessage

      public void setMessage(Message msg)
    • getMessage

      public Message getMessage()
    • getAxisMessageContext

      public org.apache.axis2.context.MessageContext getAxisMessageContext()
    • getClassLoader

      public ClassLoader getClassLoader()
    • isMaintainSession

      public boolean isMaintainSession()
      Used to determine whether or not session state has been enabled.
      Returns:
    • getLocalException

      public Throwable getLocalException()
      The local exception is the Throwable object held on the Message from a problem that occurred due to something other than the server. In other words, no message ever travelled across the wire.
      Returns:
      the Throwable object or null
    • setLocalException

      public void setLocalException(Throwable t)
      The local exception is the Throwable object held on the Message from a problem that occurred due to something other than the server. In other words, no message ever travelled across the wire.
      Parameters:
      t -
      See Also:
    • setCausedByException

      public void setCausedByException(org.apache.axis2.AxisFault t)
      Parameters:
      t -
    • getCausedByException

      public org.apache.axis2.AxisFault getCausedByException()
      Returns:
    • setMEPContext

      public void setMEPContext(MEPContext mepCtx)
      Set the wrapper MEPContext. Internally, this method also sets the MEPContext's children so the pointer is bi-directional; you can get the MEPContext from the MessageContext and vice-versa.
      Parameters:
      mepCtx -
    • getMEPContext

      public MEPContext getMEPContext()
    • isOutbound

      public boolean isOutbound()
      Returns:
      if outbound MessageContext
    • setOutbound

      public void setOutbound(boolean isOutbound)
      Parameters:
      isOutbound - true if outbound MessageContext
    • isServer

      public boolean isServer()
      Returns:
      true if server role
    • setServer

      public void setServer(boolean isServer)
      Indicate if server role
      Parameters:
      isServer -
    • freeInputStream

      public void freeInputStream() throws IOException
      Free the resources associated with the incoming input stream. (i.e. HTTPInputStream) This allows the transport layer to free resources and pool connections
      Throws:
      IOException