de.alpharogroup.service.rs.filter

Class AuthenticationFilter

java.lang.Object

de.alpharogroup.service.rs.filter.AuthenticationFilter

All Implemented Interfaces:

javax.ws.rs.container.ContainerRequestFilter

@Provider
 @Priority(value=1000)
public abstract class AuthenticationFilter
extends Object
implements javax.ws.rs.container.ContainerRequestFilter

The class AuthenticationFilter.

Constructor Summary

Constructors

Constructor and Description
AuthenticationFilter()

Method Summary

Modifier and Type	Method and Description
void	filter(javax.ws.rs.container.ContainerRequestContext requestContext)
protected boolean	isSecured() Checks if is the resourceClass is annotated with the annotation Securable.
protected boolean	isSigninPath(String path) Checks if the given path is a sign in path.
protected boolean	isSigninRequest(javax.ws.rs.container.ContainerRequestContext requestContext) Checks if the current request is a is a sign request.
protected Response	newFaultResponse() Factory callback method for create a new Response.
protected String	newRealmValue() Factory callback method for create a new realm value for the header key 'WWW-Authenticate'.
protected SecurityContext	newSecurityContext(String username) Factory method for create a new security context with the given user name.
protected abstract String	onValidateToken(String token) Abstract callback method that checks if the given token is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationFilter

public AuthenticationFilter()

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

isSigninRequest

protected boolean isSigninRequest(javax.ws.rs.container.ContainerRequestContext requestContext)
                           throws Exception

Checks if the current request is a is a sign request.

Parameters:

requestContext - the request context

Returns:

true, if the current request is a is a sign request.

Throws:

Exception - occurs if some error like the scheme is not https

isSigninPath

protected boolean isSigninPath(String path)

Checks if the given path is a sign in path. Overwrite this method to provide specific sign in path for your application.

Parameters:

path - the sign in path to check.

Returns:

true, if the given path is a sign in path otherwise false.

isSecured

protected boolean isSecured()

Checks if is the resourceClass is annotated with the annotation Securable.

Returns:

true, if is the resourceClass is annotated with the annotation Securable.

onValidateToken

protected abstract String onValidateToken(String token)
                                   throws Exception

Abstract callback method that checks if the given token is valid. For instance if it is not expired.

Parameters:

token - the token

Returns:

the string the user name

Throws:

Exception - if the token is not valid

newFaultResponse

protected Response newFaultResponse()

Factory callback method for create a new Response.

Returns:

the new fault response

newRealmValue

protected String newRealmValue()

Factory callback method for create a new realm value for the header key 'WWW-Authenticate'. Overwrite to set specific application realm value.

Returns:

the new realm value.

newSecurityContext

protected SecurityContext newSecurityContext(String username)

Factory method for create a new security context with the given user name.

Parameters:

username - the user name

Returns:

the security context