org.pac4j.core.matching

Class HeaderMatcher

java.lang.Object

org.pac4j.core.matching.HeaderMatcher

All Implemented Interfaces:

Matcher

public class HeaderMatcher
extends java.lang.Object
implements Matcher

Matching on a HTTP header.

Since:

1.9.3

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.regex.Pattern	pattern

Constructor Summary

Constructors

Constructor and Description
HeaderMatcher()
HeaderMatcher(java.lang.String headerName, java.lang.String expectedValue)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExpectedValue()
java.lang.String	getHeaderName()
boolean	matches(WebContext context) Check if the web context matches.
void	setExpectedValue(java.lang.String expectedValue)
void	setHeaderName(java.lang.String headerName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

pattern

protected java.util.regex.Pattern pattern

Constructor Detail

HeaderMatcher

public HeaderMatcher()

HeaderMatcher

public HeaderMatcher(java.lang.String headerName,
                     java.lang.String expectedValue)

Method Detail

matches

public boolean matches(WebContext context)
                throws HttpAction

Description copied from interface: Matcher

Check if the web context matches.

Specified by:

matches in interface Matcher

Parameters:

context - the web context

Returns:

whether the web context matches

Throws:

HttpAction - whether an additional HTTP action is required

getHeaderName

public java.lang.String getHeaderName()

setHeaderName

public void setHeaderName(java.lang.String headerName)

getExpectedValue

public java.lang.String getExpectedValue()

setExpectedValue

public void setExpectedValue(java.lang.String expectedValue)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object