org.opencms.security
Interface I_CmsAuthorizationHandler.I_PrivilegedLoginAction

Enclosing interface:

I_CmsAuthorizationHandler

public static interface I_CmsAuthorizationHandler.I_PrivilegedLoginAction

Class providing the privileged login action.

Method Summary

CmsObject	doLogin(javax.servlet.http.HttpServletRequest request, java.lang.String principal) Performs a privileged login action and returns a cms object initialized for the principal.
CmsObject	getCmsObject() Returns the cms object.
void	setCmsObject(CmsObject cms) Used to provide an initial cms object.

Method Detail

setCmsObject

void setCmsObject(CmsObject cms)

Used to provide an initial cms object.

Parameters:

cms - an initial cms object

getCmsObject

CmsObject getCmsObject()

Returns the cms object.

Returns:

the cms object

doLogin

CmsObject doLogin(javax.servlet.http.HttpServletRequest request,
                  java.lang.String principal)
                  throws CmsException

Performs a privileged login action and returns a cms object initialized for the principal.

Parameters:

request - the current request

principal - the principal to login

Returns:

a cms object initialized for the principal

Throws:

CmsException - if the login action fails