org.eurekaclinical.common.filter

Class RolesFromServiceFilter

java.lang.Object

org.eurekaclinical.standardapis.filter.AbstractRolesFilter

org.eurekaclinical.common.filter.RolesFromServiceFilter

All Implemented Interfaces:

javax.servlet.Filter, org.eurekaclinical.standardapis.filter.RolesFilter

@Singleton
public class RolesFromServiceFilter
extends org.eurekaclinical.standardapis.filter.AbstractRolesFilter

Filter that adds the user's roles from a REST API client to the request. Users of this filter must bind AuthorizingEurekaClinicalClient in their Guice configuration. It accepts an init parameter, protectedPath, which takes a path corresponding to the part of the web application that requires authentication. The filter will ignore HTTP status codes under 500 when trying to get the user's role list if the requested path does not start with the application's protected path.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
RolesFromServiceFilter(com.google.inject.Injector inInjector)

Method Summary

Modifier and Type	Method and Description
protected String[]	getRoles(Principal inPrincipal, javax.servlet.ServletRequest inRequest) Gets the user's roles from the service that maintains the user's role information.
void	init(javax.servlet.FilterConfig fc) Does nothing.

Methods inherited from class org.eurekaclinical.standardapis.filter.AbstractRolesFilter

destroy, doFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

RolesFromServiceFilter

@Inject
public RolesFromServiceFilter(com.google.inject.Injector inInjector)

Method Detail

init

public void init(javax.servlet.FilterConfig fc)

Does nothing.

Specified by:

init in interface javax.servlet.Filter

Overrides:

init in class org.eurekaclinical.standardapis.filter.AbstractRolesFilter

Parameters:

fc - the filter configuration.

getRoles

protected String[] getRoles(Principal inPrincipal,
                            javax.servlet.ServletRequest inRequest)
                     throws javax.servlet.ServletException

Gets the user's roles from the service that maintains the user's role information.

Specified by:

getRoles in class org.eurekaclinical.standardapis.filter.AbstractRolesFilter

Parameters:

inPrincipal - the user principal.

inRequest - the request.

Returns:

the user's roles.

Throws:

javax.servlet.ServletException - if the service responded with a 500 status, the protectedPath init parameter was not given or is null, or the requested servlet path starts with the protected path.