Package org.opencms.workplace

Class CmsWorkplaceLoginHandler

java.lang.Object

org.opencms.workplace.CmsWorkplaceLoginHandler

All Implemented Interfaces:

I_CmsResourceInit

public class CmsWorkplaceLoginHandler
extends java.lang.Object
implements I_CmsResourceInit

Resource init handler that loads the login form with the right parameters.

The login uri must have following format:
/${CONTEXT}/${SERVLET}/system/login/${OU_PATH}

for example:
/opencms/opencms/system/login/intranet/marketing

Since:

6.5.6

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LOGIN_FORM	The login form path.
static java.lang.String	LOGIN_HANDLER	The login handler path.

Fields inherited from interface org.opencms.main.I_CmsResourceInit

ATTR_ALTERNATIVE_CMS_OBJECT

Constructor Summary

Constructors

Constructor	Description
CmsWorkplaceLoginHandler()

Method Summary

Modifier and Type	Method	Description
CmsResource	initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Possibility to modify or change the CmsFile with the CmsObject.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.main.I_CmsResourceInit

getConfiguration, initParameters

Field Detail

LOGIN_HANDLER

public static final java.lang.String LOGIN_HANDLER

The login handler path.

See Also:

Constant Field Values

LOGIN_FORM

public static final java.lang.String LOGIN_FORM

The login form path.

See Also:

Constant Field Values

Constructor Detail

CmsWorkplaceLoginHandler

public CmsWorkplaceLoginHandler()

Method Detail

initResource

public CmsResource initResource(CmsResource resource,
                                CmsObject cms,
                                javax.servlet.http.HttpServletRequest req,
                                javax.servlet.http.HttpServletResponse res)
                         throws CmsResourceInitException

Description copied from interface: I_CmsResourceInit

Possibility to modify or change the CmsFile with the CmsObject.

Caution: reading parameters from the request, destroys special characters in all parameters, because the encoding for the request was not set yet.

Specified by:

initResource in interface I_CmsResourceInit

Parameters:

resource - the requested file

cms - the current CmsObject

req - the current request

res - the current response

Returns:

a resource in the OpenCms VFS

Throws:

CmsResourceInitException - if other implementations of the interface should not be executed

See Also:

I_CmsResourceInit.initResource(org.opencms.file.CmsResource, org.opencms.file.CmsObject, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)