org.picketlink.config.http

Class InboundHeaderConfigurationBuilder

java.lang.Object

org.picketlink.idm.config.Builder<T>

org.picketlink.config.AbstractSecurityConfigurationBuilder<T>

org.picketlink.config.http.AbstracHttpSecurityConfigurationChildBuilder

org.picketlink.config.http.AbstractPathConfigurationChildBuilder

org.picketlink.config.http.InboundHeaderConfigurationBuilder

All Implemented Interfaces:

HttpSecurityConfigurationChildBuilder, PathConfigurationChildBuilder, SecurityConfigurationChildBuilder

public class InboundHeaderConfigurationBuilder
extends AbstractPathConfigurationChildBuilder

Provides a set of options regarding the request headers for a specific request.

Author:

Pedro Igor

Method Summary

Methods

Modifier and Type	Method and Description
InboundHeaderConfigurationBuilder	header(String name, String... value) Defines a header that will be used to identify requests for a specific path.
InboundHeaderConfigurationBuilder	requestedWith(String value) The name of the header used to identify the source of the request.

Methods inherited from class org.picketlink.config.http.AbstractPathConfigurationChildBuilder

authenticateWith, authorizeWith, getBuilder, redirectTo, unprotected

Methods inherited from class org.picketlink.config.http.AbstracHttpSecurityConfigurationChildBuilder

allPaths, forGroup, forPath, forPath, restrictive

Methods inherited from class org.picketlink.config.AbstractSecurityConfigurationBuilder

build, create, http, identity, idmConfig, readFrom, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picketlink.config.http.HttpSecurityConfigurationChildBuilder

allPaths, forGroup, forPath, forPath, restrictive

Methods inherited from interface org.picketlink.config.SecurityConfigurationChildBuilder

build, http, identity, idmConfig

Method Detail

requestedWith

public InboundHeaderConfigurationBuilder requestedWith(String value)

The name of the header used to identify the source of the request. For insance, usefull to identify whether a request came or not from an Ajax client.

This method uses the @{link InboundHeaderConfiguration.X_REQUESTED_WITH_HEADER_NAME}.

Parameters:

value -

Returns:

header

public InboundHeaderConfigurationBuilder header(String name,
                                       String... value)

Defines a header that will be used to identify requests for a specific path.

When a header is defined, it will be used to match a specific request.

Parameters:

name -

value -

Returns: