com.aspc.cms.rest

Class RestDefinition

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.rest.RestDefinition

All Implemented Interfaces:

RestPluginContentType, RestPluginConvertResult, RestPluginDS, RestPluginProcess, RestPluginThrottling, SecondaryCacheGroup

Direct Known Subclasses:

RestDefinitionSQL

public class RestDefinition
extends DBObject
implements RestPluginDS, RestPluginProcess, RestPluginContentType, RestPluginConvertResult, RestPluginThrottling

ReST service definition.

Notes

Standard parameters

• _accept override the HTTP Accept header.
• _method overrides the HTTP method GET,POST,DELETE,PUT

http://en.wikipedia.org/wiki/Representational_state_transfer

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

08 January 2014

Author:

Lei Gao

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID ReST service definition
static java.lang.String	DBCLASS_NAME ReST service definition
static java.lang.String	JSON_KEY_RESULTS
static java.lang.String	JSON_KEY_SUCCESS
static java.lang.String	PARAMETER_ACCEPT
static java.lang.String	PARAMETER_MAGIC
static java.lang.String	PARAMETER_METHOD Override the default method.
static java.lang.String	REST_DEFINITION_ATTRIBUTE The current rest definition
static java.lang.ThreadLocal<java.lang.Boolean>	SUPRESS_DEPRECATION_WARNING

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestDefinition(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static void	checkAccess(RestDefinition rd, WebClient client, Method method, DBMagicNumber magic)
RestDefinition	checkMagicNumber(RestMagicNumber mn)
void	checkVariables(WebClient client, Method method)
RestServerResponse	convertResult(RestDefinition rd, WebClient client, ContentType type, java.lang.Object value) Convert the result
static RestDefinition	create(MutableDataSource mds) Make a new instance of this class.
protected RestPluginContentType	defaultRestPluginContentType()
protected RestPluginConvertResult	defaultRestPluginConvertResult()
protected RestPluginDS	defaultRestPluginDS()
protected RestPluginProcess	defaultRestPluginProcess()
protected RestPluginThrottling	defaultRestPluginThrottling()
boolean	disableDefaultTransformers(java.lang.String... args)
protected void	extFixUp() The extended fix up routine
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected boolean	extIsMandatory(DBField field) OVERRIDE This method to specify fields should be mandatory under certain conditions.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
ContentType	find(java.lang.String accept)
RestDefinition	findCopyFrom(java.lang.String... args) Copy RestDefinition From.
static RestDefinition	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
RestDefinitionLifeCycle	findLifeCycle(java.lang.String... args) The life cycle phase.
protected RestDefinitionTransform	findTransform(java.lang.String accept, ReadOnlyDataSource ds)
java.lang.String	getAliases(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getConfigurationJSON(java.lang.String... args)
java.lang.String	getConsumesDELETE(java.lang.String... args)
java.lang.String	getConsumesPOST(java.lang.String... args)
java.lang.String	getConsumesPUT(java.lang.String... args)
RestDefinition	getCopyFrom(java.lang.String... args)
java.lang.String	getCorsAllowedHosts(java.lang.String... args)
java.lang.String	getCounterKey(WebClient client, RestDefinition rd) get the key of the throttling counter, the key has to be shorter than 255 characters
java.util.Date	getDeprecatedNoLongerAvailable(java.lang.String... args)
java.lang.String	getDeprecatedReason(java.lang.String... args)
java.lang.String	getKey(java.lang.String... args)
RestDefinitionLifeCycle	getLifeCycle(java.lang.String... args)
int	getParserVersion(java.lang.String... args)
java.lang.String	getPath(java.lang.String... args)
int	getPeriod(WebClient client, RestDefinition rd) get the throttling period in seconds
java.lang.String	getPlugin(java.lang.String... args)
int	getRequestLimit(WebClient client, RestDefinition rd) -1 is no limit 0 is always reject n is allow n requests in each throttling period
java.lang.String	getSummary(Method method)
java.lang.String	getSummaryDELETE(java.lang.String... args)
java.lang.String	getSummaryDELETERaw(java.lang.String... args)
java.lang.String	getSummaryGET(java.lang.String... args)
java.lang.String	getSummaryGETRaw(java.lang.String... args)
java.lang.String	getSummaryPOST(java.lang.String... args)
java.lang.String	getSummaryPOSTRaw(java.lang.String... args)
java.lang.String	getSummaryPUT(java.lang.String... args)
java.lang.String	getSummaryPUTRaw(java.lang.String... args)
java.lang.String	getTags(java.lang.String... args)
ContentType	getTargetContentType(RestDefinition rd, WebClient client, ContentType acceptType) The content type.
int	getThrottlingPeriod(java.lang.String... args)
int	getThrottlingRequestLimit(java.lang.String... args)
java.lang.String	getUsage(Method method)
java.lang.String	getUsageDELETE(java.lang.String... args)
java.lang.String	getUsageDELETERaw(java.lang.String... args)
java.lang.String	getUsageGET(java.lang.String... args)
java.lang.String	getUsageGETRaw(java.lang.String... args)
java.lang.String	getUsagePOST(java.lang.String... args)
java.lang.String	getUsagePOSTRaw(java.lang.String... args)
java.lang.String	getUsagePUT(java.lang.String... args)
java.lang.String	getUsagePUTRaw(java.lang.String... args)
int	getVersion(java.lang.String... args)
boolean	hasModifyAccess(java.lang.String... args)
boolean	isApplicableTo(Method method)
boolean	isApplicableToDELETE(java.lang.String... args)
boolean	isApplicableToGET(java.lang.String... args)
boolean	isApplicableToPOST(java.lang.String... args)
boolean	isApplicableToPUT(java.lang.String... args)
boolean	isDeprecated(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
boolean	isValidVariableName(java.lang.String code)
FileUpload	makeFile(WebClient client, java.lang.String code) Make the file.
java.lang.String[]	makeList(WebClient client, java.lang.String code) Make the parameter value.
static DBQuery<RestDefinition>	makeQuery(DataSource ds) Make a new QUERY for this class.
java.lang.String	makeValue(WebClient client, java.lang.String code) Make the parameter value.
boolean	makeValueBoolean(WebClient client, java.lang.String code, boolean defaultValue) Make the parameter Boolean value.
double	makeValueDouble(WebClient client, java.lang.String code, double defaultValue) Make the parameter double value.
int	makeValueInt(WebClient client, java.lang.String code, int defaultValue) Make the parameter integer value.
long	makeValueLong(WebClient client, java.lang.String code, long defaultValue) Make the parameter long value.
java.lang.String	parseSQL(java.lang.String rawSQL, WebClient client)
java.lang.Object	process(WebClient client)
java.lang.Object	restCreate(WebClient client, RestDefinition restDefinition, MutableDataSource mds) HTTP POST calls the the Create ReST service.
java.lang.Object	restDelete(WebClient client, RestDefinition restDefinition, MutableDataSource mds) HTTP DELETE calls the the Delete ReST service.
ReadOnlyDataSource	restReadDS(WebClient client, RestDefinition restDefinition) Create a data source that will be used for reading.
java.lang.Object	restRetrieve(WebClient client, RestDefinition restDefinition, ReadOnlyDataSource rds) HTTP GET calls the the Retrieval ReST service.
java.lang.Object	restUpdate(WebClient client, RestDefinition restDefinition, MutableDataSource mds) HTTP PUT calls the the Update ReST service.
MutableDataSource	restWriteDS(WebClient client, RestDefinition restDefinition) Create a data source that will be used for writing.
RestDefinition	setAliases(java.lang.String value, java.lang.String... args)
RestDefinition	setCode(java.lang.String value, java.lang.String... args)
RestDefinition	setConfigurationJSON(java.lang.String value, java.lang.String... args)
RestDefinition	setConsumesDELETE(java.lang.String value, java.lang.String... args)
RestDefinition	setConsumesPOST(java.lang.String value, java.lang.String... args)
RestDefinition	setConsumesPUT(java.lang.String value, java.lang.String... args)
RestDefinition	setCopyFrom(com.aspc.dal.cms.rest.RestDefinition value, java.lang.String... args)
RestDefinition	setCorsAllowedHosts(java.lang.String value, java.lang.String... args)
RestDefinition	setDeprecated(boolean value, java.lang.String... args)
RestDefinition	setDeprecatedNoLongerAvailable(java.util.Date value, java.lang.String... args)
RestDefinition	setDeprecatedReason(java.lang.String value, java.lang.String... args)
RestDefinition	setDisableDefaultTransformers(boolean value, java.lang.String... args)
RestDefinition	setFinalFg(boolean value, java.lang.String... args)
RestDefinition	setKey(java.lang.String value, java.lang.String... args)
RestDefinition	setLifeCycle(com.aspc.dal.cms.rest.RestDefinitionLifeCycle value, java.lang.String... args)
RestDefinition	setParserVersion(int value, java.lang.String... args)
RestDefinition	setPlugin(java.lang.String value, java.lang.String... args)
RestDefinition	setSummary(java.lang.String value, java.lang.String... args)
RestDefinition	setSummaryDELETERaw(java.lang.String value, java.lang.String... args)
RestDefinition	setSummaryGETRaw(java.lang.String value, java.lang.String... args)
RestDefinition	setSummaryPOSTRaw(java.lang.String value, java.lang.String... args)
RestDefinition	setSummaryPUTRaw(java.lang.String value, java.lang.String... args)
RestDefinition	setTags(java.lang.String value, java.lang.String... args)
RestDefinition	setThrottlingPeriod(int value, java.lang.String... args)
RestDefinition	setThrottlingRequestLimit(int value, java.lang.String... args)
RestDefinition	setUsage(java.lang.String value, java.lang.String... args)
RestDefinition	setUsageDELETERaw(java.lang.String value, java.lang.String... args)
RestDefinition	setUsageGETRaw(java.lang.String value, java.lang.String... args)
RestDefinition	setUsagePOSTRaw(java.lang.String value, java.lang.String... args)
RestDefinition	setUsagePUTRaw(java.lang.String value, java.lang.String... args)
RestDefinition	setVersion(int value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

ReST service definition

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

ReST service definition

PARAMETER_METHOD

public static final java.lang.String PARAMETER_METHOD

Override the default method. Example /ReST/v1/class/DBFile/3838363626?_method=DELETE for old or simple clients

See Also:

Constant Field Values

PARAMETER_ACCEPT

public static final java.lang.String PARAMETER_ACCEPT

See Also:

Constant Field Values

PARAMETER_MAGIC

public static final java.lang.String PARAMETER_MAGIC

See Also:

Constant Field Values

JSON_KEY_RESULTS

public static final java.lang.String JSON_KEY_RESULTS

See Also:

Constant Field Values

JSON_KEY_SUCCESS

public static final java.lang.String JSON_KEY_SUCCESS

See Also:

Constant Field Values

REST_DEFINITION_ATTRIBUTE

public static final java.lang.String REST_DEFINITION_ATTRIBUTE

The current rest definition

See Also:

Constant Field Values

SUPRESS_DEPRECATION_WARNING

public static final java.lang.ThreadLocal<java.lang.Boolean> SUPRESS_DEPRECATION_WARNING

Constructor Detail

RestDefinition

public RestDefinition(DBClass theClass,
                      DataSource dataSource)
               throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getKey

@CheckReturnValue
 @Nonnull
public java.lang.String getKey(java.lang.String... args)

setKey

@Nonnull
public RestDefinition setKey(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getAliases

@CheckReturnValue
 @Nonnull
public java.lang.String getAliases(java.lang.String... args)

setAliases

@Nonnull
public RestDefinition setAliases(@MatchesPattern(value="/[a-zA-Z/_\\-\\*0-9]+(,/[a-zA-Z/_\\-\\*0-9]+)*")
                                          java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isApplicableToDELETE

@CheckReturnValue
public boolean isApplicableToDELETE(java.lang.String... args)

isApplicableToGET

@CheckReturnValue
public boolean isApplicableToGET(java.lang.String... args)

isApplicableToPOST

@CheckReturnValue
public boolean isApplicableToPOST(java.lang.String... args)

isApplicableToPUT

@CheckReturnValue
public boolean isApplicableToPUT(java.lang.String... args)

getCode

@CheckReturnValue
 @Nonnull
public java.lang.String getCode(java.lang.String... args)

setCode

@Nonnull
public RestDefinition setCode(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getConfigurationJSON

@CheckReturnValue
 @Nonnull
public java.lang.String getConfigurationJSON(java.lang.String... args)

setConfigurationJSON

@Nonnull
public RestDefinition setConfigurationJSON(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getConsumesDELETE

@CheckReturnValue
 @Nonnull
public java.lang.String getConsumesDELETE(java.lang.String... args)

setConsumesDELETE

@Nonnull
public RestDefinition setConsumesDELETE(@MatchesPattern(value="[a-zA-Z0-9]+/[a-zA-Z0-9\\-; =]+(,[a-zA-Z0-9]+/[a-zA-Z0-9\\-; =]+)*")
                                                 java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getConsumesPOST

@CheckReturnValue
 @Nonnull
public java.lang.String getConsumesPOST(java.lang.String... args)

setConsumesPOST

@Nonnull
public RestDefinition setConsumesPOST(@MatchesPattern(value="[a-zA-Z0-9]+/[a-zA-Z0-9\\-; =]+(,[a-zA-Z0-9]+/[a-zA-Z0-9\\-; =]+)*")
                                               java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getConsumesPUT

@CheckReturnValue
 @Nonnull
public java.lang.String getConsumesPUT(java.lang.String... args)

setConsumesPUT

@Nonnull
public RestDefinition setConsumesPUT(@MatchesPattern(value="[a-zA-Z0-9]+/[a-zA-Z0-9\\-; =]+(,[a-zA-Z0-9]+/[a-zA-Z0-9\\-; =]+)*")
                                              java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getCopyFrom

@CheckReturnValue
 @Nullable
public RestDefinition getCopyFrom(java.lang.String... args)

findCopyFrom

@CheckReturnValue
 @Nonnull
public final RestDefinition findCopyFrom(java.lang.String... args)
                                                              throws NotFoundException

Copy RestDefinition From.

--> RestDefinition (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ReST Definition

Throws:

NotFoundException - RestDefinition was not found

setCopyFrom

@Nonnull
public RestDefinition setCopyFrom(com.aspc.dal.cms.rest.RestDefinition value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getCorsAllowedHosts

@CheckReturnValue
 @Nonnull
public java.lang.String getCorsAllowedHosts(java.lang.String... args)

setCorsAllowedHosts

@Nonnull
public RestDefinition setCorsAllowedHosts(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

isDeprecated

@CheckReturnValue
public boolean isDeprecated(java.lang.String... args)

setDeprecated

@Nonnull
public RestDefinition setDeprecated(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDeprecatedNoLongerAvailable

@CheckReturnValue
 @Nullable
public java.util.Date getDeprecatedNoLongerAvailable(java.lang.String... args)

setDeprecatedNoLongerAvailable

@Nonnull
public RestDefinition setDeprecatedNoLongerAvailable(java.util.Date value,
                                                              java.lang.String... args)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

getDeprecatedReason

@CheckReturnValue
 @Nonnull
public java.lang.String getDeprecatedReason(java.lang.String... args)

setDeprecatedReason

@Nonnull
public RestDefinition setDeprecatedReason(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

disableDefaultTransformers

@CheckReturnValue
public boolean disableDefaultTransformers(java.lang.String... args)

setDisableDefaultTransformers

@Nonnull
public RestDefinition setDisableDefaultTransformers(boolean value,
                                                             java.lang.String... args)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

isFinalFg

@CheckReturnValue
public boolean isFinalFg(java.lang.String... args)

setFinalFg

@Nonnull
public RestDefinition setFinalFg(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

hasModifyAccess

@CheckReturnValue
public boolean hasModifyAccess(java.lang.String... args)

getLifeCycle

@CheckReturnValue
 @Nullable
public RestDefinitionLifeCycle getLifeCycle(java.lang.String... args)

findLifeCycle

@CheckReturnValue
 @Nonnull
public final RestDefinitionLifeCycle findLifeCycle(java.lang.String... args)
                                                                        throws NotFoundException

The life cycle phase.

--> RestDefinitionLifeCycle (String, Searchable)

Parameters:

args - the optional arguments

Returns:

RestDefinitionLifeCycle

Throws:

NotFoundException - RestDefinitionLifeCycle was not found

setLifeCycle

@Nonnull
public RestDefinition setLifeCycle(com.aspc.dal.cms.rest.RestDefinitionLifeCycle value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getParserVersion

@CheckReturnValue
 @Nonnegative
public int getParserVersion(java.lang.String... args)

setParserVersion

@Nonnull
public RestDefinition setParserVersion(int value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getPath

@CheckReturnValue
 @Nonnull
public java.lang.String getPath(java.lang.String... args)

getPlugin

@CheckReturnValue
 @Nonnull
public java.lang.String getPlugin(java.lang.String... args)

setPlugin

@Nonnull
public RestDefinition setPlugin(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

setSummary

@Nonnull
public RestDefinition setSummary(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSummaryDELETE

@CheckReturnValue
 @Nonnull
public java.lang.String getSummaryDELETE(java.lang.String... args)

getSummaryDELETERaw

@CheckReturnValue
 @Nonnull
public java.lang.String getSummaryDELETERaw(java.lang.String... args)

setSummaryDELETERaw

@Nonnull
public RestDefinition setSummaryDELETERaw(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getSummaryGET

@CheckReturnValue
 @Nonnull
public java.lang.String getSummaryGET(java.lang.String... args)

getSummaryGETRaw

@CheckReturnValue
 @Nonnull
public java.lang.String getSummaryGETRaw(java.lang.String... args)

setSummaryGETRaw

@Nonnull
public RestDefinition setSummaryGETRaw(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getSummaryPOST

@CheckReturnValue
 @Nonnull
public java.lang.String getSummaryPOST(java.lang.String... args)

getSummaryPOSTRaw

@CheckReturnValue
 @Nonnull
public java.lang.String getSummaryPOSTRaw(java.lang.String... args)

setSummaryPOSTRaw

@Nonnull
public RestDefinition setSummaryPOSTRaw(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getSummaryPUT

@CheckReturnValue
 @Nonnull
public java.lang.String getSummaryPUT(java.lang.String... args)

getSummaryPUTRaw

@CheckReturnValue
 @Nonnull
public java.lang.String getSummaryPUTRaw(java.lang.String... args)

setSummaryPUTRaw

@Nonnull
public RestDefinition setSummaryPUTRaw(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getTags

@CheckReturnValue
 @Nonnull
public java.lang.String getTags(java.lang.String... args)

setTags

@Nonnull
public RestDefinition setTags(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getThrottlingPeriod

@CheckReturnValue
 @Nonnegative
public int getThrottlingPeriod(java.lang.String... args)

setThrottlingPeriod

@Nonnull
public RestDefinition setThrottlingPeriod(int value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getThrottlingRequestLimit

@CheckReturnValue
public int getThrottlingRequestLimit(java.lang.String... args)

setThrottlingRequestLimit

@Nonnull
public RestDefinition setThrottlingRequestLimit(int value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

setUsage

@Nonnull
public RestDefinition setUsage(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getUsageDELETE

@CheckReturnValue
 @Nonnull
public java.lang.String getUsageDELETE(java.lang.String... args)

getUsageDELETERaw

@CheckReturnValue
 @Nonnull
public java.lang.String getUsageDELETERaw(java.lang.String... args)

setUsageDELETERaw

@Nonnull
public RestDefinition setUsageDELETERaw(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getUsageGET

@CheckReturnValue
 @Nonnull
public java.lang.String getUsageGET(java.lang.String... args)

getUsageGETRaw

@CheckReturnValue
 @Nonnull
public java.lang.String getUsageGETRaw(java.lang.String... args)

setUsageGETRaw

@Nonnull
public RestDefinition setUsageGETRaw(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getUsagePOST

@CheckReturnValue
 @Nonnull
public java.lang.String getUsagePOST(java.lang.String... args)

getUsagePOSTRaw

@CheckReturnValue
 @Nonnull
public java.lang.String getUsagePOSTRaw(java.lang.String... args)

setUsagePOSTRaw

@Nonnull
public RestDefinition setUsagePOSTRaw(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getUsagePUT

@CheckReturnValue
 @Nonnull
public java.lang.String getUsagePUT(java.lang.String... args)

getUsagePUTRaw

@CheckReturnValue
 @Nonnull
public java.lang.String getUsagePUTRaw(java.lang.String... args)

setUsagePUTRaw

@Nonnull
public RestDefinition setUsagePUTRaw(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getVersion

@CheckReturnValue
 @Nonnegative
public int getVersion(java.lang.String... args)

setVersion

@Nonnull
public RestDefinition setVersion(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static RestDefinition create(@Nonnull
                                                                MutableDataSource mds)
                                                         throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<RestDefinition> makeQuery(@Nonnull
                                                                            DataSource ds)
                                                                     throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static RestDefinition findKey(@Nonnull
                                                                 DataSource ds,
                                                                 @Nonnull
                                                                 java.lang.String key)
                                                          throws NotFoundException,
                                                                 java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

find

@Nonnull
 @CheckReturnValue
public ContentType find(@Nullable
                                                    java.lang.String accept)
                                             throws ExceptionResponse

Throws:

ExceptionResponse

isValidVariableName

@CheckReturnValue
public boolean isValidVariableName(java.lang.String code)

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(DBField field)

Description copied from class: DBObject

OVERRIDE This method to specify fields should be mandatory under certain conditions.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to check

Returns:

true if the field should be treated as mandatory.

makeValueInt

@CheckReturnValue
public int makeValueInt(WebClient client,
                                          java.lang.String code,
                                          int defaultValue)
                                   throws ExceptionResponse

Make the parameter integer value.

Parameters:

client - the client call

code - the parameter to evaluate.

defaultValue - return this value if the variable doesn't have a default value, and this variable is blank.

Returns:

the value

Throws:

ExceptionResponse - a problem

makeValueLong

@CheckReturnValue
public long makeValueLong(WebClient client,
                                            java.lang.String code,
                                            long defaultValue)
                                     throws ExceptionResponse

Make the parameter long value.

Parameters:

client - the client call

code - the parameter to evaluate.

defaultValue - return this value if the variable doesn't have a default value, and this variable is blank.

Returns:

the value

Throws:

ExceptionResponse - a problem

makeValueDouble

@CheckReturnValue
public double makeValueDouble(WebClient client,
                                                java.lang.String code,
                                                double defaultValue)
                                         throws ExceptionResponse

Make the parameter double value.

Parameters:

client - the client call

code - the parameter to evaluate.

defaultValue - return this value if the variable doesn't have a default value, and this variable is blank.

Returns:

the value

Throws:

ExceptionResponse - a problem

makeValueBoolean

@CheckReturnValue
public boolean makeValueBoolean(WebClient client,
                                                  java.lang.String code,
                                                  boolean defaultValue)
                                           throws ExceptionResponse

Make the parameter Boolean value.

Parameters:

client - the client call

code - the parameter to evaluate.

defaultValue - the default value;

Returns:

the value

Throws:

ExceptionResponse - a problem

makeValue

@CheckReturnValue
 @Nonnull
public java.lang.String makeValue(WebClient client,
                                                              java.lang.String code)
                                                       throws ExceptionResponse

Make the parameter value.

Parameters:

client - the client call

code - the parameter to evaluate.

Returns:

the value

Throws:

ExceptionResponse - a problem

makeList

@CheckReturnValue
 @Nonnull
public java.lang.String[] makeList(WebClient client,
                                                               java.lang.String code)
                                                        throws ExceptionResponse

Make the parameter value.

Parameters:

client - the client call

code - the parameter to evaluate.

Returns:

the value

Throws:

ExceptionResponse - a problem

makeFile

public FileUpload makeFile(WebClient client,
                           java.lang.String code)
                    throws ExceptionResponse

Make the file.

Parameters:

client - the client call

code - the parameter to evaluate.

Returns:

the value

Throws:

ExceptionResponse - a problem

extPreSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

Description copied from class: DBObject

The extended fix up routine

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

extValidateField

@Nullable
 @CheckReturnValue
 @OverridingMethodsMustInvokeSuper
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

getSummary

public java.lang.String getSummary(Method method)

getUsage

public java.lang.String getUsage(Method method)

isApplicableTo

public boolean isApplicableTo(Method method)
                       throws java.lang.Exception

Throws:

java.lang.Exception

parseSQL

public java.lang.String parseSQL(java.lang.String rawSQL,
                                 WebClient client)
                          throws ExceptionResponse

Throws:

ExceptionResponse

checkMagicNumber

@Nonnull
public RestDefinition checkMagicNumber(@Nonnull
                                                RestMagicNumber mn)
                                         throws ExceptionResponse

Throws:

ExceptionResponse

checkAccess

public static void checkAccess(RestDefinition rd,
                               WebClient client,
                               @Nonnull
                               Method method,
                               @Nullable
                               DBMagicNumber magic)
                        throws ExceptionResponse

Throws:

ExceptionResponse

defaultRestPluginDS

protected RestPluginDS defaultRestPluginDS()

defaultRestPluginProcess

protected RestPluginProcess defaultRestPluginProcess()

defaultRestPluginContentType

protected RestPluginContentType defaultRestPluginContentType()

defaultRestPluginConvertResult

protected RestPluginConvertResult defaultRestPluginConvertResult()

defaultRestPluginThrottling

protected RestPluginThrottling defaultRestPluginThrottling()

process

public java.lang.Object process(WebClient client)
                         throws java.lang.Exception

Throws:

java.lang.Exception

findTransform

protected RestDefinitionTransform findTransform(@Nonnull
                                                java.lang.String accept,
                                                @Nonnull
                                                ReadOnlyDataSource ds)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

checkVariables

public void checkVariables(WebClient client,
                           @Nonnull
                           Method method)
                    throws ExceptionResponse

Throws:

ExceptionResponse

restWriteDS

public MutableDataSource restWriteDS(WebClient client,
                                     RestDefinition restDefinition)
                              throws java.lang.Exception

Description copied from interface: RestPluginDS

Create a data source that will be used for writing.

Specified by:

restWriteDS in interface RestPluginDS

Parameters:

client - the client

restDefinition - the definition

Returns:

the data source to use for writing.

Throws:

java.lang.Exception - a problem occurred.

restReadDS

public ReadOnlyDataSource restReadDS(WebClient client,
                                     RestDefinition restDefinition)
                              throws java.lang.Exception

Description copied from interface: RestPluginDS

Create a data source that will be used for reading.

Specified by:

restReadDS in interface RestPluginDS

Parameters:

client - the client

restDefinition - the definition

Returns:

the data source to use for read.

Throws:

java.lang.Exception - a problem occurred.

restCreate

public java.lang.Object restCreate(WebClient client,
                                   RestDefinition restDefinition,
                                   MutableDataSource mds)
                            throws java.lang.Exception

Description copied from interface: RestPluginProcess

HTTP POST calls the the Create ReST service.

Specified by:

restCreate in interface RestPluginProcess

Parameters:

client - the client. Null means check only of ops

restDefinition - the definition

mds - the data source to use

Returns:

the JSON object/array if processed.

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

ExceptionResponse - an error has occurred.

java.lang.Exception

restRetrieve

public java.lang.Object restRetrieve(WebClient client,
                                     RestDefinition restDefinition,
                                     ReadOnlyDataSource rds)
                              throws java.lang.Exception

Description copied from interface: RestPluginProcess

HTTP GET calls the the Retrieval ReST service.

Specified by:

restRetrieve in interface RestPluginProcess

Parameters:

client - the client. Null means check only of ops

restDefinition - the definition

rds - the data source to use

Returns:

the JSON object/array if processed.

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

java.lang.Exception - an error has occurred.

restUpdate

public java.lang.Object restUpdate(WebClient client,
                                   RestDefinition restDefinition,
                                   MutableDataSource mds)
                            throws java.lang.Exception

Description copied from interface: RestPluginProcess

HTTP PUT calls the the Update ReST service.

Specified by:

restUpdate in interface RestPluginProcess

Parameters:

client - the client. Null means check only of ops

restDefinition - the definition

mds - the data source to use

Returns:

the JSON object/array if processed.

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

ExceptionResponse - an error has occurred.

java.lang.Exception

restDelete

public java.lang.Object restDelete(WebClient client,
                                   RestDefinition restDefinition,
                                   MutableDataSource mds)
                            throws java.lang.Exception

Description copied from interface: RestPluginProcess

HTTP DELETE calls the the Delete ReST service.

Specified by:

restDelete in interface RestPluginProcess

Parameters:

client - the client. Null means check only of ops

restDefinition - the definition

mds - the data source to use.

Returns:

the JSON object/array if processed.

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

ExceptionResponse - an error has occurred.

java.lang.Exception

getTargetContentType

public ContentType getTargetContentType(RestDefinition rd,
                                        WebClient client,
                                        ContentType acceptType)

Description copied from interface: RestPluginContentType

The content type.

Specified by:

getTargetContentType in interface RestPluginContentType

Parameters:

rd - the definition

client - the client

acceptType - the accepted type.

Returns:

the target type.

convertResult

public RestServerResponse convertResult(RestDefinition rd,
                                        WebClient client,
                                        ContentType type,
                                        java.lang.Object value)
                                 throws java.lang.Exception

Description copied from interface: RestPluginConvertResult

Convert the result

Specified by:

convertResult in interface RestPluginConvertResult

Parameters:

rd - the definition

client - the client

type - the target type

value - the value to be converted.

Returns:

the result value.

Throws:

java.lang.Exception - a serious problem.

getCounterKey

public java.lang.String getCounterKey(@Nonnull
                                      WebClient client,
                                      @Nonnull
                                      RestDefinition rd)
                               throws java.lang.UnsupportedOperationException,
                                      java.lang.Exception,
                                      java.lang.IllegalArgumentException

Description copied from interface: RestPluginThrottling

get the key of the throttling counter, the key has to be shorter than 255 characters

Specified by:

getCounterKey in interface RestPluginThrottling

Parameters:

client - the client. Null means check only of ops

rd - the definition

Returns:

The throttling counter key. Does NOT throttling if this method return null or empty string

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

java.lang.Exception - an error has occurred.

java.lang.IllegalArgumentException

getRequestLimit

public int getRequestLimit(@Nonnull
                           WebClient client,
                           @Nonnull
                           RestDefinition rd)
                    throws java.lang.UnsupportedOperationException,
                           java.lang.Exception

Description copied from interface: RestPluginThrottling

-1 is no limit 0 is always reject n is allow n requests in each throttling period

Specified by:

getRequestLimit in interface RestPluginThrottling

Parameters:

client - the client. Null means check only of ops

rd - the definition

Returns:

Throws:

java.lang.UnsupportedOperationException - use default throttling settings configured in RestDefinition record

java.lang.Exception

getPeriod

public int getPeriod(@Nonnull
                     WebClient client,
                     @Nonnull
                     RestDefinition rd)
              throws java.lang.UnsupportedOperationException,
                     java.lang.Exception

Description copied from interface: RestPluginThrottling

get the throttling period in seconds

Specified by:

getPeriod in interface RestPluginThrottling

Parameters:

client - the client. Null means check only of ops

rd - the definition

Returns:

Throws:

java.lang.UnsupportedOperationException - use default throttling settings configured in RestDefinition record

java.lang.Exception