com.ibm.portal.security
Interface SecurityFilter

All Known Subinterfaces:

ExplicitLoginFilter, ExplicitLogoutFilter, ImpersonationFilter, ImplicitLoginFilter, ImplicitLogoutFilter, SessionTimeoutFilter, SessionValidationFilter

public interface SecurityFilter

Generic interface for a security related filter that provides two methods init(SecurityFilterConfig) and destroy().

Since:

6.1

Method Summary

void	destroy() Can be used to realize cleanup logic for a particular filter implementation.
void	init(SecurityFilterConfig filterConfig) Can be used to implement common initialization logic for the filter during Portal startup.

Method Detail

init

void init(SecurityFilterConfig filterConfig)
          throws SecurityFilterInitException

Can be used to implement common initialization logic for the filter during Portal startup. If the method throws an exception, Portal ends the startup process with an appropriate error message.

Parameters:

filterConfig - A configuration object providing the values of all parameters that are set for the particular filter implementation.

Throws:

SecurityFilterInitException - Must be thrown by the implementation if the initialization failed in an unrecoverable way. This will cause Portal to quit the startup process.

destroy

void destroy()

Can be used to realize cleanup logic for a particular filter implementation. Is called for each plugged filter when Portal shuts down.