com.aspc.file

Class DBFileRemote

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.file.DBFileTemplate

com.aspc.file.DBFileRemote

All Implemented Interfaces:

SecondaryCacheGroup

public class DBFileRemote
extends DBFileTemplate

A remotely stored file.

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

Since:

2 August 2013

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 A remotely stored file.
static java.lang.String	DBCLASS_NAME A remotely stored file.

Fields inherited from class com.aspc.file.DBFileTemplate

DBFILE_FMT_ORG, DBFILE_FMT_THUMB

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBFileRemote	create(MutableDataSource mds) Make a new instance of this class.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
static DBFileRemote	findKey(DataSource ds, int key) Find the target for this class by the primary key
protected java.lang.String	getCacheName(java.lang.String extension)
java.io.File	getRawFile() The raw standard file.
java.io.File	getRawFileWithExponentialRetry(int retryCount) Retries getRawFile() when remote server returns with an error response.
java.lang.String	getRemoteURL(java.lang.String... args)
long	lastModified()
DBNode[]	listNodes()
static DBQuery<DBFileRemote>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBFileRemote	setRemoteURL(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.file.DBFileTemplate

extGetDerivedValue, findFolderId, getCachePeriod, getFolderId, getFullTextSearchScore, getID, getMimeType, getName, getPath, getPrimaryType, getProperties, getRawFile, getReferencesUUID, getSequence, getTextContent, getThumbFile, getURL, getUUID, getWeakReferencesUUID, getWebSafePath, isAudio, isChildNode, isContains, isDescendantNode, isDirectory, isImage, isPublic, isReferenceable, isSameNode, isVersionable, setCachePeriod, setFolderId, setID, setMimeType, setName, setPrimaryType, setProperties, setReferenceable, setReferencesUUID, setSequence, setTextContent, setUUID, setVersionable, setWeakReferencesUUID, vDisplayName, vName

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, 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

A remotely stored file.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A remotely stored file.

Constructor Detail

DBFileRemote

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

Method Detail

getRemoteURL

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

setRemoteURL

@Nonnull
public DBFileRemote setRemoteURL(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBFileRemote create(@Nonnull
                                                              MutableDataSource mds)
                                                       throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBFileRemote> makeQuery(@Nonnull
                                                                          DataSource ds)
                                                                   throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBFileRemote findKey(@Nonnull
                                                               DataSource ds,
                                                               int key)
                                                        throws NotFoundException,
                                                               java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

lastModified

public long lastModified()

getRawFile

public java.io.File getRawFile()
                        throws java.lang.Exception

Description copied from class: DBFileTemplate

The raw standard file.

Specified by:

getRawFile in class DBFileTemplate

Returns:

The actual raw file

Throws:

java.lang.Exception - a serious error

getRawFileWithExponentialRetry

public java.io.File getRawFileWithExponentialRetry(int retryCount)
                                            throws java.lang.Exception

Retries getRawFile() when remote server returns with an error response.

Parameters:

retryCount - | default 5 | negative value ignored

Returns:

File

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

extPreSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

getCacheName

protected java.lang.String getCacheName(java.lang.String extension)

Specified by:

getCacheName in class DBFileTemplate

listNodes

public DBNode[] listNodes()
                   throws java.lang.Exception

Throws:

java.lang.Exception