Package org.apache.cxf.rs.security.jose.jaxrs

Class AbstractJwtAuthenticationFilter

java.lang.Object
org.apache.cxf.rs.security.jose.common.AbstractJoseConsumer
org.apache.cxf.rs.security.jose.jwt.JoseJwtConsumer
org.apache.cxf.rs.security.jose.jaxrs.AbstractJwtAuthenticationFilter
All Implemented Interfaces:
jakarta.ws.rs.container.ContainerRequestFilter
Direct Known Subclasses:
JwtAuthenticationFilter, JwtCookieAuthenticationFilter
@PreMatching @Priority(1000) public abstract class AbstractJwtAuthenticationFilter extends org.apache.cxf.rs.security.jose.jwt.JoseJwtConsumer implements jakarta.ws.rs.container.ContainerRequestFilter

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final Logger
    LOG
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractJwtAuthenticationFilter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apache.cxf.security.SecurityContext
    configureSecurityContext(org.apache.cxf.rs.security.jose.jwt.JwtToken jwt)
     
    void
    filter(jakarta.ws.rs.container.ContainerRequestContext requestContext)
     
    protected abstract String
    getEncodedJwtToken(jakarta.ws.rs.container.ContainerRequestContext requestContext)
     
    String
    getRoleClaim()
     
    boolean
    isValidateAudience()
     
    void
    setRoleClaim(String roleClaim)
     
    void
    setValidateAudience(boolean validateAudience)
     
    protected void
    validateToken(org.apache.cxf.rs.security.jose.jwt.JwtToken jwt)
     

    Methods inherited from class org.apache.cxf.rs.security.jose.jwt.JoseJwtConsumer

    getClockOffset, getInitializedSignatureVerifier, getJwtToken, getJwtToken, getTtl, setClockOffset, setTtl

    Methods inherited from class org.apache.cxf.rs.security.jose.common.AbstractJoseConsumer

    checkProcessRequirements, getInitializedDecryptionProvider, getInitializedSignatureVerifier, getJweDecryptor, getJwsVerifier, isJweRequired, isJwsRequired, setJweDecryptor, setJweRequired, setJwsRequired, setJwsVerifier

    Methods inherited from class java.lang.Object

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

  • Field Details

    • LOG

      protected static final Logger LOG

  • Constructor Details

    • AbstractJwtAuthenticationFilter

      public AbstractJwtAuthenticationFilter()

  • Method Details

    • filter

      public void filter(jakarta.ws.rs.container.ContainerRequestContext requestContext) throws IOException
      Specified by:
      filter in interface jakarta.ws.rs.container.ContainerRequestFilter
      Throws:
      IOException

    • getEncodedJwtToken

      protected abstract String getEncodedJwtToken(jakarta.ws.rs.container.ContainerRequestContext requestContext)

    • configureSecurityContext

      protected org.apache.cxf.security.SecurityContext configureSecurityContext(org.apache.cxf.rs.security.jose.jwt.JwtToken jwt)

    • validateToken

      protected void validateToken(org.apache.cxf.rs.security.jose.jwt.JwtToken jwt)
      Overrides:
      validateToken in class org.apache.cxf.rs.security.jose.jwt.JoseJwtConsumer

    • getRoleClaim

      public String getRoleClaim()

    • setRoleClaim

      public void setRoleClaim(String roleClaim)

    • isValidateAudience

      public boolean isValidateAudience()

    • setValidateAudience

      public void setValidateAudience(boolean validateAudience)