Class ApiKeyAuthenticationFilter

  • All Implemented Interfaces:
    javax.ws.rs.container.ContainerRequestFilter
    Direct Known Subclasses:
    GeorepoAuthenticationFilter

    public abstract class ApiKeyAuthenticationFilter
    extends BearerAuthenticationFilter
    Request filter class for apikey authentication. This filter class should not be used for authentication itself. Use Filter implementation. If no authentication details have been provided, filter refuses a request including www-authenticate header.
    Author:
    Ulrich Mann
    • Constructor Detail

      • ApiKeyAuthenticationFilter

        public ApiKeyAuthenticationFilter()
    • Method Detail

      • filter

        public void filter​(javax.ws.rs.container.ContainerRequestContext requestContext)
                    throws IOException
        Specified by:
        filter in interface javax.ws.rs.container.ContainerRequestFilter
        Overrides:
        filter in class BearerAuthenticationFilter
        Throws:
        IOException
      • authenticateApiKey

        public de.narimo.commons.UserCredentials authenticateApiKey​(javax.ws.rs.container.ContainerRequestContext requestContext,
                                                                    String apiKey)
                                                             throws Exception
        Authentication method for session tokens which must be overridden by implementing filters. This filter class should not be used for authentication itself.
        Throws:
        Exception