Package io.micronaut.security.token.jwt.bearer

Class BearerTokenConfigurationProperties

  • All Implemented Interfaces:
    io.micronaut.core.util.Toggleable, BearerTokenConfiguration
    @Requires(property="micronaut.security.token.jwt.bearer.enabled",
          notEquals="false")
@ConfigurationProperties("micronaut.security.token.jwt.bearer")
public class BearerTokenConfigurationProperties
extends java.lang.Object
implements BearerTokenConfiguration
    Default implementation of BearerTokenConfiguration.
    Since:
    1.0
    Author:
    Sergio del Amo

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static boolean DEFAULT_ENABLED  
      static java.lang.String PREFIX  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getHeaderName()  
      java.lang.String getPrefix()  
      boolean isEnabled()  
      void setEnabled​(boolean enabled)
      Set whether to enable bearer token authentication.
      void setHeaderName​(java.lang.String headerName)
      Sets the header name to use.
      void setPrefix​(java.lang.String prefix)
      Sets the prefix to use for the auth token.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BearerTokenConfigurationProperties

        public BearerTokenConfigurationProperties()

    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Specified by:
        isEnabled in interface BearerTokenConfiguration
        Specified by:
        isEnabled in interface io.micronaut.core.util.Toggleable
        Returns:
        a boolean flag indicating whether BearerTokenReader bean should be enabled or not

      • getPrefix

        public java.lang.String getPrefix()
        Specified by:
        getPrefix in interface BearerTokenConfiguration
        Returns:
        a Prefix before the token in the header value. E.g. Bearer

      • setEnabled

        public void setEnabled​(boolean enabled)
        Set whether to enable bearer token authentication. Default value true.
        Parameters:
        enabled - True if enabled

      • setHeaderName

        public void setHeaderName​(java.lang.String headerName)
        Sets the header name to use. Default value "Authorization".
        Parameters:
        headerName - The header name to use

      • setPrefix

        public void setPrefix​(java.lang.String prefix)
        Sets the prefix to use for the auth token. Default value "Bearer".
        Parameters:
        prefix - The prefix to use