com.ibm.portal.auth.stepup
Interface AuthLevelVerifier

public interface AuthLevelVerifier

This is the plug point for plugin a custom authentication level verifier. The object is instantiated as a singleton and is supposed to be thread safe. NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:

6.1

Note:

This interface is designed to be implemented by clients.

Method Summary

void	init(AuthLevelConfig config) This method initializes the singleton instance of this authentication level verifier.
boolean	verifyAuthLevel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Verifies whether the current request satisfies the requirements of this authentication level verifier implementation.

Method Detail

init

void init(AuthLevelConfig config)
          throws SecurityException

This method initializes the singleton instance of this authentication level verifier. This method is called during the startup phase of WebSphere Portal server

Parameters:

config - The configuration provided for the authentication level verifier.

Throws:

SecurityException - If an unrecoverable problem occurs.

verifyAuthLevel

boolean verifyAuthLevel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                        throws SecurityException

Verifies whether the current request satisfies the requirements of this authentication level verifier implementation. Returns

• true, if the associated authentication level is verified successfully,
• false, if the associated authentication level is not verified successfully.

This method is not allowed to send a redirect using the passed response. Rather it may be used to add a cookie for later reference.

Parameters:

request - The currently request.

response - The current response.

Returns:

A boolean to indicate whether the authentication level verification succeeded.

Throws:

SecurityException - If an unrecoverable problem occurs.