Package org.opencms.main

Class A_CmsAuthorizationHandler

java.lang.Object

org.opencms.main.A_CmsAuthorizationHandler

All Implemented Interfaces:

I_CmsAuthorizationHandler

Direct Known Subclasses:

CmsDefaultAuthorizationHandler

public abstract class A_CmsAuthorizationHandler
extends java.lang.Object
implements I_CmsAuthorizationHandler

Abstract class to grant the needed access to the session manager.

Since:

6.5.4

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.security.I_CmsAuthorizationHandler

I_CmsAuthorizationHandler.I_PrivilegedLoginAction

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.commons.logging.Log	LOG	The static log object for this class.
protected java.util.Map<java.lang.String,java.lang.String>	m_parameters	Additional parameters.

Constructor Summary

Constructors

Constructor	Description
A_CmsAuthorizationHandler()

Method Summary

Modifier and Type	Method	Description
protected CmsObject	initCmsObjectFromSession(javax.servlet.http.HttpServletRequest request)	Initializes a new cms object from the session data of the request.
protected CmsObject	registerSession(javax.servlet.http.HttpServletRequest request, CmsObject cms)	Registers the current session with OpenCms.
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)	Sets parameters which can be configured additionally for an authorization handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opencms.security.I_CmsAuthorizationHandler

getLoginFormURL, initCmsObject, initCmsObject, initCmsObject, requestAuthorization

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

The static log object for this class.

m_parameters

protected java.util.Map<java.lang.String,java.lang.String> m_parameters

Additional parameters.

Constructor Detail

A_CmsAuthorizationHandler

public A_CmsAuthorizationHandler()

Method Detail

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: I_CmsAuthorizationHandler

Sets parameters which can be configured additionally for an authorization handler.

Specified by:

setParameters in interface I_CmsAuthorizationHandler

Parameters:

parameters - the map of parameters

See Also:

I_CmsAuthorizationHandler.setParameters(java.util.Map)

initCmsObjectFromSession

protected CmsObject initCmsObjectFromSession(javax.servlet.http.HttpServletRequest request)
                                      throws CmsException

Initializes a new cms object from the session data of the request.

If no session data is found, null is returned.

Parameters:

request - the request

Returns:

the new initialized cms object

Throws:

CmsException - if something goes wrong

registerSession

protected CmsObject registerSession(javax.servlet.http.HttpServletRequest request,
                                    CmsObject cms)
                             throws CmsException

Registers the current session with OpenCms.

Parameters:

request - the current request

cms - the cms object to register

Returns:

the updated cms context

Throws:

CmsException - if something goes wrong