com.aspc.cms.variable.json

Class RestVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.variable.SiteVariable

com.aspc.cms.variable.json.JSONResultVariable

com.aspc.cms.variable.json.RestVariable

All Implemented Interfaces:

SecondaryCacheGroup

public class RestVariable
extends JSONResultVariable

Representational State Transfer (ReST) returning JSON using HTTP(S) GET call which is cachable.

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

Since:

02 May 2013

Author:

Liam Itzhaki

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 Representational State Transfer (ReST) returning JSON using HTTP(S) GET call which is cachable.
static java.lang.String	DBCLASS_NAME Representational State Transfer (ReST) returning JSON using HTTP(S) GET call which is cachable.
static java.lang.String	REST_ERRORS
static java.lang.String	REST_WARNINGS

Fields inherited from class com.aspc.cms.variable.SiteVariable

DEFAULT_VARIABLE_ENCODE, WEB_CLIENT

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestVariable(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	calculateJSON(WebClient wc, java.util.HashMap<java.lang.String,SiteVariableCalculation> variables, SiteComponent component)
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 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.
SqlVariableRunAs	findLocalRunAs(java.lang.String... args) Local request Run As.
java.lang.String	getArguments(java.lang.String... args)
java.lang.String	getCachePeriod(java.lang.String... args)
java.lang.String	getExampleURL(java.lang.String... args)
SqlVariableRunAs	getLocalRunAs(java.lang.String... args)
java.lang.String	getLocalURL(java.lang.String... args)
java.lang.String	getRemotePassword(java.lang.String... args)
java.lang.String	getRemoteURL(java.lang.String... args)
java.lang.String	getRemoteUser(java.lang.String... args)
boolean	isLocalCall(java.lang.String... args)
boolean	isRemoteAuthorization(java.lang.String... args)
RestVariable	setArguments(java.lang.String value, java.lang.String... args)
RestVariable	setCachePeriod(java.lang.String value, java.lang.String... args)
RestVariable	setLocalCall(boolean value, java.lang.String... args)
RestVariable	setLocalRunAs(com.aspc.dal.cms.variable.SQLVariableRunAs value, java.lang.String... args)
RestVariable	setLocalURL(java.lang.String value, java.lang.String... args)
RestVariable	setRemoteAuthorization(boolean value, java.lang.String... args)
RestVariable	setRemotePassword(java.lang.String value, java.lang.String... args)
RestVariable	setRemoteURL(java.lang.String value, java.lang.String... args)
RestVariable	setRemoteUser(java.lang.String value, java.lang.String... args)
protected void	validateSubType(DBField field, java.lang.Object value) http://www.regular-expressions.info/email.html http://tools.ietf.org/html/rfc2822#section-3.4.1

Methods inherited from class com.aspc.cms.variable.json.JSONResultVariable

getResultJSON

Methods inherited from class com.aspc.cms.variable.SiteVariable

extGetDerivedGlobalKey, extValidateRecord, findComponent, findInheritedByComponent, findKey, findOwnedBySite, findSite, getComponent, getID, getInheritedByComponent, getLabel, getName, getOwnedBySite, getPath, getResult, getSequence, getSite, isVisibleToThisComponent, makeQuery, setComponent, setID, setLabel, setName, setSequence, setSite

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, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

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

Representational State Transfer (ReST) returning JSON using HTTP(S) GET call which is cachable.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Representational State Transfer (ReST) returning JSON using HTTP(S) GET call which is cachable.

REST_ERRORS

public static final java.lang.String REST_ERRORS

See Also:

Constant Field Values

REST_WARNINGS

public static final java.lang.String REST_WARNINGS

See Also:

Constant Field Values

Constructor Detail

RestVariable

public RestVariable(DBClass def,
                    DataSource dataSource)
             throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getArguments

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

setArguments

@Nonnull
public RestVariable setArguments(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getCachePeriod

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

setCachePeriod

@Nonnull
public RestVariable setCachePeriod(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getExampleURL

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

isLocalCall

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

setLocalCall

@Nonnull
public RestVariable setLocalCall(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getLocalRunAs

@CheckReturnValue
 @Nullable
public SqlVariableRunAs getLocalRunAs(java.lang.String... args)

findLocalRunAs

@CheckReturnValue
 @Nonnull
public final SqlVariableRunAs findLocalRunAs(java.lang.String... args)
                                                                  throws NotFoundException

Local request Run As.

--> SQLVariableRunAs (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SQLVariableRunAs

Throws:

NotFoundException - SQLVariableRunAs was not found

setLocalRunAs

@Nonnull
public RestVariable setLocalRunAs(com.aspc.dal.cms.variable.SQLVariableRunAs value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getLocalURL

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

setLocalURL

@Nonnull
public RestVariable setLocalURL(@MatchesPattern(value="/(feed|[Rr][Ee][sS][tT]/(article.*|(v|V)[0-9]+/[a-zA-Z0-9]+)(|/.*))(\\?.*)*")
                                         java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isRemoteAuthorization

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

setRemoteAuthorization

@Nonnull
public RestVariable setRemoteAuthorization(boolean value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getRemotePassword

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

setRemotePassword

@Nonnull
public RestVariable setRemotePassword(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getRemoteURL

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

setRemoteURL

@Nonnull
public RestVariable setRemoteURL(@MatchesPattern(value="(https|http)://.*")
                                          java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getRemoteUser

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

setRemoteUser

@Nonnull
public RestVariable setRemoteUser(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

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

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 SiteVariable

Throws:

java.lang.Exception - a serious problem

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
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

calculateJSON

public java.lang.Object calculateJSON(WebClient wc,
                                      java.util.HashMap<java.lang.String,SiteVariableCalculation> variables,
                                      SiteComponent component)
                               throws java.lang.Exception

Overrides:

calculateJSON in class SiteVariable

Parameters:

wc - the web client

variables - the variables.

component -

Returns:

the object

Throws:

java.lang.Exception - a serious problem

validateSubType

protected void validateSubType(@Nonnull
                               DBField field,
                               @Nullable
                               java.lang.Object value)
                        throws InvalidDataException,
                               InvalidDataWarning

Description copied from class: DBObject

http://www.regular-expressions.info/email.html http://tools.ietf.org/html/rfc2822#section-3.4.1

Overrides:

validateSubType in class DBObject

Parameters:

field - The field

value - the value

Throws:

InvalidDataException - invalidate data

InvalidDataWarning

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 JSONResultVariable

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