Class PacketFilter

  • Direct Known Subclasses:
    RmEnabledCheckFilter

    public abstract class PacketFilter
    extends Object
    Author:
    Marek Potociar (marek.potociar at sun.com)
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static long UNSPECIFIED  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected PacketFilter()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract com.sun.xml.ws.api.message.Packet filterClientRequest​(com.sun.xml.ws.api.message.Packet request)
      Method is called during the client-side request packet processing, which means that it is called BEFORE the request is sent to the service.
      abstract com.sun.xml.ws.api.message.Packet filterServerResponse​(com.sun.xml.ws.api.message.Packet response)
      Method is called during the server-side response packet processing, which means that it is called BEFORE the response is sent to the client.
      protected long getMessageId​(com.sun.xml.ws.api.message.Packet packet)
      Retrieves RM sequence message identifier form the message stored in the packet.
      protected RmRuntimeVersion getRmVersion()
      Provides information on RM version configured on the current web service port.
      protected String getSequenceId​(com.sun.xml.ws.api.message.Packet packet)
      Retrieves RM sequence identifier form the message stored in the packet.
      protected boolean isRmProtocolMessage​(com.sun.xml.ws.api.message.Packet packet)  
    • Constructor Detail

      • PacketFilter

        protected PacketFilter()
    • Method Detail

      • filterClientRequest

        public abstract com.sun.xml.ws.api.message.Packet filterClientRequest​(com.sun.xml.ws.api.message.Packet request)
                                                                       throws Exception
        Method is called during the client-side request packet processing, which means that it is called BEFORE the request is sent to the service.
        Parameters:
        request - original request packet to be filtered
        Returns:
        filtered packet
        Throws:
        Exception - any exception that may occur during processing.
      • filterServerResponse

        public abstract com.sun.xml.ws.api.message.Packet filterServerResponse​(com.sun.xml.ws.api.message.Packet response)
                                                                        throws Exception
        Method is called during the server-side response packet processing, which means that it is called BEFORE the response is sent to the client.
        Parameters:
        response - original response packet to be filtered
        Returns:
        filtered packet
        Throws:
        Exception - any exception that may occur during processing.
      • getSequenceId

        protected final String getSequenceId​(com.sun.xml.ws.api.message.Packet packet)
        Retrieves RM sequence identifier form the message stored in the packet.
        Parameters:
        packet - packet to be checked for the RM sequence identifier
        Returns:
        RM sequence identifier. May return null if there is no RM sequence identifier associated with this packet.
      • getMessageId

        protected final long getMessageId​(com.sun.xml.ws.api.message.Packet packet)
        Retrieves RM sequence message identifier form the message stored in the packet.
        Parameters:
        packet - packet to be checked for the RM message identifier
        Returns:
        RM sequence message identifier. May return UNSPECIFIED if there is no RM message identifier associated with this packet.
      • getRmVersion

        protected final RmRuntimeVersion getRmVersion()
        Provides information on RM version configured on the current web service port. May return null if RM is not enabled on the port.
        Returns:
        RM version configured on the current WS port or null if RM is not enabled.
      • isRmProtocolMessage

        protected final boolean isRmProtocolMessage​(com.sun.xml.ws.api.message.Packet packet)