Top Description Methods
waffle.servlet.spi

public Interface SecurityFilterProvider

Known Direct Implementers
waffle.servlet.spi.BasicSecurityFilterProvider, waffle.servlet.spi.NegotiateSecurityFilterProvider
Imports
java.io.IOException, javax.servlet.http.HttpServletRequest, .HttpServletResponse, waffle.windows.auth.IWindowsIdentity
A security filter provider.
Author
dblock[at]dblock[dot]org

Method Summary

Modifier and TypeMethod and Description
public IWindowsIdentity

Returns:

A Windows identity in case authentication completed or NULL if not. Thrown exceptions should be caught and processed as 401 Access Denied.
doFilter(final HttpServletRequest
Http Servlet Request.
request, final HttpServletResponse
Http Servlet Response.
response)

Execute filter.

public void
initParameter(final String
Parameter name.
parameterName, final String
Parameter value.
parameterValue)

Init a parameter.

public boolean

Returns:

True if authentication is required.
isPrincipalException(final HttpServletRequest
Http Request.
request)

Returns true if despite having a principal authentication needs to happen.

public boolean

Returns:

True if the security package is supported, false otherwise.
isSecurityPackageSupported(final String
Security package.
securityPackage)

Tests whether a specific security package is supported.

public void
sendUnauthorized(final HttpServletResponse
Http Response.
response)

Add authentication method headers.

Method Detail

doFilterback to summary
public IWindowsIdentity doFilter(final HttpServletRequest request, final HttpServletResponse response) throws IOException

Execute filter.

Parameters
request:HttpServletRequest

Http Servlet Request.

response:HttpServletResponse

Http Servlet Response.

Returns:IWindowsIdentity

A Windows identity in case authentication completed or NULL if not. Thrown exceptions should be caught and processed as 401 Access Denied.

Exceptions
IOException:
on doFilter.
initParameterback to summary
public void initParameter(final String parameterName, final String parameterValue)

Init a parameter.

Parameters
parameterName:String

Parameter name.

parameterValue:String

Parameter value.

isPrincipalExceptionback to summary
public boolean isPrincipalException(final HttpServletRequest request)

Returns true if despite having a principal authentication needs to happen.

Parameters
request:HttpServletRequest

Http Request.

Returns:boolean

True if authentication is required.

isSecurityPackageSupportedback to summary
public boolean isSecurityPackageSupported(final String securityPackage)

Tests whether a specific security package is supported.

Parameters
securityPackage:String

Security package.

Returns:boolean

True if the security package is supported, false otherwise.

sendUnauthorizedback to summary
public void sendUnauthorized(final HttpServletResponse response)

Add authentication method headers.

Parameters
response:HttpServletResponse

Http Response.