Package org.opencms.jsp.userdata

Class CmsUserDataRequestInfo

java.lang.Object

org.opencms.jsp.userdata.CmsUserDataRequestInfo

public class CmsUserDataRequestInfo
extends Object

The stored information about a user data request.

This contains both the user data itself, as well as authentication information, for making sure the information can not just be automatically downloaded by someone intercepting the email sent to the user.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A_AUTH	JSON key.
static final String	A_CONTENT	JSON key.
static final String	A_EMAIL	JSON key.
static final String	A_EXPIRATION	JSON key.
static final String	A_ID	JSON key.
static final String	A_TYPE	JSON key.
static final String	A_USERIDS	JSON key.

Constructor Summary

Constructors

Constructor	Description
CmsUserDataRequestInfo()	Creates a new user data request object.
CmsUserDataRequestInfo(String data)	Creates a new instance from the JSON data in a string.

Method Summary

Modifier and Type	Method	Description
boolean	checkAuthCode(String auth)	Checks that the given authorization code matches the one stored in this object.
String	getAuthCode()	Gets the authorization code.
String	getEmail()	Gets the email address.
long	getExpiration()	Gets the expiration date as a long.
String	getId()	Gets the id of the user data request.
String	getInfoHtml()	Gets the user data HTML text.
CmsUserDataRequestType	getType()	Gets the user data request type (single user or email).
String	getUserName()	Gets the full user name.
boolean	isExpired()	Returns true if the user data request has expired.
void	setAuth(String auth)	Sets the authorization code.
void	setEmail(String email)	Sets the email address.
void	setExpiration(long expiration)	Sets the expiration date.
void	setId(String id)	Sets the id.
void	setInfoHtml(String infoHtml)	Sets the user data HTML.
void	setType(CmsUserDataRequestType type)	Sets the user data request type.
void	setUser(String user)	Sets the full user name.
String	toJson()	Formats this object as JSON text.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

A_AUTH

public static final String A_AUTH

JSON key.

See Also:

• Constant Field Values

A_CONTENT

public static final String A_CONTENT

JSON key.

See Also:

• Constant Field Values

A_EMAIL

public static final String A_EMAIL

JSON key.

See Also:

• Constant Field Values

A_EXPIRATION

public static final String A_EXPIRATION

JSON key.

See Also:

• Constant Field Values

A_ID

public static final String A_ID

JSON key.

See Also:

• Constant Field Values

A_TYPE

public static final String A_TYPE

JSON key.

See Also:

• Constant Field Values

A_USERIDS

public static final String A_USERIDS

JSON key.

See Also:

• Constant Field Values

Constructor Details

CmsUserDataRequestInfo

public CmsUserDataRequestInfo()

Creates a new user data request object.

CmsUserDataRequestInfo

public CmsUserDataRequestInfo(String data)
                       throws JSONException

Creates a new instance from the JSON data in a string.

Parameters:

data - the data as a string

Throws:

JSONException - if parsing the JSON fails

Method Details

checkAuthCode

public boolean checkAuthCode(String auth)

Checks that the given authorization code matches the one stored in this object.

Parameters:

auth - the authorization code

Returns:

true if the code matches

getAuthCode

public String getAuthCode()

Gets the authorization code.

Returns:

the authorization code

getEmail

public String getEmail()

Gets the email address.

Returns:

the email address

getExpiration

public long getExpiration()

Gets the expiration date as a long.

Returns:

the expiration date

getId

public String getId()

Gets the id of the user data request.

Returns:

the id

getInfoHtml

public String getInfoHtml()

Gets the user data HTML text.

Returns:

the user data HTML text

getType

public CmsUserDataRequestType getType()

Gets the user data request type (single user or email).

Returns:

the user data request type

getUserName

public String getUserName()

Gets the full user name.

This is not set in case of email-only user data requests.

Returns:

the full user name

isExpired

public boolean isExpired()

Returns true if the user data request has expired.

Returns:

true if the user data request has expired

setAuth

public void setAuth(String auth)

Sets the authorization code.

Parameters:

auth - the authorization code.

setEmail

public void setEmail(String email)

Sets the email address.

Parameters:

email - the email address

setExpiration

public void setExpiration(long expiration)

Sets the expiration date.

Parameters:

expiration - the expiration date

setId

public void setId(String id)

Sets the id.

Parameters:

id - the id

setInfoHtml

public void setInfoHtml(String infoHtml)

Sets the user data HTML.

Parameters:

infoHtml - the user data HTML

setType

public void setType(CmsUserDataRequestType type)

Sets the user data request type.

Parameters:

type - the user data request type

setUser

public void setUser(String user)

Sets the full user name.

Parameters:

user - the full user name

toJson

public String toJson()

Formats this object as JSON text.

Returns:

the JSON text

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()