net.officefloor.plugin.servlet.security

Interface HttpServletSecurity

public interface HttpServletSecurity

HTTP Security interface for the HttpServlet container.

As HttpServlet always requires depending on HTTP Security, this interface is provided to differentiate the HttpServlet so that authentication is not always required. This enables mixing HttpServlet security with WebAutoWireApplication security (i.e. not escalate HttpAuthenticationRequiredException and just provide null instance).

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
String	getAuthenticationScheme() Obtains the authentication scheme used.
String	getRemoteUser() Name of the user.
Principal	getUserPrincipal() Obtains the Principal for the user.
boolean	isUserInRole(String role) Indicates if the user supports the role.

Method Detail

getAuthenticationScheme

String getAuthenticationScheme()

Obtains the authentication scheme used.

Returns:

Authentication scheme.

getUserPrincipal

Principal getUserPrincipal()

Obtains the Principal for the user.

Returns:

Principal for the user.

getRemoteUser

String getRemoteUser()

Name of the user.

Returns:

Name of the user.

isUserInRole

boolean isUserInRole(String role)

Indicates if the user supports the role.

Parameters:

role - Role to check if user supports.

Returns:

true if the user supports the role.