org.eurekaclinical.standardapis.filter

Class RolesFromDbFilter

java.lang.Object

org.eurekaclinical.standardapis.filter.AbstractRolesFilter

org.eurekaclinical.standardapis.filter.RolesFromDbFilter

All Implemented Interfaces:

javax.servlet.Filter, RolesFilter

@Singleton
public class RolesFromDbFilter
extends AbstractRolesFilter

Filter that adds the user's roles from a UserDao to the request. Users of this filter must bind UserDao in their Guice configuration.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
RolesFromDbFilter(UserDao<? extends UserEntity<? extends RoleEntity>> inUserDao)

Method Summary

Modifier and Type	Method and Description
protected String[]	getRoles(Principal principal, javax.servlet.ServletRequest inRequest) Gets the user's roles.

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

destroy, doFilter, init

Methods inherited from class java.lang.Object

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

Constructor Detail

RolesFromDbFilter

@Inject
public RolesFromDbFilter(UserDao<? extends UserEntity<? extends RoleEntity>> inUserDao)

Method Detail

getRoles

protected String[] getRoles(Principal principal,
                            javax.servlet.ServletRequest inRequest)

Description copied from class: AbstractRolesFilter

Gets the user's roles. It is called by AbstractRolesFilter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain).

Specified by:

getRoles in class AbstractRolesFilter

Parameters:

principal - the user's principal. Cannot be null.

inRequest - the servlet request.

Returns:

the role names. If the user has no roles, the array will be empty. A return value of null should be used if an error occurred retrieving role information.