public class DBTask extends DBObject
DBObject.DenormalizeAction
Modifier and Type | Field and Description |
---|---|
static java.lang.Object |
BEAT
gate keeper when we are creating a task in heart_beat table
|
static GlobalId |
DBCLASS_GID
A DBTask is a background process that needs to be monitored.
|
static java.lang.String |
DBCLASS_NAME
A DBTask is a background process that needs to be monitored.
|
ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS
Constructor and Description |
---|
DBTask(DBClass def,
DataSource dataSource)
Std.
|
Modifier and Type | Method and Description |
---|---|
int |
countLocks()
counts number of locked transactions
|
int |
countTransSyncMap() |
static DBTask |
create(MutableDataSource mds)
Make a new instance of this class.
|
java.lang.String |
end()
END the task
|
java.lang.String |
end(java.lang.String session_id) |
void |
error(java.lang.String message)
sets the task to error.
|
protected void |
extDeleteRecord(long transNr)
OVERRIDE this method to add functionality to stSoftware WHILE deleting the record from the database.
|
protected java.lang.Object |
extGetDerivedValue(DBField field,
FldParams params)
Calculate the derived value for this field.
|
protected void |
extPreValidate()
Update the in-memory universe BEFORE validating
|
protected void |
extSaveRecord(long transNr)
Additional functionality WHILE saving this record to the database.
|
protected void |
extValidateRecord(ValidationList list)
Performs additional validations on this record.
|
static DBTask |
findKey(DataSource ds,
java.lang.String key)
Find the target for this class by the primary key
|
DBTaskMonitorLevel |
findMonitorLevel(java.lang.String... args)
monitor level either fatal, error or warn.
|
static DBTask |
findOne(java.lang.String code,
DataSource ds)
used to find the db task
|
DBTaskStatus |
findStatus(java.lang.String... args)
The status of this task.
|
DBTaskType |
findType(java.lang.String... args)
The type of the task.
|
java.lang.String |
getCode(java.lang.String... args) |
java.lang.String |
getCurrentHostname(java.lang.String... args) |
java.lang.String |
getCurrentSession(java.lang.String... args) |
java.lang.String |
getDescription(java.lang.String... args) |
java.lang.String |
getErrorTx(java.lang.String... args) |
java.lang.String |
getExternalErrorTx(java.lang.String... args) |
java.lang.String |
getGracePeriod(java.lang.String... args) |
java.lang.String |
getHeartBeatDuration(java.lang.String... args) |
java.lang.String |
getLabel(java.lang.String... args) |
java.util.Date |
getLastBeatTime(java.lang.String... args) |
java.util.Date |
getLastNotified(java.lang.String... args) |
java.lang.String |
getMode(java.lang.String session_id) |
DBTaskMonitorLevel |
getMonitorLevel(java.lang.String... args) |
java.lang.String |
getNotificationPeriod(java.lang.String... args) |
java.lang.String |
getParameters(java.lang.String... args) |
java.lang.Object |
getPlugin()
get the task plugin.
|
java.lang.String |
getProcessDuration(java.lang.String... args) |
java.lang.String |
getRawCurrentSession(java.lang.String... args) |
java.lang.String |
getRawStartKey(java.lang.String... args) |
long |
getRawTransGroup(java.lang.String... args) |
java.lang.String |
getStartedKey(java.lang.String... args) |
DBTaskStatus |
getStatus(java.lang.String... args) |
long |
getStatusForKey(java.lang.String key)
return the transaction status on the global key, Make sure that key is for this task
|
java.util.Date |
getSuppressUntil(java.lang.String... args) |
java.lang.String |
getTransactionErrors()
get the errors associated the transactions
|
java.lang.String |
getTransErrorText(java.lang.String... args) |
int |
getTransGroup(java.lang.String... args) |
int |
getTransGroupLayer(java.lang.String... args) |
DBTaskType |
getType(java.lang.String... args) |
boolean |
hasTransSyncMap() |
void |
heartBeat()
Heart Beat for this task.
|
boolean |
isEnabled(java.lang.String... args) |
boolean |
isHa(java.lang.String... args) |
boolean |
isMaintaining(java.lang.String... args) |
java.awt.Color |
makeColor() |
static DBQuery<DBTask> |
makeQuery(DataSource ds)
Make a new QUERY for this class.
|
DBTask |
setCode(java.lang.String value,
java.lang.String... args) |
DBTask |
setCurrentHostname(java.lang.String value,
java.lang.String... args) |
DBTask |
setDescription(java.lang.String value,
java.lang.String... args) |
DBTask |
setEnabled(boolean value,
java.lang.String... args) |
DBTask |
setExternalErrorTx(java.lang.String value,
java.lang.String... args) |
DBTask |
setGracePeriod(java.lang.String value,
java.lang.String... args) |
DBTask |
setHa(boolean value,
java.lang.String... args) |
DBTask |
setHeartBeatDuration(java.lang.String value,
java.lang.String... args) |
DBTask |
setLabel(java.lang.String value,
java.lang.String... args) |
DBTask |
setLastNotified(java.util.Date value,
java.lang.String... args) |
DBTask |
setMonitorLevel(com.aspc.dal.task.DBTaskMonitorLevel value,
java.lang.String... args) |
DBTask |
setNotificationPeriod(java.lang.String value,
java.lang.String... args) |
DBTask |
setParameters(java.lang.String value,
java.lang.String... args) |
DBTask |
setPlugin(java.lang.String value,
java.lang.String... args) |
DBTask |
setProcessDuration(java.lang.String value,
java.lang.String... args) |
DBTask |
setRawCurrentSession(java.lang.String value,
java.lang.String... args) |
DBTask |
setRawStartKey(java.lang.String value,
java.lang.String... args) |
DBTask |
setRawTransGroup(long value,
java.lang.String... args) |
DBTask |
setSuppressUntil(java.util.Date value,
java.lang.String... args) |
DBTask |
setType(com.aspc.dal.task.DBTaskType value,
java.lang.String... args) |
java.lang.String[] |
start() |
java.lang.String[] |
start(java.lang.String startkey)
if the task is dead or end return update it to ok and return the transId
startKey - Key assigned to start the task.
|
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, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSetValue, extUndelete, extValidateDelete, extValidateField, 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
public static final java.lang.String DBCLASS_NAME
public static final GlobalId DBCLASS_GID
public static final java.lang.Object BEAT
public DBTask(DBClass def, DataSource dataSource) throws java.lang.Exception
def
- The class of this objectdataSource
- The datasource for this objectjava.lang.Exception
- A serious problem occurred@CheckReturnValue @Nonnull public java.lang.String getCode(java.lang.String... args)
@Nonnull public DBTask setCode(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getCurrentHostname(java.lang.String... args)
@Nonnull public DBTask setCurrentHostname(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getCurrentSession(java.lang.String... args)
@CheckReturnValue @Nonnull public java.lang.String getDescription(java.lang.String... args)
@Nonnull public DBTask setDescription(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue public boolean isEnabled(java.lang.String... args)
@Nonnull public DBTask setEnabled(boolean value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getErrorTx(java.lang.String... args)
@CheckReturnValue @Nonnull public java.lang.String getExternalErrorTx(java.lang.String... args)
@Nonnull public DBTask setExternalErrorTx(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getGracePeriod(java.lang.String... args)
@Nonnull public DBTask setGracePeriod(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getHeartBeatDuration(java.lang.String... args)
@Nonnull public DBTask setHeartBeatDuration(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue public boolean isHa(java.lang.String... args)
@Nonnull public DBTask setHa(boolean value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue public boolean isMaintaining(java.lang.String... args)
@CheckReturnValue @Nonnull public java.lang.String getLabel(java.lang.String... args)
@Nonnull public DBTask setLabel(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable public java.util.Date getLastBeatTime(java.lang.String... args)
@CheckReturnValue @Nullable public java.util.Date getLastNotified(java.lang.String... args)
@Nonnull public DBTask setLastNotified(java.util.Date value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable public DBTaskMonitorLevel getMonitorLevel(java.lang.String... args)
@CheckReturnValue @Nonnull public final DBTaskMonitorLevel findMonitorLevel(java.lang.String... args) throws NotFoundException
DBTaskMonitorLevel
(String, Searchable)args
- the optional argumentsNotFoundException
- DBTaskMonitorLevel was not found@Nonnull public DBTask setMonitorLevel(com.aspc.dal.task.DBTaskMonitorLevel value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getNotificationPeriod(java.lang.String... args)
@Nonnull public DBTask setNotificationPeriod(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getParameters(java.lang.String... args)
@Nonnull public DBTask setParameters(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@Nonnull public DBTask setPlugin(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getProcessDuration(java.lang.String... args)
@Nonnull public DBTask setProcessDuration(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getRawCurrentSession(java.lang.String... args)
@Nonnull public DBTask setRawCurrentSession(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getRawStartKey(java.lang.String... args)
@Nonnull public DBTask setRawStartKey(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue public long getRawTransGroup(java.lang.String... args)
@Nonnull public DBTask setRawTransGroup(long value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getStartedKey(java.lang.String... args)
@CheckReturnValue @Nullable public DBTaskStatus getStatus(java.lang.String... args)
@CheckReturnValue @Nonnull public final DBTaskStatus findStatus(java.lang.String... args) throws NotFoundException
DBTaskStatus
(String,
Derived, Searchable)args
- the optional argumentsNotFoundException
- DBTaskStatus was not found@CheckReturnValue @Nullable public java.util.Date getSuppressUntil(java.lang.String... args)
@Nonnull public DBTask setSuppressUntil(java.util.Date value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getTransErrorText(java.lang.String... args)
@CheckReturnValue public int getTransGroup(java.lang.String... args)
@CheckReturnValue public int getTransGroupLayer(java.lang.String... args)
@CheckReturnValue @Nullable public DBTaskType getType(java.lang.String... args)
@CheckReturnValue @Nonnull public final DBTaskType findType(java.lang.String... args) throws NotFoundException
DBTaskType
(String, Mandatory,
Searchable)args
- the optional argumentsNotFoundException
- DBTaskType was not found@Nonnull public DBTask setType(com.aspc.dal.task.DBTaskType value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@Nonnull @CheckReturnValue public static DBTask create(@Nonnull MutableDataSource mds) throws java.lang.Exception
mds
- the datasourcejava.lang.Exception
- an object of this class could not be created@Nonnull @CheckReturnValue public static DBQuery<DBTask> makeQuery(@Nonnull DataSource ds) throws NotFoundException
ds
- the datasourceNotFoundException
- if class could not be found@Nonnull @CheckReturnValue public static DBTask findKey(@Nonnull DataSource ds, @Nonnull java.lang.String key) throws NotFoundException, java.lang.Exception
ds
- the datasourcekey
- the valueNotFoundException
- if target could not be foundjava.lang.Exception
- a serious problempublic java.lang.Object getPlugin() throws java.lang.Exception
java.lang.Exception
- a serious problem.public void error(java.lang.String message) throws java.lang.Exception
message
- The error messagejava.lang.Exception
- A serious problem@CheckReturnValue @Nonnull public java.lang.String getMode(@Nullable java.lang.String session_id)
session_id
- Session ID for the taskpublic java.lang.String end() throws java.lang.Exception
java.lang.Exception
- Serious problempublic java.lang.String end(java.lang.String session_id) throws java.lang.Exception
session_id
- Session IDjava.lang.Exception
- A serious problem.public java.lang.String[] start() throws java.lang.Exception
java.lang.Exception
- A serious problem.public java.lang.String[] start(java.lang.String startkey) throws java.lang.Exception
startkey
- Key assigned to start the task.java.lang.Exception
- A serious problem.public void heartBeat() throws java.lang.Exception
java.lang.Exception
- A serious problempublic java.awt.Color makeColor()
public boolean hasTransSyncMap() throws java.lang.Exception
java.lang.Exception
- A serious problem.public int countTransSyncMap() throws java.lang.Exception
java.lang.Exception
- A serious problem.public int countLocks() throws java.lang.Exception
java.lang.Exception
- A serious problem.@OverridingMethodsMustInvokeSuper protected void extPreValidate() throws java.lang.Exception
extPreValidate
in class DBObject
java.lang.Exception
- A serious problem@OverridingMethodsMustInvokeSuper protected void extValidateRecord(@Nonnull ValidationList list) throws java.lang.Exception
extValidateRecord
in class DBObject
list
- The validation list.java.lang.Exception
- A serious problem@CheckReturnValue protected java.lang.Object extGetDerivedValue(@Nonnull DBField field, @Nullable FldParams params) throws java.lang.Exception
extGetDerivedValue
in class DBObject
field
- The field to getparams
- The parameters for this field eg. language= or default=java.lang.Exception
- A serious problem@OverridingMethodsMustInvokeSuper protected void extDeleteRecord(@Nonnegative long transNr) throws java.lang.Exception
DBObject
extDeleteRecord
in class DBObject
transNr
- Transaction numberjava.lang.Exception
- Serious Problem@OverridingMethodsMustInvokeSuper protected void extSaveRecord(@Nonnegative long transNr) throws java.lang.Exception
extSaveRecord
in class DBObject
transNr
- This transaction number that was just saved.java.lang.Exception
- A serious problempublic static DBTask findOne(java.lang.String code, DataSource ds) throws java.lang.Exception
code
- - task codeds
- data sourcejava.lang.Exception
- if there are more than one DBTasks foundpublic long getStatusForKey(java.lang.String key) throws java.lang.Exception
key
- - is the global keyjava.lang.Exception
- if the sql error happens@CheckReturnValue @Nonnull public java.lang.String getTransactionErrors() throws java.lang.Exception
java.lang.Exception
- a Serious problem has occurredstSoftware Copyright © 2001-2014 stSoftware All Rights Reserved.