Package org.forgerock.openig.filter

Class HeaderFilter.Builder

java.lang.Object

org.forgerock.openig.filter.HeaderFilter.Builder

Enclosing class:

HeaderFilter

public static final class HeaderFilter.Builder
extends Object

HeaderFilter Builder.

Constructor Summary

Constructors

Constructor	Description
Builder(MessageType messageType)	Construct the HeaderFilter.Builder with its associated MessageType.

Method Summary

Modifier and Type	Method	Description
HeaderFilter.Builder	addHeader(String headerName, Expression<String> valueExpression)	Add header with associated value.
HeaderFilter	build()	Build a HeaderFilter with the set configuration.
HeaderFilter.Builder	removeHeader(String headerName)	Remove single header from the existing headers.
HeaderFilter.Builder	removeHeaders(Collection<String> headerNames)	Remove headers from the existing headers.
HeaderFilter.Builder	replaceHeader(String headerName, Expression<String> newValueExpression)	Replace existing header with the given new value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(MessageType messageType)

Construct the HeaderFilter.Builder with its associated MessageType.

Parameters:

messageType - the MessageType

Method Details

addHeader

public HeaderFilter.Builder addHeader(String headerName,
 Expression<String> valueExpression)

Add header with associated value.

Parameters:

headerName - the header name to add

valueExpression - the header value associated

Returns:

the HeaderFilter.Builder

removeHeaders

public HeaderFilter.Builder removeHeaders(Collection<String> headerNames)

Remove headers from the existing headers.

Parameters:

headerNames - the header names to remove

Returns:

the HeaderFilter.Builder

removeHeader

public HeaderFilter.Builder removeHeader(String headerName)

Remove single header from the existing headers.

Parameters:

headerName - the header name to remove

Returns:

the HeaderFilter.Builder

replaceHeader

public HeaderFilter.Builder replaceHeader(String headerName,
 Expression<String> newValueExpression)

Replace existing header with the given new value.

Parameters:

headerName - the header name to replace

newValueExpression - the new header value associated

Returns:

the HeaderFilter.Builder

build

public HeaderFilter build()

Build a HeaderFilter with the set configuration.

Returns:

the HeaderFilter built