com.aspc.cms.rest

Class RestDefinitionSQL

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.rest.RestDefinition

com.aspc.cms.rest.RestDefinitionSQL

All Implemented Interfaces:

RestPluginContentType, RestPluginConvertResult, RestPluginDS, RestPluginProcess, RestPluginProducedTypes, RestPluginSupportedMethods, RestPluginThrottling, SecondaryCacheGroup

public class RestDefinitionSQL
extends RestDefinition
implements RestPluginSupportedMethods, RestPluginProducedTypes

SQL based ReST definition.

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

Since:

08 November 2014

Author:

Nigel Leck

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 SQL based ReST definition
static java.lang.String	DBCLASS_NAME SQL based ReST definition

Fields inherited from class com.aspc.cms.rest.RestDefinition

JSON_KEY_RESULTS, JSON_KEY_SUCCESS, PARAMETER_ACCEPT, PARAMETER_MAGIC, PARAMETER_METHOD, REST_DEFINITION_ATTRIBUTE, SUPRESS_DEPRECATION_WARNING

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestDefinitionSQL(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
RestServerResponse	convertResult(RestDefinition rd, WebClient client, ContentType type, java.lang.Object value) Convert the result
protected boolean	extIsMandatory(DBField field) OVERRIDE This method to specify fields should be mandatory under certain conditions.
java.lang.String	getCreateSQL(java.lang.String... args)
java.lang.String	getDeleteSQL(java.lang.String... args)
java.lang.String	getHeadSQL(java.lang.String... args)
java.lang.String	getRetrieveSQL(java.lang.String... args)
java.lang.String	getUpdateSQL(java.lang.String... args)
boolean	isValidVariableName(java.lang.String code)
ContentType[]	listProducedTypes(Method method) List of produced types
Method[]	listSupportedMethods() List of methods supported.
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.
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.
java.lang.Object	retrieval(DataSource rds, java.lang.String sql, java.lang.String baseURI, int offset, int limit)
RestDefinitionSQL	setCreateSQL(java.lang.String value, java.lang.String... args)
RestDefinitionSQL	setDeleteSQL(java.lang.String value, java.lang.String... args)
RestDefinitionSQL	setHeadSQL(java.lang.String value, java.lang.String... args)
RestDefinitionSQL	setRetrieveSQL(java.lang.String value, java.lang.String... args)
RestDefinitionSQL	setUpdateSQL(java.lang.String value, java.lang.String... args)
java.lang.Object	write(MutableDataSource mds, java.lang.String sql)

Methods inherited from class com.aspc.cms.rest.RestDefinition

checkAccess, checkMagicNumber, checkVariables, create, defaultRestPluginContentType, defaultRestPluginConvertResult, defaultRestPluginDS, defaultRestPluginProcess, defaultRestPluginThrottling, disableDefaultTransformers, extFixUp, extGetDerivedValue, extPreSaveRecord, extPreValidate, extValidateField, find, findCopyFrom, findKey, findLifeCycle, findTransform, getAliases, getCode, getConfigurationJSON, getConsumesDELETE, getConsumesPOST, getConsumesPUT, getCopyFrom, getCorsAllowedHosts, getCounterKey, getDeprecatedNoLongerAvailable, getDeprecatedReason, getKey, getLifeCycle, getParserVersion, getPath, getPeriod, getPlugin, getRequestLimit, getSummary, getSummaryDELETE, getSummaryDELETERaw, getSummaryGET, getSummaryGETRaw, getSummaryPOST, getSummaryPOSTRaw, getSummaryPUT, getSummaryPUTRaw, getTags, getTargetContentType, getThrottlingPeriod, getThrottlingRequestLimit, getUsage, getUsageDELETE, getUsageDELETERaw, getUsageGET, getUsageGETRaw, getUsagePOST, getUsagePOSTRaw, getUsagePUT, getUsagePUTRaw, getVersion, hasModifyAccess, isApplicableTo, isApplicableToDELETE, isApplicableToGET, isApplicableToPOST, isApplicableToPUT, isDeprecated, isFinalFg, makeFile, makeList, makeQuery, makeValue, makeValueBoolean, makeValueDouble, makeValueInt, makeValueLong, parseSQL, process, restReadDS, restWriteDS, setAliases, setCode, setConfigurationJSON, setConsumesDELETE, setConsumesPOST, setConsumesPUT, setCopyFrom, setCorsAllowedHosts, setDeprecated, setDeprecatedNoLongerAvailable, setDeprecatedReason, setDisableDefaultTransformers, setFinalFg, setKey, setLifeCycle, setParserVersion, setPlugin, setSummary, setSummaryDELETERaw, setSummaryGETRaw, setSummaryPOSTRaw, setSummaryPUTRaw, setTags, setThrottlingPeriod, setThrottlingRequestLimit, setUsage, setUsageDELETERaw, setUsageGETRaw, setUsagePOSTRaw, setUsagePUTRaw, setVersion

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

SQL based ReST definition

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

SQL based ReST definition

Constructor Detail

RestDefinitionSQL

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

Throws:

java.lang.Exception

Method Detail

getCreateSQL

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

setCreateSQL

@Nonnull
public RestDefinitionSQL setCreateSQL(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getDeleteSQL

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

setDeleteSQL

@Nonnull
public RestDefinitionSQL setDeleteSQL(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getHeadSQL

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

setHeadSQL

@Nonnull
public RestDefinitionSQL setHeadSQL(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRetrieveSQL

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

setRetrieveSQL

@Nonnull
public RestDefinitionSQL setRetrieveSQL(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getUpdateSQL

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

setUpdateSQL

@Nonnull
public RestDefinitionSQL setUpdateSQL(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

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 RestDefinition

Parameters:

field - The field to check

Returns:

true if the field should be treated as mandatory.

isValidVariableName

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

Overrides:

isValidVariableName in class RestDefinition

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

Overrides:

restCreate in class RestDefinition

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

Overrides:

restRetrieve in class RestDefinition

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

Overrides:

restUpdate in class RestDefinition

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

Overrides:

restDelete in class RestDefinition

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

write

public java.lang.Object write(MutableDataSource mds,
                              java.lang.String sql)
                       throws java.lang.Exception

Throws:

java.lang.Exception

retrieval

public java.lang.Object retrieval(DataSource rds,
                                  java.lang.String sql,
                                  java.lang.String baseURI,
                                  int offset,
                                  int limit)
                           throws java.lang.Exception

Throws:

java.lang.Exception

listSupportedMethods

public Method[] listSupportedMethods()
                              throws java.lang.Exception

Description copied from interface: RestPluginSupportedMethods

List of methods supported.

Specified by:

listSupportedMethods in interface RestPluginSupportedMethods

Returns:

the list of methods supported.

Throws:

java.lang.Exception

listProducedTypes

public ContentType[] listProducedTypes(Method method)
                                throws ExceptionResponse

Description copied from interface: RestPluginProducedTypes

List of produced types

Specified by:

listProducedTypes in interface RestPluginProducedTypes

Parameters:

method - the method

Returns:

the list of types produced.

Throws:

ExceptionResponse

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

Overrides:

convertResult in class RestDefinition

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.