Package com.jalios.jcms.rest

Class DataRestResource

java.lang.Object

org.restlet.resource.Resource

com.jalios.jcms.rest.JcmsRestResource

com.jalios.jcms.rest.DataRestResource

All Implemented Interfaces:

MashupConstants, RestConstants

Direct Known Subclasses:

DataCollectionRestResource, JSyncResource, LockResource, MessageEncryptionOptionsResource, UnlockResource, UpdateMemberPhotoResource, WhoAmIResource

public abstract class DataRestResource
extends JcmsRestResource

The classes extending this one are representing a JCMS data resource.

Since:

JCMS-6.0

Author:

dissert

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.rest.JcmsRestResource

JcmsRestResource.DataCollectionWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected Data	data
protected java.lang.String[]	relateds

Fields inherited from class com.jalios.jcms.rest.JcmsRestResource

channel, checkCSRF, context, formQueryString, j2eeRequest, jcmsContext, pagerData, queryString, xmlEncoding

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Fields inherited from interface com.jalios.jcms.rest.RestConstants

CSRF_HEADER_NAME, HTTP_HEADERS, METHOD_OVERRIDE_HTTP_HEADER, SERVER_REQUEST_HTTP_HEADER_PREFIX, UTS_ADMIN, UTS_ADMIN_CHECK_0, UTS_ADMIN_CHECK_1, UTS_ADMIN_CHECK_2, UTS_ADMIN_INDEX_SNAPSHOT, UTS_ADMIN_MEMBER_PREFERENCES, UTS_ADMIN_MEMBER_PREFERENCES_2, UTS_ADMIN_PLUGINS, UTS_ADMIN_PREFIX, UTS_ADMIN_PROPS_1, UTS_ADMIN_PROPS_2, UTS_ADMIN_PROPS_3, UTS_ADMIN_STATUS, UTS_ALERT, UTS_ALERT_LIST, UTS_ALERT_LIST_LEGACY, UTS_ALERT_WS, UTS_CHANNEL_NAME, UTS_DATA_CHILDREN, UTS_DATA_PARAM, UTS_DATATYPE_ITEM, UTS_DATATYPE_LIST, UTS_DOC, UTS_JSYNC_REQUEST, UTS_LOCK, UTS_MEMBER_ITEM, UTS_MEMBER_PHOTO_UPDATE, UTS_MEMBER_PREFERENCES_2_ITEM, UTS_MEMBER_PREFERENCES_ITEM, UTS_MSG_ENC_OPTIONS_ITEM, UTS_PUSH, UTS_SEARCH, UTS_SEARCH_CAT, UTS_SEARCH_GROUP, UTS_SEARCH_MBR, UTS_SEARCH_WS, UTS_STATE, UTS_UNLOCK, UTS_WHOAMI_ITEM, UTS_WORKFLOWS, UTS_WORKFLOWS_ITEM, UTS_WORKSPACE_ADMIN, UTS_WORKSPACE_ADMIN2

Constructor Summary

Constructors

Constructor	Description
DataRestResource(org.restlet.Context context, org.restlet.data.Request request, org.restlet.data.Response response)

Method Summary

Modifier and Type	Method	Description
Data	getData()	Retrieve the unique Data instance associated to this resource
protected java.lang.String	getItemXmlRepresentation(java.lang.Object item)
protected java.lang.String	getJSONRepresentation()
protected void	updateObjectMapperBuilder(ObjectMapperBuilder objectMapperBuilder)

Methods inherited from class com.jalios.jcms.rest.JcmsRestResource

checkReadRight, delete, doDelete, doPost, doPost, doPut, forward, generateErrorRepresentation, getAtomRepresentation, getLoggedMember, getPagerData, getPlainTextRepresentation, getPreferredMediaType, getRepresentation, getXmlProlog, getXmlRepresentation, insertAfterXml, insertBeforeXml, post, put, setCheckCSRF, setXmlUTF8Encoding

Methods inherited from class org.restlet.resource.Resource

allowDelete, allowGet, allowPost, allowPut, generateRef, getContext, getLogger, getPreferredRepresentation, getPreferredVariant, getRequest, getResponse, getVariants, handleDelete, handleGet, handleHead, handleOptions, handlePost, handlePut, init, isNegotiateContent, setContext, setNegotiateContent, setRequest, setResponse

Methods inherited from class java.lang.Object

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

Field Detail

data

protected Data data

relateds

protected java.lang.String[] relateds

Constructor Detail

DataRestResource

public DataRestResource(org.restlet.Context context,
                        org.restlet.data.Request request,
                        org.restlet.data.Response response)

Method Detail

getItemXmlRepresentation

protected java.lang.String getItemXmlRepresentation(java.lang.Object item)

Overrides:

getItemXmlRepresentation in class JcmsRestResource

getJSONRepresentation

protected java.lang.String getJSONRepresentation()

Overrides:

getJSONRepresentation in class JcmsRestResource

updateObjectMapperBuilder

protected void updateObjectMapperBuilder(ObjectMapperBuilder objectMapperBuilder)

getData

public Data getData()

Retrieve the unique Data instance associated to this resource

Returns:

a Data or null if this resource returned no data or a collection of data

See Also:

JcmsRestResource.getPagerData()