Package org.opencms.jsp.userdata

Class CmsJspUserDataRequestBean

java.lang.Object

org.opencms.jsp.userdata.CmsJspUserDataRequestBean

public class CmsJspUserDataRequestBean
extends Object

Bean used by the dynamic function JSP for user data requests.

The dynamic function calls the action() method on this bean, which returns the new state for the JSP to render. Error/status messages are also available to the JSP via getters.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_REQUEST	Action id.
static final String	ACTION_VIEW	Action id.
static final String	ACTION_VIEWAUTH	Action id.
static final String	PARAM_ACTION	Request parameter for the action.
static final String	PARAM_AUTH	Request parameter for the authorization code.
static final String	PARAM_EMAIL	Request parameter.
static final String	PARAM_PASSWORD	Request parameter.
static final String	PARAM_ROOTPATH	Request parameter.
static final String	PARAM_UDRID	Request parameter.
static final String	PARAM_USER	Request parameter.

Constructor Summary

Constructors

Constructor	Description
CmsJspUserDataRequestBean()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	action(CmsObject cms, Map<String,String[]> reqParameters)	Called by the user data request function JSP to handle the user data request logic.
String	getDownloadLink()	Gets the user data download link.
String	getErrorHtml()	Gets the error HTML (this is only shown in the error state).
String	getInfoHtml()	Gets the user data HTML.
Map<String,String>	getTexts()	Gets the lazy map used to access the configurable texts to display by the user data request dynamic function.
boolean	isError()	Checks if the error HTML has been set.
boolean	isOnlyEmailRequired()	Checks if we need to confirm the user's email rather than their user name and password.

Methods inherited from class java.lang.Object

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

Field Details

ACTION_REQUEST

public static final String ACTION_REQUEST

Action id.

See Also:

• Constant Field Values

ACTION_VIEW

public static final String ACTION_VIEW

Action id.

See Also:

• Constant Field Values

ACTION_VIEWAUTH

public static final String ACTION_VIEWAUTH

Action id.

See Also:

• Constant Field Values

PARAM_ACTION

public static final String PARAM_ACTION

Request parameter for the action.

See Also:

• Constant Field Values

PARAM_AUTH

public static final String PARAM_AUTH

Request parameter for the authorization code.

See Also:

• Constant Field Values

PARAM_EMAIL

public static final String PARAM_EMAIL

Request parameter.

See Also:

• Constant Field Values

PARAM_PASSWORD

public static final String PARAM_PASSWORD

Request parameter.

See Also:

• Constant Field Values

PARAM_ROOTPATH

public static final String PARAM_ROOTPATH

Request parameter.

See Also:

• Constant Field Values

PARAM_UDRID

public static final String PARAM_UDRID

Request parameter.

See Also:

• Constant Field Values

PARAM_USER

public static final String PARAM_USER

Request parameter.

See Also:

• Constant Field Values

Constructor Details

CmsJspUserDataRequestBean

public CmsJspUserDataRequestBean()

Creates a new instance.

Method Details

action

public String action(CmsObject cms,
 Map<String,String[]> reqParameters)
              throws CmsException

Called by the user data request function JSP to handle the user data request logic. Returns the next state which should be shown by the JSP.

Parameters:

cms - the CMS context

reqParameters - the request parameters

Returns:

the next state to render

Throws:

CmsException - if something goes wrong

getDownloadLink

public String getDownloadLink()

Gets the user data download link.

Returns:

the user data download link

getErrorHtml

public String getErrorHtml()

Gets the error HTML (this is only shown in the error state).

Returns:

the error HTML

getInfoHtml

public String getInfoHtml()

Gets the user data HTML.

Returns:

the user data HTML

getTexts

public Map<String,String> getTexts()

Gets the lazy map used to access the configurable texts to display by the user data request dynamic function.

Returns:

the lazy map

isError

public boolean isError()

Checks if the error HTML has been set.

Returns:

true if the error HTML has been set

isOnlyEmailRequired

public boolean isOnlyEmailRequired()

Checks if we need to confirm the user's email rather than their user name and password.

Returns:

true if we only need the email address