HeaderMatcher (pac4j core 4.0.0-RC2 API)

java.lang.Object
- org.pac4j.core.matching.HeaderMatcher

All Implemented Interfaces:

Matcher
```
public class HeaderMatcher
extends Object
implements Matcher
```
Matching on a HTTP header.

Since:

1.9.3

Author:

Jerome Leleu

Field Summary

Fields
Modifier and Type Field Description

protected Pattern pattern

Constructor Summary

Constructors
Constructor Description

HeaderMatcher()

HeaderMatcher(String headerName, String expectedValue)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getExpectedValue()`
`String`	`getHeaderName()`
`boolean`	`matches(WebContext context)`	Check if the web context matches.
`void`	`setExpectedValue(String expectedValue)`
`void`	`setHeaderName(String headerName)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- pattern
```
protected Pattern pattern
```

Constructor Detail

HeaderMatcher
```
public HeaderMatcher()
```

HeaderMatcher

public HeaderMatcher(String headerName,
                     String expectedValue)

Method Detail
- matches
```
public boolean matches(WebContext context)
```
  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
- getHeaderName
```
public String getHeaderName()
```
- setHeaderName
```
public void setHeaderName(String headerName)
```
- getExpectedValue
```
public String getExpectedValue()
```
- setExpectedValue
```
public void setExpectedValue(String expectedValue)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object