com.aspc.DBObj.Email

Class RestTemplateVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Email.DBEmailTemplateVariable

com.aspc.DBObj.Email.RestTemplateVariable

All Implemented Interfaces:

Variable, SecondaryCacheGroup

public class RestTemplateVariable
extends DBEmailTemplateVariable

RestTemplateVariable.

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

Since:

11 Sep 2018

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 RestTemplateVariable
static java.lang.String	DBCLASS_NAME RestTemplateVariable

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestTemplateVariable(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	calculateJSON(java.util.List<Variable> extraVars)
java.lang.String	calculateResult(java.util.List<Variable> variables)
java.lang.String	encodeValue(java.lang.String value)
java.lang.String	execute() get value of this variable
java.lang.String	execute(java.util.List<Variable> extraVars) Extra variables
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
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	getJsonPath(java.lang.String... args)
SqlVariableRunAs	getLocalRunAs(java.lang.String... args)
java.lang.String	getLocalURL(java.lang.String... args)
java.lang.String	getValue(java.util.List<Variable> variables)
java.util.List<Variable>	loadVariables(java.util.List<Variable> runtimeVars)
RestTemplateVariable	setArguments(java.lang.String value, java.lang.String... args)
RestTemplateVariable	setCachePeriod(java.lang.String value, java.lang.String... args)
RestTemplateVariable	setJsonPath(java.lang.String value, java.lang.String... args)
RestTemplateVariable	setLocalRunAs(com.aspc.dal.cms.variable.SQLVariableRunAs value, java.lang.String... args)
RestTemplateVariable	setLocalURL(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.Email.DBEmailTemplateVariable

findKey, findTemplate, getDefaultResult, getID, getName, getResult, getSequence, getTemplate, isIgnoreError, isIgnoreValidating, makeQuery, setDefaultResult, setID, setIgnoreError, setIgnoreValidating, setName, setSequence, setTemplate

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, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, 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

RestTemplateVariable

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

RestTemplateVariable

Constructor Detail

RestTemplateVariable

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

Throws:

java.lang.Exception

Method Detail

getArguments

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

setArguments

@Nonnull
public RestTemplateVariable 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 RestTemplateVariable setCachePeriod(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getJsonPath

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

setJsonPath

@Nonnull
public RestTemplateVariable setJsonPath(java.lang.String 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 RestTemplateVariable 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 RestTemplateVariable setLocalURL(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

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

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

execute

public java.lang.String execute()
                         throws TemplateVariableParseException,
                                java.lang.Exception

get value of this variable

Specified by:

execute in class DBEmailTemplateVariable

Returns:

Throws:

TemplateVariableParseException - parse exception if ignoreError flag is not checked

java.lang.Exception

execute

@Nonnull
public java.lang.String execute(java.util.List<Variable> extraVars)
                                  throws TemplateVariableParseException,
                                         java.lang.Exception

Extra variables

Specified by:

execute in class DBEmailTemplateVariable

Parameters:

extraVars -

Returns:

the value

Throws:

TemplateVariableParseException - parse exception if ignoreError flag is not checked

java.lang.Exception - a serious problem.

calculateJSON

public java.lang.Object calculateJSON(java.util.List<Variable> extraVars)
                               throws java.lang.Exception

Throws:

java.lang.Exception

loadVariables

public java.util.List<Variable> loadVariables(java.util.List<Variable> runtimeVars)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

calculateResult

public java.lang.String calculateResult(java.util.List<Variable> variables)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

encodeValue

public java.lang.String encodeValue(java.lang.String value)

getValue

public java.lang.String getValue(java.util.List<Variable> variables)
                          throws java.lang.Exception

Throws:

java.lang.Exception