HttpHeaderInspectingApiRequestMatcher (Keycloak Spring Security Integration 21.0.0 API)

java.lang.Object
- org.keycloak.adapters.springsecurity.authentication.HttpHeaderInspectingApiRequestMatcher

All Implemented Interfaces:

org.springframework.security.web.util.matcher.RequestMatcher
```
public class HttpHeaderInspectingApiRequestMatcher
extends Object
implements org.springframework.security.web.util.matcher.RequestMatcher
```
RequestMatcher that determines if a given request is an API request or an interactive login request.

Author:

Scott Rossillo

See Also:

RequestMatcher

Nested Class Summary
- Nested classes/interfaces inherited from interface org.springframework.security.web.util.matcher.RequestMatcher
  org.springframework.security.web.util.matcher.RequestMatcher.MatchResult

Field Summary

Fields
Modifier and Type Field Description

protected static String X_REQUESTED_WITH_HEADER

protected static String X_REQUESTED_WITH_HEADER_AJAX_VALUE

Constructor Summary

Constructors
Constructor Description

HttpHeaderInspectingApiRequestMatcher()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`matches(javax.servlet.http.HttpServletRequest request)`	Returns true if the given request is an API request or false if it's an interactive login request.

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

Methods inherited from interface org.springframework.security.web.util.matcher.RequestMatcher
matcher

- Field Detail
  - X_REQUESTED_WITH_HEADER
```
protected static final String X_REQUESTED_WITH_HEADER
```
    See Also:
    
    Constant Field Values
  - X_REQUESTED_WITH_HEADER_AJAX_VALUE
```
protected static final String X_REQUESTED_WITH_HEADER_AJAX_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpHeaderInspectingApiRequestMatcher
```
public HttpHeaderInspectingApiRequestMatcher()
```
- Method Detail
  - matches
```
public boolean matches(javax.servlet.http.HttpServletRequest request)
```
    Returns true if the given request is an API request or false if it's an interactive login request.
    
    Specified by:
    
    matches in interface org.springframework.security.web.util.matcher.RequestMatcher
    
    Parameters:
    
    request - the HttpServletRequest
    
    Returns:
    
    true if the given request is an API request; false otherwise