de.narimo.geocore.ws.auth.filter

Class BasicAuthenticationFilter

java.lang.Object

de.narimo.geocore.ws.auth.filter.BasicAuthenticationFilter

All Implemented Interfaces:

javax.ws.rs.container.ContainerRequestFilter

Direct Known Subclasses:

CookieAuthenticationFilter, InternalBasicFilter

public abstract class BasicAuthenticationFilter
extends Object
implements javax.ws.rs.container.ContainerRequestFilter

Request filter class for basic authentication. This filter class should not be used for authentication itself. Use Filter implementations overriding authenticate() method. If no authentication details have been provided, filter refuses a request including www-authenticate header.

Author:

Ulrich Mann

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticationFilter()

Method Summary

Modifier and Type	Method and Description
void	authenticateBasic(javax.ws.rs.container.ContainerRequestContext requestContext, de.narimo.commons.UserCredentials credentials) Authentication method which must be overridden by implementing filters.
void	filter(javax.ws.rs.container.ContainerRequestContext requestContext)
ArrayList<String>	getRoles() Simply returns default roles.
de.narimo.commons.UserCredentials	handleNoAuthenticationHeader(javax.ws.rs.container.ContainerRequestContext crc, javax.servlet.http.HttpServletRequest httpRequest) Handles a request, if no authorization header was sent with the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthenticationFilter

public BasicAuthenticationFilter()

Method Detail

filter

public void filter(javax.ws.rs.container.ContainerRequestContext requestContext)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerRequestFilter

Throws:

IOException

authenticateBasic

public void authenticateBasic(javax.ws.rs.container.ContainerRequestContext requestContext,
                              de.narimo.commons.UserCredentials credentials)
                       throws Exception

Authentication method which must be overridden by implementing filters. This filter class should not be used for authentication itself.

Throws:

Exception

handleNoAuthenticationHeader

public de.narimo.commons.UserCredentials handleNoAuthenticationHeader(javax.ws.rs.container.ContainerRequestContext crc,
                                                                      javax.servlet.http.HttpServletRequest httpRequest)
                                                               throws javax.ws.rs.NotFoundException

Handles a request, if no authorization header was sent with the request. If overriding this method in a derived filter, we should always make sure to return null credentials.

Throws:

javax.ws.rs.NotFoundException

getRoles

public ArrayList<String> getRoles()
                           throws Exception

Simply returns default roles.

Parameters:

jdbcMeta -

username -

Returns:

Throws:

Exception