Package org.forgerock.openig.filter

Class CookieFilter.Builder

java.lang.Object

org.forgerock.openig.filter.CookieFilter.Builder

Enclosing class:

CookieFilter

public static final class CookieFilter.Builder
extends Object

Builder class capable of building a CookieFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CookieFilter	build()	Build a CookieFilter with the supplied configuration.
CookieFilter.Builder	defaultAction(CookieFilter.Action defaultAction)	Set the default action to perform for cookies that do not match an CookieFilter.Action set.
CookieFilter.Builder	managed(Set<String> managed)	Set the CookieFilter.Action set for cookies to be managed.
CookieFilter.Builder	policy(CookiePolicy policy)	Set the policy for managed cookies.
CookieFilter.Builder	relayed(Set<String> relayed)	Set the CookieFilter.Action set for cookies to be relayed.
CookieFilter.Builder	suppressed(Set<String> suppressed)	Set the CookieFilter.Action set for cookies to be suppressed.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

defaultAction

public CookieFilter.Builder defaultAction(CookieFilter.Action defaultAction)

Set the default action to perform for cookies that do not match an CookieFilter.Action set. If unset, the default is CookieFilter.Action.MANAGE.

Parameters:

defaultAction - the default action

Returns:

this builder

policy

public CookieFilter.Builder policy(CookiePolicy policy)

Set the policy for managed cookies. Default is to accept all cookies.

Parameters:

policy - the policy for managed cookies.

Returns:

this builder

suppressed

public CookieFilter.Builder suppressed(Set<String> suppressed)

Set the CookieFilter.Action set for cookies to be suppressed.

Parameters:

suppressed - cookies to be suppressed

Returns:

this builder

relayed

public CookieFilter.Builder relayed(Set<String> relayed)

Set the CookieFilter.Action set for cookies to be relayed.

Parameters:

relayed - cookies to be relayed

Returns:

this builder

managed

public CookieFilter.Builder managed(Set<String> managed)

Set the CookieFilter.Action set for cookies to be managed.

Parameters:

managed - cookies to be managed

Returns:

this builder

build

public CookieFilter build()

Build a CookieFilter with the supplied configuration.

Returns:

a new CookieFilter