com.aspc.file

Class DBFileStoreLog

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.DBLog

com.aspc.file.DBFileStoreLog

All Implemented Interfaces:

SecondaryCacheGroup

public class DBFileStoreLog
extends DBLog

Logs errors against a file store. This is mainly intended to log errors where the file store is unavailable, then alerts can be configured through the event system to notify administrators of the problem. logs an error message against a file location.

Notes




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

Since:

November 1, 2005

Author:

luke

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 logs an error message against a file location
static java.lang.String	DBCLASS_NAME logs an error message against a file location

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Gets the global key for the given derived field
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Gets the value for a derived field
DBFile	findFile(java.lang.String... args) The file id that the error occurred on, if there is one.
DBFileStore	findFileStore(java.lang.String... args) the code of the filestore the error occured against.
DBFile	getFile(java.lang.String... args)
java.lang.String	getFileKey(java.lang.String... args)
java.lang.String	getFileName(java.lang.String... args)
DBFileStore	getFileStore(java.lang.String... args)
java.lang.String	getFileStoreKey(java.lang.String... args)
java.lang.String	getFileStoreName(java.lang.String... args)
java.lang.String	getSource(java.lang.String... args)
static void	logError(java.lang.String msg, java.lang.String store, java.lang.String source, java.lang.String file, DataSource ds) Logs an error against a file store, with DBFIELD_LEVEL set to ERROR
protected HTMLPanel	makeSummary()
DBFileStoreLog	setFileKey(java.lang.String value, java.lang.String... args)
DBFileStoreLog	setFileStoreKey(java.lang.String value, java.lang.String... args)
DBFileStoreLog	setSource(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBLog

create, findKey, findLevel, findPerson, getID, getLevel, getMessage, getPerson, getPersonKey, getPersonName, getSessionId, getSummaryHTML, getTime, logError, makeHeadLine, makeQuery, setID, setLevel, setMessage, setPersonKey, setSessionId, setTime

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

logs an error message against a file location

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

logs an error message against a file location

Constructor Detail

DBFileStoreLog

public DBFileStoreLog(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

getFile

@CheckReturnValue
 @Nullable
public DBFile getFile(java.lang.String... args)

findFile

@CheckReturnValue
 @Nonnull
public final DBFile findFile(java.lang.String... args)
                                                  throws NotFoundException

The file id that the error occurred on, if there is one.

--> DBFile (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

getFileKey

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

setFileKey

@Nonnull
public DBFileStoreLog setFileKey(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getFileName

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

getFileStore

@CheckReturnValue
 @Nullable
public DBFileStore getFileStore(java.lang.String... args)

findFileStore

@CheckReturnValue
 @Nonnull
public final DBFileStore findFileStore(java.lang.String... args)
                                                            throws NotFoundException

the code of the filestore the error occured against.

--> DBFileStore (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBFileStore

Throws:

NotFoundException - DBFileStore was not found

getFileStoreKey

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

setFileStoreKey

@Nonnull
public DBFileStoreLog setFileStoreKey(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getFileStoreName

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

getSource

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

setSource

@Nonnull
public DBFileStoreLog setSource(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

logError

public static void logError(java.lang.String msg,
                            java.lang.String store,
                            java.lang.String source,
                            java.lang.String file,
                            DataSource ds)

Logs an error against a file store, with DBFIELD_LEVEL set to ERROR

Parameters:

ds - the datasource

msg - the error message

store - the file store code

source - the source of the error, can be null

file - the file id, if there is one, can be null

extGetDerivedGlobalKey

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

Gets the global key for the given derived field

Overrides:

extGetDerivedGlobalKey in class DBLog

Parameters:

field - the field

params - the paramters for the field

Returns:

GlobalKey the global key for the field

Throws:

java.lang.Exception - a serious problem

makeSummary

@OverridingMethodsMustInvokeSuper
 @Nonnull
 @CheckReturnValue
protected HTMLPanel makeSummary()

Overrides:

makeSummary in class DBLog

extGetDerivedValue

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

Gets the value for a derived field

Overrides:

extGetDerivedValue in class DBLog

Parameters:

field - the field

params - the field parameters

Returns:

Object the derived value

Throws:

java.lang.Exception - a serious problem