Package com.webmethods.portal.framework.auth

Interface IAuthHandler

All Superinterfaces:

IComponent, IHandler, IInitializable, ISystemHandler

public interface IAuthHandler
extends IHandler

The IComponent for the IAuthManager

Method Summary

Modifier and Type	Method	Description
boolean	handle(HttpServletRequest request)	Each IAuthHandler attempts to retrieve authorization information from the user.

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.framework.IHandler

getConfigElem, getHandlerBean, getName, getPerfToken, initialize, postInitialize, shutdown

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init

Method Details

handle

boolean handle(HttpServletRequest request)
        throws FrameworkException

Each IAuthHandler attempts to retrieve authorization information from the user. This can come from a variety of places, and is designed to be completely pluggable.
When the AuthManager is asked to retrieve AuthInfo, then after generating a default AuthInfo object, the registered IAuthHandlers will be delegated to.
It is important that each IAuthHandler exit it's function as soon as possible if no authorization information is avaliable.
Note: to retrieve an AuthInfo object for modification, call AuthInfo.getAuthInfo(javax.servlet.http.HttpSession)
The IAuthHandlers will be delegated to in the way they were listed in the auth.xml file.

Parameters:

request - the HttpServletRequest to construct the AuthInfo from

Returns:

true if this request was 'handled', false otherwise.

Throws:

FrameworkException