File Doc Category Size Date Package
ProcessingFilter.java API Doc Example 5084 Tue May 29 16:56:44 BST 2007 com.sun.xml.ws.rm.jaxws.util

ProcessingFilter

public interface ProcessingFilter

Implementing classes provide access to all RM headers on Inbound and Outbound messages in JAX-WS pipeline and provide a way to simulate dropped requests and responses in a JAX-WS client.

Each method takes a com.sun.xml.ws.rm.Message argument. The RM headers can be accessed using the getSequenceElement, getAckRequestedElement and getSequenceAcknowledgement methods, which return com.sun.xml.ws.rm.protocol objects.

The return values of handleClientRequestMessage and handleEndpointResponseMessage methods determine whether the request or response messages message should be processed or "lost".

The RM system will look for the name of a class that implements ProcessingFilter by calling the static method:

ProcessingFilter com.sun.xml.rm.jaxws.runtime.RMProvider.getProcessingFilter().

If non-null, the returned ProcessingFilter will be used. The instance of ProcessingFilter can be set by a test application using the static method:

void com.sun.xml.rm.jaxws.runtime.RMProvider.setProcessingFilter(ProcessingFilter filter);

Fields Summary
Constructors Summary
Methods Summary
public boolean handleClientRequestMessage(com.sun.xml.ws.rm.Message mess)
Use to inspect the RM headers on a client request message. The return value determines whether the message is processed normally or "lost".
param
mess The request message.
return
true if processing should continue, false if message should be "lost"
public boolean handleClientResponseMessage(com.sun.xml.ws.rm.Message mess)
Use to inspect the RM headers on a client response message.
param
mess The response message.
return
true if processing should continue, false if message should be "lost"
public void handleEndpointRequestMessage(com.sun.xml.ws.rm.Message mess)
Use to inspect the RM headers on an Endpoint request message. The return value determines whether the message is processed normally or "lost".
param
mess The request message.
public boolean handleEndpointResponseMessage(com.sun.xml.ws.rm.Message mess)
Use to inspect the RM headers on an Endpoint response message.
param
mess The response message.
public void handleOutboundHeaders(com.sun.xml.ws.rm.Message mess)
Use to inspect or modify headers of outgoing message just before they are marshalled. Use message.getSequenceElement(), message.getSequenceAcknowledgementElement and message.getAckRequested element to obtain the headers.
param
The message to be modified.