Package org.pac4j.core.credentials.extractor

Class HeaderExtractor

java.lang.Object
org.pac4j.core.credentials.extractor.HeaderExtractor
All Implemented Interfaces:
CredentialsExtractor
public class HeaderExtractor extends Object implements CredentialsExtractor
To extract header value.
Since:
1.8.0
Author:
Jerome Leleu

  • Constructor Details

    • HeaderExtractor

      public HeaderExtractor()

      Constructor for HeaderExtractor.

    • HeaderExtractor

      public HeaderExtractor(String headerName, String prefixHeader)

      Constructor for HeaderExtractor.

      Parameters:
      headerName - a String object
      prefixHeader - a String object

  • Method Details

    • getHeaderName

      public String getHeaderName()

      Getter for the field headerName.

      Returns:
      a String object

    • setHeaderName

      public void setHeaderName(String headerName)

      Setter for the field headerName.

      Parameters:
      headerName - a String object

    • getPrefixHeader

      public String getPrefixHeader()

      Getter for the field prefixHeader.

      Returns:
      a String object

    • setPrefixHeader

      public void setPrefixHeader(String prefixHeader)

      Setter for the field prefixHeader.

      Parameters:
      prefixHeader - a String object

    • isTrimValue

      public boolean isTrimValue()

      isTrimValue.

      Returns:
      a boolean

    • setTrimValue

      public void setTrimValue(boolean trimValue)

      Setter for the field trimValue.

      Parameters:
      trimValue - a boolean

    • extract

      public Optional<Credentials> extract(CallContext ctx)
      Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.
      Specified by:
      extract in interface CredentialsExtractor
      Parameters:
      ctx - the current context
      Returns:
      the credentials (optional)