Package org.opencms.xml.xml2json

Class CmsJsonRequest

java.lang.Object

org.opencms.xml.xml2json.CmsJsonRequest

public class CmsJsonRequest
extends Object

Class representing a JSON request. Provides utility functions for parameter validation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_CONTENT	The content request parameter.
static final String	PARAM_FALLBACK_LOCALE	The fallback locale request parameter.
static final String	PARAM_LEVELS	The levels request parameter.
static final String	PARAM_LOCALE	The locale request parameter.
static final String	PARAM_PATH	The path request parameter.
static final String	PARAM_ROWS	The rows request parameter.
static final String	PARAM_SORT	The sort request parameter.
static final String	PARAM_START	The start request parameter.
static final String	PARAM_WRAPPER	The wrapper request parameter.

Constructor Summary

Constructors

Constructor	Description
CmsJsonRequest(CmsJsonHandlerContext context, I_CmsJsonHandler handler)	Creates a new JSON request.

Method Summary

Modifier and Type	Method	Description
CmsJsonHandlerContext	getContext()	Returns the JSON handler context.
JSONObject	getErrorsAsJson()	Returns the errors of this request as JSON.
Boolean	getParamBoolean(String bool)	Returns the boolean parameter value for a given string.
Boolean	getParamContent()	Returns the content parameter as boolean.
Boolean	getParamFallbackLocale()	Returns the fallback locale parameter as boolean.
Integer	getParamLevels()	Returns the levels parameter as integer.
Integer	getParamLevels(int defaultLevels)	Returns the levels parameter as integer.
String	getParamLocale()	Returns the locale parameter as string.
String	getParamPath()	Returns the path parameter as string.
Integer	getParamRows()	Returns the rows parameter as integer.
Integer	getParamRows(int defaultRows)	Returns the rows parameter as integer.
String	getParamSort()	Returns the sort parameter as string.
String	getParamSort(String defaultSort)	Returns the sort parameter as string.
Integer	getParamStart()	Returns the start parameter as integer.
Integer	getParamStart(int defaultStart)	Returns the rows parameter as integer.
Boolean	getParamWrapper()	Returns the wrapper parameter as string.
Boolean	getParamWrapper(boolean defaultWrapper)	Returns the wrapper parameter as string.
boolean	hasErrors()	Whether this JSON request has validation errors.
void	validate()	Validates this request.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_CONTENT

public static final String PARAM_CONTENT

The content request parameter.

See Also:

• Constant Field Values

PARAM_FALLBACK_LOCALE

public static final String PARAM_FALLBACK_LOCALE

The fallback locale request parameter.

See Also:

• Constant Field Values

PARAM_LEVELS

public static final String PARAM_LEVELS

The levels request parameter.

See Also:

• Constant Field Values

PARAM_LOCALE

public static final String PARAM_LOCALE

The locale request parameter.

See Also:

• Constant Field Values

PARAM_PATH

public static final String PARAM_PATH

The path request parameter.

See Also:

• Constant Field Values

PARAM_ROWS

public static final String PARAM_ROWS

The rows request parameter.

See Also:

• Constant Field Values

PARAM_SORT

public static final String PARAM_SORT

The sort request parameter.

See Also:

• Constant Field Values

PARAM_START

public static final String PARAM_START

The start request parameter.

See Also:

• Constant Field Values

PARAM_WRAPPER

public static final String PARAM_WRAPPER

The wrapper request parameter.

See Also:

• Constant Field Values

Constructor Details

CmsJsonRequest

public CmsJsonRequest(CmsJsonHandlerContext context,
 I_CmsJsonHandler handler)

Creates a new JSON request.

Parameters:

context - the JSON handler context

handler - the JSON handler initiating this request

Method Details

getContext

public CmsJsonHandlerContext getContext()

Returns the JSON handler context.

Returns:

the JSON handler context

getErrorsAsJson

public JSONObject getErrorsAsJson()
                           throws JSONException

Returns the errors of this request as JSON.

Returns:

the errors as JSON

Throws:

JSONException - if JSON rendering fails

getParamBoolean

public Boolean getParamBoolean(String bool)

Returns the boolean parameter value for a given string.

Parameters:

bool - the string

Returns:

the boolean

getParamContent

public Boolean getParamContent()

Returns the content parameter as boolean.

Returns:

the content parameter as boolean

getParamFallbackLocale

public Boolean getParamFallbackLocale()

Returns the fallback locale parameter as boolean.

Returns:

the fallback locale parameter as boolean

getParamLevels

public Integer getParamLevels()

Returns the levels parameter as integer.

Returns:

the levels parameter as integer

getParamLevels

public Integer getParamLevels(int defaultLevels)

Returns the levels parameter as integer.

Parameters:

defaultLevels - if parameter is not set return this default value

Returns:

the levels parameter as integer

getParamLocale

public String getParamLocale()

Returns the locale parameter as string.

Returns:

the levels parameter as integer

getParamPath

public String getParamPath()

Returns the path parameter as string.

Returns:

the path parameter as string

getParamRows

public Integer getParamRows()

Returns the rows parameter as integer.

Returns:

the rows parameter as integer

getParamRows

public Integer getParamRows(int defaultRows)

Returns the rows parameter as integer.

Parameters:

defaultRows - if parameter is not set return this default value

Returns:

the rows parameter as integer

getParamSort

public String getParamSort()

Returns the sort parameter as string.

Returns:

the sort parameter as string

getParamSort

public String getParamSort(String defaultSort)

Returns the sort parameter as string.

Parameters:

defaultSort - if parameter is not set return this default value

Returns:

the sort parameter as string

getParamStart

public Integer getParamStart()

Returns the start parameter as integer.

Returns:

the start parameter as integer

getParamStart

public Integer getParamStart(int defaultStart)

Returns the rows parameter as integer.

Parameters:

defaultStart - if parameter is not set return this default value

Returns:

the rows parameter as integer

getParamWrapper

public Boolean getParamWrapper()

Returns the wrapper parameter as string.

Returns:

the wrapper parameter as string

getParamWrapper

public Boolean getParamWrapper(boolean defaultWrapper)

Returns the wrapper parameter as string.

Parameters:

defaultWrapper - if parameter is not set return this default value

Returns:

the wrapper parameter as string

hasErrors

public boolean hasErrors()

Whether this JSON request has validation errors.

Returns:

whether has validation errors or not

validate

public void validate()

Validates this request.