Package org.opencms.xml.xml2json.document

Class CmsJsonDocumentResource

java.lang.Object

org.opencms.xml.xml2json.document.A_CmsJsonDocument

org.opencms.xml.xml2json.document.CmsJsonDocumentResource

All Implemented Interfaces:

I_CmsJsonDocument

Direct Known Subclasses:

CmsJsonDocumentXmlContent

public class CmsJsonDocumentResource
extends A_CmsJsonDocument
implements I_CmsJsonDocument

Class representing a JSON document for a CMS resource.

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsResourceDataJsonHelper	m_helper	The resource data helper.
protected CmsResource	m_resource	The resource.

Fields inherited from class org.opencms.xml.xml2json.document.A_CmsJsonDocument

FIELD_LINKED_CONTENTS, m_context, m_json, m_jsonRequest

Constructor Summary

Constructors

Constructor	Description
CmsJsonDocumentResource(CmsJsonRequest jsonRequest, CmsResource resource)	Creates a new JSON document.

Method Summary

Modifier and Type	Method	Description
Object	getJson()	Returns the JSON document.
protected void	insertJsonResource()	If the request parameter "wrapper" is set, inserts information about this resource into the JSON document.
protected void	insertJsonResourceAttributes()	Inserts the resource attributes into this JSON document.
protected void	insertJsonResourceFile()	Inserts file type information into this JSON document.
protected void	insertJsonResourceParams()	Inserts information about the effective request parameters into this JSON document.
protected void	insertJsonResourcePathAndLink()	Inserts path and link information about this resource into this JSON document.
protected void	insertJsonResourceProperties()	Inserts the properties of this resource into the JSON document.

Methods inherited from class java.lang.Object

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

Field Details

m_helper

protected CmsResourceDataJsonHelper m_helper

The resource data helper.

m_resource

protected CmsResource m_resource

The resource.

Constructor Details

CmsJsonDocumentResource

public CmsJsonDocumentResource(CmsJsonRequest jsonRequest,
 CmsResource resource)

Creates a new JSON document.

Parameters:

jsonRequest - the JSON request

resource - the resource

Method Details

getJson

public Object getJson()
               throws JSONException,
CmsException,
CmsJsonHandlerException,
CmsJsonHandlerXmlContent.PathNotFoundException,
Exception

Description copied from interface: I_CmsJsonDocument

Returns the JSON document.

Specified by:

getJson in interface I_CmsJsonDocument

Returns:

the JSON document

Throws:

JSONException - if rendering the JSON document fails

CmsException - if reading a resource or evaluating a SOLR search fails

CmsJsonHandlerException - if the request is not valid according to the specification

CmsJsonHandlerXmlContent.PathNotFoundException - if the selected path does not exist

Exception - if something else goes wrong

See Also:

• I_CmsJsonDocument.getJson()

insertJsonResource

protected void insertJsonResource()
                           throws JSONException,
CmsException

If the request parameter "wrapper" is set, inserts information about this resource into the JSON document.

Throws:

JSONException

CmsException

insertJsonResourceAttributes

protected void insertJsonResourceAttributes()
                                     throws JSONException

Inserts the resource attributes into this JSON document.

Throws:

JSONException - if JSON rendering fails

insertJsonResourceFile

protected void insertJsonResourceFile()
                               throws JSONException

Inserts file type information into this JSON document.

Throws:

JSONException - if JSON rendering fails

insertJsonResourceParams

protected void insertJsonResourceParams()
                                 throws JSONException

Inserts information about the effective request parameters into this JSON document.

Throws:

JSONException - if JSON rendering fails

insertJsonResourcePathAndLink

protected void insertJsonResourcePathAndLink()
                                      throws JSONException

Inserts path and link information about this resource into this JSON document.

Throws:

JSONException - if JSON rendering fails

insertJsonResourceProperties

protected void insertJsonResourceProperties()
                                     throws JSONException,
CmsException

Inserts the properties of this resource into the JSON document.

Throws:

JSONException - if JSON rendering fails

CmsException - if reading the properties fails