Package net.sf.jstuff.integration.servlet

Class DummyPrincipalInjectingFilter

java.lang.Object

net.sf.jstuff.integration.servlet.DummyPrincipalInjectingFilter

All Implemented Interfaces:

jakarta.servlet.Filter

public class DummyPrincipalInjectingFilter
extends Object
implements jakarta.servlet.Filter

Example:

 
 <filter>
     <filter-name>DummyPrincipalInjectingFilter</filter-name>
     <filter-class>net.sf.jstuff.integration.servlet.DummyPrincipalInjectingFilter</filter-class>
     <init-param>
         <param-name>username</param-name>
         <param-value>john</param-value>
     </init-param>
     <init-param>
         <param-name>user-roles</param-name>
         <param-value>admin,monitor</param-value>
     </init-param>
 </filter>
 <filter-mapping>
     <filter-name>DummyPrincipalInjectingFilter</filter-name>
     <url-pattern>/*</url-pattern>
 </filter-mapping>
 
 

Author:

Sebastian Thomschke

Field Summary

Fields

Modifier and Type	Field	Description
static @Nullable String	DEFAULT_USER_NAME
static String @Nullable []	DEFAULT_USER_ROLES
static final String	USER_NAME_SYSTEM_PROPERTY
static final String	USER_ROLES_SEPARATOR
static final String	USER_ROLES_SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DummyPrincipalInjectingFilter()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
@Nullable String	getUsername()
Set<String>	getUserRoles()
void	init(jakarta.servlet.FilterConfig config)
void	setUsername(@Nullable String name)
void	setUserRoles(@Nullable Collection<String> userRoles)
void	setUserRoles(String @Nullable ... userRoles)

Methods inherited from class java.lang.Object

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

Field Details

USER_NAME_SYSTEM_PROPERTY

public static final String USER_NAME_SYSTEM_PROPERTY

See Also:

• Constant Field Values

USER_ROLES_SYSTEM_PROPERTY

public static final String USER_ROLES_SYSTEM_PROPERTY

See Also:

• Constant Field Values

USER_ROLES_SEPARATOR

public static final String USER_ROLES_SEPARATOR

See Also:

• Constant Field Values

DEFAULT_USER_NAME

public static @Nullable String DEFAULT_USER_NAME

DEFAULT_USER_ROLES

public static String @Nullable [] DEFAULT_USER_ROLES

Constructor Details

DummyPrincipalInjectingFilter

public DummyPrincipalInjectingFilter()

Method Details

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Filter

doFilter

public void doFilter(jakarta.servlet.ServletRequest request,
 jakarta.servlet.ServletResponse response,
 jakarta.servlet.FilterChain chain)
              throws IOException,
jakarta.servlet.ServletException

Specified by:

doFilter in interface jakarta.servlet.Filter

Throws:

IOException

jakarta.servlet.ServletException

getUsername

public @Nullable String getUsername()

getUserRoles

public Set<String> getUserRoles()

init

public void init(jakarta.servlet.FilterConfig config)
          throws jakarta.servlet.ServletException

Specified by:

init in interface jakarta.servlet.Filter

Throws:

jakarta.servlet.ServletException

setUsername

public void setUsername(@Nullable String name)

setUserRoles

public void setUserRoles(@Nullable Collection<String> userRoles)

setUserRoles

public void setUserRoles(String @Nullable ... userRoles)