org.apache.camel.spi
Interface HeaderFilterStrategy

All Known Implementing Classes:
CxfHeaderFilterStrategy, CxfRsHeaderFilterStrategy, DefaultHeaderFilterStrategy, HttpHeaderFilterStrategy, HttpHeaderFilterStrategy, JmsHeaderFilterStrategy, RestletHeaderFilterStrategy

public interface HeaderFilterStrategy

Interface to allow plug-able implementation to filter header to and from Camel message.

Version:

Nested Class Summary
static class HeaderFilterStrategy.Direction
          The direction is either IN or OUT.
 
Method Summary
 boolean applyFilterToCamelHeaders(String headerName, Object headerValue, Exchange exchange)
          Applies filtering logic to Camel Message header that is going to be copied to target message such as CXF and JMS message.
 boolean applyFilterToExternalHeaders(String headerName, Object headerValue, Exchange exchange)
          Applies filtering logic to an external message header such as CXF and JMS message that is going to be copied to Camel message header.
 

Method Detail

applyFilterToCamelHeaders

boolean applyFilterToCamelHeaders(String headerName,
                                  Object headerValue,
                                  Exchange exchange)
Applies filtering logic to Camel Message header that is going to be copied to target message such as CXF and JMS message.

It returns true if the filtering logic return a match. Otherwise, it returns false. A match means the header should be excluded.

Parameters:
headerName - the header name
headerValue - the header value
exchange - the context to perform filtering
Returns:
true if this header should be filtered out.

applyFilterToExternalHeaders

boolean applyFilterToExternalHeaders(String headerName,
                                     Object headerValue,
                                     Exchange exchange)
Applies filtering logic to an external message header such as CXF and JMS message that is going to be copied to Camel message header.

It returns true if the filtering logic return a match. Otherwise, it returns false. A match means the header should be excluded.

Parameters:
headerName - the header name
headerValue - the header value
exchange - the context to perform filtering
Returns:
true if this header should be filtered out.


Apache CAMEL