Module cloud.piranha.webapp.impl

Package cloud.piranha.webapp.impl

Class DefaultSecurityManager

java.lang.Object

cloud.piranha.webapp.impl.DefaultSecurityManager

All Implemented Interfaces:

SecurityManager

public class DefaultSecurityManager
extends Object
implements SecurityManager

The default SecurityManager.

This security manager implies the use of DefaultWebApplicationRequest, if your server / web application does not want to use DefaultWebApplicationRequest or subclass DefaultWebApplicationRequest you have to implement your own security manager.

Author:

Manfred Riem ([email protected])

Nested Class Summary

Nested classes/interfaces inherited from interface cloud.piranha.webapp.api.SecurityManager

SecurityManager.AuthenticateSource, SecurityManager.UsernamePasswordLoginHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	denyUncoveredHttpMethods	Stores if we are denying uncovered HTTP methods.
protected HashMap<String,String>	logins	Stores the logins.
protected ArrayList<String>	roles	Stores the roles.
protected HashMap<String,String[]>	userRoles	Stores the user roles.
protected WebApplication	webApplication	Stores the web application.

Constructor Summary

Constructors

Constructor	Description
DefaultSecurityManager()

Method Summary

Modifier and Type	Method	Description
void	addUser(String username, String password, String... roles)	Add user.
void	addUserRole(String username, String... roles)	Add the user roles.
boolean	authenticate(HttpServletRequest request, HttpServletResponse response)	Authenticate the request.
void	declareRoles(String[] roles)	Declare roles.
boolean	getDenyUncoveredHttpMethods()	Get if we are denying uncovered HTTP methods.
Set<String>	getRoles()	Get the declared roles
WebApplication	getWebApplication()	Returns the web application.
boolean	isUserInRole(HttpServletRequest request, String role)	Is the user in the given role.
void	login(HttpServletRequest request, String username, String password)	Login with the given username and password.
void	logout(HttpServletRequest request, HttpServletResponse response)	Logout.
void	removeUser(String username)	Remove the given user.
void	setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)	Set if we are denying uncovered HTTP methods.
void	setWebApplication(WebApplication webApplication)	Set the web application.

Methods inherited from class java.lang.Object

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

Methods inherited from interface cloud.piranha.webapp.api.SecurityManager

authenticate, declareRoles, getAuthenticatedRequest, getAuthenticatedResponse, isCallerAuthorizedForResource, isRequestedResourcePublic, isRequestSecurityAsRequired, postRequestProcess, setUsernamePasswordLoginHandler

Field Details

denyUncoveredHttpMethods

protected boolean denyUncoveredHttpMethods

Stores if we are denying uncovered HTTP methods.

logins

protected final HashMap<String,String> logins

Stores the logins.

roles

protected ArrayList<String> roles

Stores the roles.

userRoles

protected final HashMap<String,String[]> userRoles

Stores the user roles.

webApplication

protected WebApplication webApplication

Stores the web application.

Constructor Details

DefaultSecurityManager

public DefaultSecurityManager()

Method Details

addUser

public void addUser(String username,
 String password,
 String... roles)

Add user.

Parameters:

username - the username.

password - the password.

roles - the roles.

addUserRole

public void addUserRole(String username,
 String... roles)

Add the user roles.

Parameters:

username - the username.

roles - the roles.

authenticate

public boolean authenticate(HttpServletRequest request,
 HttpServletResponse response)
                     throws IOException,
ServletException

Authenticate the request.

Specified by:

authenticate in interface SecurityManager

Parameters:

request - the request.

response - the response.

Returns:

true if authenticated, false otherwise.

Throws:

IOException - when an I/O error occurs.

ServletException - when a Servlet error occurs.

declareRoles

public void declareRoles(String[] roles)

Declare roles.

Specified by:

declareRoles in interface SecurityManager

Parameters:

roles - the roles.

getRoles

public Set<String> getRoles()

Description copied from interface: SecurityManager

Get the declared roles

Specified by:

getRoles in interface SecurityManager

Returns:

the roles

getDenyUncoveredHttpMethods

public boolean getDenyUncoveredHttpMethods()

Get if we are denying uncovered HTTP methods.

Specified by:

getDenyUncoveredHttpMethods in interface SecurityManager

Returns:

true if we are, false otherwise.

getWebApplication

public WebApplication getWebApplication()

Returns the web application.

Specified by:

getWebApplication in interface SecurityManager

Returns:

the web application

isUserInRole

public boolean isUserInRole(HttpServletRequest request,
 String role)

Is the user in the given role.

Specified by:

isUserInRole in interface SecurityManager

Parameters:

request - the request.

role - the role.

Returns:

true if in the role, false otherwise.

login

public void login(HttpServletRequest request,
 String username,
 String password)
           throws ServletException

Login with the given username and password.

Specified by:

login in interface SecurityManager

Parameters:

request - the servlet request.

username - the username.

password - the password.

Throws:

ServletException - when a serious error occurs.

logout

public void logout(HttpServletRequest request,
 HttpServletResponse response)
            throws ServletException

Logout.

Specified by:

logout in interface SecurityManager

Parameters:

request - the request.

response - the response.

Throws:

ServletException - when a serious error occurs.

removeUser

public void removeUser(String username)

Remove the given user.

Parameters:

username - the username.

setDenyUncoveredHttpMethods

public void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)

Set if we are denying uncovered HTTP methods.

Specified by:

setDenyUncoveredHttpMethods in interface SecurityManager

Parameters:

denyUncoveredHttpMethods - the boolean value.

setWebApplication

public void setWebApplication(WebApplication webApplication)

Set the web application.

Specified by:

setWebApplication in interface SecurityManager

Parameters:

webApplication - the web application.