DBFile (stSoftware API)

java.lang.Object
- com.aspc.DBObj.DBObject
- - com.aspc.file.DBFileTemplate
  - - com.aspc.file.DBFile

All Implemented Interfaces:

DBLogicalLockCanReleasePlugin, SecondaryCacheGroup

Direct Known Subclasses:

ArtworkFile, SmegDBFile
```
public class DBFile
extends DBFileTemplate
implements DBLogicalLockCanReleasePlugin
```
Allows a standard file to be saved within the database system. All details about the document is stored in the database as a normal record and the actual raw file is stored in a file storage area outside the document root. This is normally done via FTP to a primary server and local cache is kept. Each time a file is uploaded the version number is incremented so file caching both on the application servers and the client side is easy.

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

Since:

3 January 2001, 09:13

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` Allows a standard file to be saved within the database system.
`static java.lang.String`	`DBCLASS_NAME` Allows a standard file to be saved within the database system.
`static java.lang.String`	`DBFILE_FMT_ENCRYPTED` encrypted format
`static java.lang.String`	`DBFILE_FMT_GZIP` GZIP format
`static java.lang.String`	`DBFILE_MAGIC_NUMBER_CREATE` to create a magicNumber
`static java.lang.String`	`DBFILE_MAGIC_NUMBER_PARAM_MODE` mode parameter of magicNumber
`static java.lang.String`	`DBFILE_PARAM_CALL_COUNT` call_count parameter of magicNumber
`static java.lang.String`	`FEATURE_SSL` string to verify if SSL has been enabled
`static java.lang.String`	`REQUIRE_FORMAT` We require a format
`static java.lang.String`	`REQUIRE_LAYER` We require the layer
`static java.lang.String`	`REQUIRE_VERSION` We require the version
`static java.lang.String`	`TEMP_FILE_PREFIX` The prefix for all files uploaded.

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

DBFile(DBClass def, DataSource dataSource)
Std.

Constructors
Constructor and Description
`DBFile(DBClass def, DataSource dataSource)` Std.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`checkCanReleaseLogicalLock(DBLogicalLock lock, Login login, boolean defaultCanRelease)` Determines if the current user has the rights to release the lock
`static DBFile`	`create(MutableDataSource mds)` Make a new instance of this class.
`java.lang.String`	`displayName()` The display name for this object.
`boolean`	`displaysInBrowser()` does this type of file normal display within the browser's window.
`protected void`	`extCopy(DBObject target)` Additional functionality when an object is copied
`protected void`	`extFixUp()` The extended fix up routine for known problems.
`protected java.lang.Object`	`extGetDerivedValue(DBField field, FldParams params)` Calculate the derived value for this field.
`protected java.lang.Object`	`extGetValue(DBField field, FldParams params)` This method will masks the default value returned to the user.
`protected void`	`extPostDeleteRecord(long transNr)` clear the import files.
`protected void`	`extPostSaveRecord(long transNr)` clear the import files.
`protected void`	`extPreValidate()` Update the in-memory universe BEFORE validating
`protected void`	`extSetValue(DBField field, java.lang.Object orgValue, FldParams params)` We prevent some values from being set by a user.
`protected void`	`extValidateDelete(ValidationList list)` Extend this method to add validation to a record then deleted.
`protected ValidationError`	`extValidateField(DBField field, ValidationList list)` Additional validation for a particular field.
`protected void`	`extValidateRecord(ValidationList list)` Performs additional validations on this record.
`DBFile`	`findAssociatedFile(java.lang.String... args)` File that this file is associated with.
`Person`	`findCreatedBy(java.lang.String... args)` Person who last created the file.
`DBLogicalLock`	`findCurrentLock(java.lang.String... args)` Is the current file in logical lock.
`static DBFile`	`findKey(DataSource ds, int key)` Find the target for this class by the primary key
`DBLanguage`	`findLanguage(java.lang.String... args)` The language of this file ( if known).
`Person`	`findLockedBy(java.lang.String... args)` Deprecated.
`Person`	`findModifiedBy(java.lang.String... args)` Person who last modified the file.
`DBFile`	`getAssociatedFile(java.lang.String... args)`
`int`	`getAssociatedVersion(java.lang.String... args)`
`java.io.File`	`getCacheFile()` The cache raw file.
`long`	`getCacheFileSize()` The cache file size.
`protected java.lang.String`	`getCacheName(java.lang.String extension)`
`java.lang.String`	`getCachePath(boolean fullPath)` Retrieves the path used to cache files for this application server
`java.lang.String`	`getCdnURL(java.lang.String... args)`
`java.lang.String`	`getCheckSum(java.lang.String... args)`
`java.lang.String`	`getCipher(java.lang.String... args)`
`java.lang.String`	`getCipherInitVector(java.lang.String... args)`
`java.util.Date`	`getCreated(java.lang.String... args)`
`Person`	`getCreatedBy(java.lang.String... args)`
`DBLogicalLock`	`getCurrentLock(java.lang.String... args)`
`java.lang.String`	`getDescription(java.lang.String... args)`
`java.lang.String`	`getDisplayName(java.lang.String... args)`
`java.lang.String`	`getDisplayShortDesc(java.lang.String... args)`
`java.io.File`	`getImportFile()` The raw file that will be imported.
`java.lang.String`	`getImportTmpName(java.lang.String... args)`
`java.lang.String`	`getInternalDir()` Generates the physical path of this file based on the modular of its id
`java.lang.String`	`getInternalName()` Generates the physical name of the file
`java.lang.String`	`getInternalRawName()` Generates the physical name of the raw file
`DBLanguage`	`getLanguage(java.lang.String... args)`
`DBFileLocation[]`	`getLocations(DBFileStore baseStore)` Returns the locations of current version of the file
`DBFileLocation[]`	`getLocations(DBFileStore baseStore, int version)` Returns the locations of this file for a specified version We use the VirtualDB to retrieve the locations as we do not want to return any location objects that are new as these may not have had the file placed there yet
`Person`	`getLockedBy(java.lang.String... args)` Deprecated.
`java.lang.String`	`getMagicNumber(java.lang.String... args)`
`java.lang.String`	`getMimeType(java.lang.String format)` The MIME type for this file.
`java.util.Date`	`getModified(java.lang.String... args)`
`Person`	`getModifiedBy(java.lang.String... args)`
`int`	`getOne(java.lang.String... args)`
`int`	`getOverlayId(java.lang.String... args)`
`java.lang.String`	`getRawCheckSum(java.lang.String... args)`
`java.util.Date`	`getRawCreatedDate(java.lang.String... args)`
`java.io.File`	`getRawFile()` Get the raw (real) file.
`java.util.Date`	`getRawModifiedDate(java.lang.String... args)`
`java.lang.String`	`getRawProperties(java.lang.String... args)`
`java.lang.String`	`getRawURL(java.lang.String... args)`
`java.lang.String`	`getSha512base64(java.lang.String... args)`
`int`	`getShallowCopyID(java.lang.String... args)`
`long`	`getSize(java.lang.String... args)`
`java.lang.String`	`getSummary(java.lang.String... args)`
`int`	`getVersion(java.lang.String... args)`
`protected java.lang.String`	`getVersionNotLockedMsgID()` Gets the message id for extvalidatefield dbfield_version.
`boolean`	`hasCreateAccess(java.lang.String... args)`
`boolean`	`hasDeleteAccess(java.lang.String... args)`
`boolean`	`hasFullAccess(java.lang.String... args)`
`boolean`	`hasModifyAccess(java.lang.String... args)`
`boolean`	`hasReadAccess(java.lang.String... args)`
`boolean`	`isFinalFg(java.lang.String... args)`
`boolean`	`isGZIP(java.lang.String... args)`
`boolean`	`isIsVersionControlled(java.lang.String... args)`
`boolean`	`isLocked(java.lang.String... args)`
`boolean`	`isVersionControlled(java.lang.String... args)`
`long`	`lastModified()`
`DBNode[]`	`listNodes()`
`void`	`lock(boolean autoCommit)` Take a lock on this file
`static DBQuery<DBFile>`	`makeQuery(DataSource ds)` Make a new QUERY for this class.
`static SearchPlan`	`makeSearchPlan(DBQuery<DBObject> query)` Allows for specific attributes to be set for the queries
`void`	`releaseLock(boolean autoCommit)` Release a lock on this file
`DBFile`	`setAssociatedFile(com.aspc.dal.file.DBFile value, java.lang.String... args)`
`DBFile`	`setAssociatedVersion(int value, java.lang.String... args)`
`DBFile`	`setCdnURL(java.lang.String value, java.lang.String... args)`
`DBFile`	`setCheckSum(java.lang.String value, java.lang.String... args)`
`DBFile`	`setCipher(java.lang.String value, java.lang.String... args)`
`DBFile`	`setCipherInitVector(java.lang.String value, java.lang.String... args)`
`DBFile`	`setCreated(java.util.Date value, java.lang.String... args)`
`DBFile`	`setCreatedBy(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)`
`DBFile`	`setCurrentLock(com.aspc.dal.locks.DBLogicalLock value, java.lang.String... args)`
`DBFile`	`setDescription(java.lang.String value, java.lang.String... args)`
`DBFile`	`setFinalFg(boolean value, java.lang.String... args)`
`DBFile`	`setGZIP(boolean value, java.lang.String... args)`
`DBFileLocation`	`setImportFile(java.io.File file, boolean autoDelete)` set the raw file to be imported.
`DBFileLocation`	`setImportFile(java.lang.String fileName, boolean autoDelete)` set the raw file to be imported.
`DBFile`	`setImportTmpName(java.lang.String value, java.lang.String... args)`
`DBFile`	`setLanguage(com.aspc.dal.dbobj.language.DBLanguage value, java.lang.String... args)`
`DBFile`	`setModified(java.util.Date value, java.lang.String... args)`
`DBFile`	`setModifiedBy(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)`
`DBFile`	`setOverlayId(int value, java.lang.String... args)`
`DBFile`	`setRawCheckSum(java.lang.String value, java.lang.String... args)`
`DBFile`	`setRawCreatedDate(java.util.Date value, java.lang.String... args)`
`DBFile`	`setRawModifiedDate(java.util.Date value, java.lang.String... args)`
`DBFile`	`setRawProperties(java.lang.String value, java.lang.String... args)`
`DBFile`	`setSha512base64(java.lang.String value, java.lang.String... args)`
`DBFile`	`setShallowCopyID(int value, java.lang.String... args)`
`DBFile`	`setSize(long value, java.lang.String... args)`
`DBFile`	`setSummary(java.lang.String value, java.lang.String... args)`
`DBFile`	`setVersion(int value, java.lang.String... args)`
`DBFile`	`setVersionControlled(boolean value, java.lang.String... args)`
`DBFileLocation`	`submitNewVersion(java.lang.String srcURL, java.lang.String srcPath, DBFileStore destStore, java.lang.String mimetype, java.lang.Long size, boolean isGZIP, java.lang.String cipher, java.lang.String cipherInitVector, java.lang.String checkSum, java.lang.String rawCheckSum, java.lang.String rawCreateDate, java.lang.String rawModifyDate, java.lang.String base64RawSHA512)` Adds a new version of the file to the DBFile with the associated details
`boolean`	`usedCacheFile()` was the cache file used.
`java.lang.String`	`vDisplayName()`
`java.lang.String`	`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, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extIsMandatory, extIsOnChange, extMarkSavePoint, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, 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, 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
```
  Allows a standard file to be saved within the database system. All details about the document is stored in the database as a normal record and the actual raw file is stored in a file storage area outside the document root. This is normally done via FTP to a primary server and local cache is kept. Each time a file is uploaded the version number is incremented so file caching both on the application servers and the client side is easy.
  
  See Also:
  
  Constant Field Values
- DBCLASS_GID
```
public static final GlobalId DBCLASS_GID
```
  Allows a standard file to be saved within the database system. All details about the document is stored in the database as a normal record and the actual raw file is stored in a file storage area outside the document root. This is normally done via FTP to a primary server and local cache is kept. Each time a file is uploaded the version number is incremented so file caching both on the application servers and the client side is easy.
- TEMP_FILE_PREFIX
```
public static final java.lang.String TEMP_FILE_PREFIX
```
  The prefix for all files uploaded.
  
  See Also:
  
  Constant Field Values
- DBFILE_FMT_GZIP
```
public static final java.lang.String DBFILE_FMT_GZIP
```
  GZIP format
  
  See Also:
  
  Constant Field Values
- DBFILE_FMT_ENCRYPTED
```
public static final java.lang.String DBFILE_FMT_ENCRYPTED
```
  encrypted format
  
  See Also:
  
  Constant Field Values
- REQUIRE_LAYER
```
public static final java.lang.String REQUIRE_LAYER
```
  We require the layer
  
  See Also:
  
  Constant Field Values
- REQUIRE_FORMAT
```
public static final java.lang.String REQUIRE_FORMAT
```
  We require a format
  
  See Also:
  
  Constant Field Values
- REQUIRE_VERSION
```
public static final java.lang.String REQUIRE_VERSION
```
  We require the version
  
  See Also:
  
  Constant Field Values
- DBFILE_MAGIC_NUMBER_PARAM_MODE
```
public static final java.lang.String DBFILE_MAGIC_NUMBER_PARAM_MODE
```
  mode parameter of magicNumber
  
  See Also:
  
  Constant Field Values
- DBFILE_MAGIC_NUMBER_CREATE
```
public static final java.lang.String DBFILE_MAGIC_NUMBER_CREATE
```
  to create a magicNumber
  
  See Also:
  
  Constant Field Values
- DBFILE_PARAM_CALL_COUNT
```
public static final java.lang.String DBFILE_PARAM_CALL_COUNT
```
  call_count parameter of magicNumber
  
  See Also:
  
  Constant Field Values
- FEATURE_SSL
```
public static final java.lang.String FEATURE_SSL
```
  string to verify if SSL has been enabled
  
  See Also:
  
  Constant Field Values

Constructor Detail
- DBFile
```
public DBFile(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

getAssociatedFile

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

findAssociatedFile
```
@CheckReturnValue
 @Nonnull
public final DBFile findAssociatedFile(java.lang.String... args)
                                                            throws NotFoundException
```
File that this file is associated with. The association is defined to allow storage of different formats of the original file.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setAssociatedFile

@Nonnull
public DBFile setAssociatedFile(com.aspc.dal.file.DBFile value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getAssociatedVersion

@CheckReturnValue
public int getAssociatedVersion(java.lang.String... args)

setAssociatedVersion

@Nonnull
public DBFile setAssociatedVersion(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getCdnURL

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

setCdnURL

@Nonnull
public DBFile setCdnURL(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

getCheckSum

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

setCheckSum

@Nonnull
public DBFile setCheckSum(@MatchesPattern(value="^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$")
                                   java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

getCipher

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

setCipher

@Nonnull
public DBFile setCipher(@MatchesPattern(value="^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$")
                                 java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

getCipherInitVector

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

setCipherInitVector

@Nonnull
public DBFile setCipherInitVector(@MatchesPattern(value="^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$")
                                           java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

getCreated

@CheckReturnValue
 @Nullable
public java.util.Date getCreated(java.lang.String... args)

setCreated

@Nonnull
public DBFile setCreated(java.util.Date value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

getCreatedBy

@CheckReturnValue
 @Nullable
public Person getCreatedBy(java.lang.String... args)

findCreatedBy
```
@CheckReturnValue
 @Nonnull
public final Person findCreatedBy(java.lang.String... args)
                                                       throws NotFoundException
```
Person who last created the file.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setCreatedBy

@Nonnull
public DBFile setCreatedBy(com.aspc.dal.dbobj.contact.Person value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getCurrentLock

@CheckReturnValue
 @Nullable
public DBLogicalLock getCurrentLock(java.lang.String... args)

findCurrentLock
```
@CheckReturnValue
 @Nonnull
public final DBLogicalLock findCurrentLock(java.lang.String... args)
                                                                throws NotFoundException
```
Is the current file in logical lock.

--> DBLogicalLock (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBLogicalLock

Throws:

NotFoundException - DBLogicalLock was not found

setCurrentLock

@Nonnull
public DBFile setCurrentLock(com.aspc.dal.locks.DBLogicalLock value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getDescription

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

setDescription

@Nonnull
public DBFile setDescription(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getDisplayName

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

getDisplayShortDesc

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

isFinalFg

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

setFinalFg

@Nonnull
public DBFile setFinalFg(boolean value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

hasCreateAccess

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

hasDeleteAccess

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

hasFullAccess

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

hasModifyAccess

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

hasReadAccess

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

getImportTmpName

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

setImportTmpName

@Nonnull
public DBFile setImportTmpName(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

isGZIP

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

setGZIP

@Nonnull
public DBFile setGZIP(boolean value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:: java.lang.Exception

isLocked

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

isIsVersionControlled

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

getLanguage

@CheckReturnValue
 @Nullable
public DBLanguage getLanguage(java.lang.String... args)

findLanguage
```
@CheckReturnValue
 @Nonnull
public final DBLanguage findLanguage(java.lang.String... args)
                                                          throws NotFoundException
```
The language of this file ( if known).

--> DBLanguage (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Language

Throws:

NotFoundException - DBLanguage was not found

setLanguage

@Nonnull
public DBFile setLanguage(com.aspc.dal.dbobj.language.DBLanguage value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

getLockedBy

@Deprecated
 @CheckReturnValue
 @Nullable
public Person getLockedBy(java.lang.String... args)

Deprecated.

findLockedBy

@CheckReturnValue
 @Deprecated
 @Nonnull
public final Person findLockedBy(java.lang.String... args)
                                                                   throws NotFoundException

Deprecated.

The file is locked by.

--> Person (Integer, Derived, Searchable)

Parameters:: args - the optional arguments
Returns:: locked file
Throws:: NotFoundException - Person was not found

getMagicNumber

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

getModified

@CheckReturnValue
 @Nullable
public java.util.Date getModified(java.lang.String... args)

setModified

@Nonnull
public DBFile setModified(java.util.Date value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

getModifiedBy

@CheckReturnValue
 @Nullable
public Person getModifiedBy(java.lang.String... args)

findModifiedBy
```
@CheckReturnValue
 @Nonnull
public final Person findModifiedBy(java.lang.String... args)
                                                        throws NotFoundException
```
Person who last modified the file.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setModifiedBy

@Nonnull
public DBFile setModifiedBy(com.aspc.dal.dbobj.contact.Person value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

getOne

@CheckReturnValue
public int getOne(java.lang.String... args)

getOverlayId

@CheckReturnValue
public int getOverlayId(java.lang.String... args)

setOverlayId

@Nonnull
public DBFile setOverlayId(int value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getRawCheckSum

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

setRawCheckSum

@Nonnull
public DBFile setRawCheckSum(@MatchesPattern(value="^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$")
                                      java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getRawCreatedDate

@CheckReturnValue
 @Nullable
public java.util.Date getRawCreatedDate(java.lang.String... args)

setRawCreatedDate

@Nonnull
public DBFile setRawCreatedDate(java.util.Date value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getRawModifiedDate

@CheckReturnValue
 @Nullable
public java.util.Date getRawModifiedDate(java.lang.String... args)

setRawModifiedDate

@Nonnull
public DBFile setRawModifiedDate(java.util.Date value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:: java.lang.Exception

getRawProperties

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

setRawProperties

@Nonnull
public DBFile setRawProperties(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getRawURL

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

getSha512base64

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

setSha512base64

@Nonnull
public DBFile setSha512base64(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

getShallowCopyID

@CheckReturnValue
public int getShallowCopyID(java.lang.String... args)

setShallowCopyID

@Nonnull
public DBFile setShallowCopyID(int value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getSize

@CheckReturnValue
public long getSize(java.lang.String... args)

setSize

@Nonnull
public DBFile setSize(long value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:: java.lang.Exception

getSummary

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

setSummary

@Nonnull
public DBFile setSummary(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

getVersion

@CheckReturnValue
 @Nonnegative
public int getVersion(java.lang.String... args)

setVersion

@Nonnull
public DBFile setVersion(int value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

isVersionControlled

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

setVersionControlled

@Nonnull
public DBFile setVersionControlled(boolean value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBFile 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<DBFile> 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 DBFile 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

makeSearchPlan

@CheckReturnValue
 @Nonnull
public static SearchPlan makeSearchPlan(@Nonnull
                                                                    DBQuery<DBObject> query)

Allows for specific attributes to be set for the queries

Parameters:: query - The calling query
Returns:: The search plan

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Additional functionality when an object is copied

Overrides:: extCopy in class DBObject
Parameters:: target - The target object
Throws:: java.lang.Exception - A serious problem

usedCacheFile
```
@CheckReturnValue
public boolean usedCacheFile()
```
was the cache file used.

Returns:

true if the cache file was used.

getRawFile
```
@CheckReturnValue
 @Nonnull
public java.io.File getRawFile()
                                                    throws java.lang.Exception
```
Get the raw (real) file.

Specified by:

getRawFile in class DBFileTemplate

Returns:

The raw file.

Throws:

java.lang.Exception - A serious error.

displayName
```
@Nonnull
 @CheckReturnValue
public java.lang.String displayName()
```
The display name for this object.

Overrides:

displayName in class DBObject

Returns:

The name

getImportFile
```
@CheckReturnValue
 @Nullable
public java.io.File getImportFile()
```
The raw file that will be imported.

Returns:

the actual file that will be loaded.

setImportFile

@Nullable
public DBFileLocation setImportFile(@Nonnull
                                              java.lang.String fileName,
                                              boolean autoDelete)
                                       throws java.lang.Exception

set the raw file to be imported.

Parameters:: fileName - The raw file name to be imported; autoDelete -
Returns:: the import file
Throws:: java.lang.Exception - a serious error.

setImportFile

@Nullable
public DBFileLocation setImportFile(@Nonnull
                                              java.io.File file,
                                              boolean autoDelete)
                                       throws java.lang.Exception

set the raw file to be imported.

Parameters:: file - the raw file to be imported; autoDelete - auto delete the file on save.
Returns:: the import file
Throws:: java.lang.Exception - a serious error.

submitNewVersion

@Nullable
public DBFileLocation submitNewVersion(java.lang.String srcURL,
                                                 java.lang.String srcPath,
                                                 @Nonnull
                                                 DBFileStore destStore,
                                                 java.lang.String mimetype,
                                                 java.lang.Long size,
                                                 boolean isGZIP,
                                                 java.lang.String cipher,
                                                 java.lang.String cipherInitVector,
                                                 java.lang.String checkSum,
                                                 java.lang.String rawCheckSum,
                                                 java.lang.String rawCreateDate,
                                                 java.lang.String rawModifyDate,
                                                 java.lang.String base64RawSHA512)
                                          throws java.lang.Exception

Adds a new version of the file to the DBFile with the associated details

Parameters:: srcURL - the source; mimetype - the mime type; isGZIP - is currently GZIPed; cipher - the cipher; cipherInitVector - the vector; checkSum - the check sum; rawCheckSum - the raw check sum; srcPath - - the path and filename of the file to be imported; destStore - - the destination volume for the new version; size - - the size in bytes of the file; rawCreateDate -; rawModifyDate -; base64RawSHA512 - SHA512 base64 of the original file.
Returns:: the file
Throws:: java.lang.Exception - a serious error.

getMimeType

@CheckReturnValue
 @Nonnull
public java.lang.String getMimeType(@Nullable
                                                                java.lang.String format)

The MIME type for this file.

Parameters:: format - the format to convert the file to.
Returns:: The MIME type.

extPostDeleteRecord

@OverridingMethodsMustInvokeSuper
protected void extPostDeleteRecord(@Nonnegative
                                                                     long transNr)

clear the import files.

Overrides:: extPostDeleteRecord in class DBObject
Parameters:: transNr - This transaction number that was just saved.

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)

clear the import files.

Overrides:: extPostSaveRecord in class DBObject
Parameters:: transNr - This transaction number that was just saved.

extPreValidate

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

Update the in-memory universe BEFORE validating

Overrides:: extPreValidate in class DBObject
Throws:: java.lang.Exception - A serious problem

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:: extValidateField in class DBObject
Parameters:: list - The validation list; field - The field to be validated
Returns:: The validation error
Throws:: java.lang.Exception - A serious problem

getVersionNotLockedMsgID
```
@CheckReturnValue
 @Nonnull
protected java.lang.String getVersionNotLockedMsgID()
```
Gets the message id for extvalidatefield dbfield_version. overridden in WFSubmissionFile

Returns:

String the message id

lock
```
public void lock(boolean autoCommit)
          throws java.lang.Exception
```
Take a lock on this file

Parameters:

autoCommit - should automatically save ( in a different datasource)

Throws:

java.lang.Exception - locked by another user.

releaseLock
```
public void releaseLock(boolean autoCommit)
                 throws java.lang.Exception
```
Release a lock on this file

Parameters:

autoCommit - should automatically save ( in a different datasource)

Throws:

java.lang.Exception - could not release lock.

checkCanReleaseLogicalLock
```
@CheckReturnValue
public boolean checkCanReleaseLogicalLock(DBLogicalLock lock,
                                                            Login login,
                                                            boolean defaultCanRelease)
```
Determines if the current user has the rights to release the lock

Specified by:

checkCanReleaseLogicalLock in interface DBLogicalLockCanReleasePlugin

Parameters:

lock - Current lock

login - Login of person trying to release lock

defaultCanRelease - Value determined be default system handling

Returns:

true if user can release this lock

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:: extValidateRecord in class DBObject
Parameters:: list - The validation list.
Throws:: java.lang.Exception - A serious problem

extValidateDelete
```
protected void extValidateDelete(@Nonnull
                                 ValidationList list)
                          throws java.lang.Exception
```
Extend this method to add validation to a record then deleted.

Overrides:

extValidateDelete in class DBObject

Parameters:

list - The validation list

Throws:

java.lang.Exception - A serious problem

getCacheFileSize

@CheckReturnValue
 @Nonnegative
public long getCacheFileSize()
                                                      throws java.lang.Exception

The cache file size.

Returns:: The file size
Throws:: java.lang.Exception - A serious problem

getCacheFile

@CheckReturnValue
 @Nonnull
public java.io.File getCacheFile()
                                                      throws java.lang.Exception

The cache raw file.

Returns:: The file
Throws:: java.lang.Exception - A serious problem

getLocations

@CheckReturnValue
 @Nonnull
public final DBFileLocation[] getLocations(@Nullable
                                                                       DBFileStore baseStore)
                                                                throws java.lang.Exception

Returns the locations of current version of the file

Parameters:: baseStore - - the file store that the locations should be ordered by
Returns:: array of DBFileLocations objects
Throws:: java.lang.Exception - Serious error

getLocations

@CheckReturnValue
 @Nonnull
public final DBFileLocation[] getLocations(@Nullable
                                                                       DBFileStore baseStore,
                                                                       @Nonnegative
                                                                       int version)
                                                                throws java.lang.Exception

Returns the locations of this file for a specified version We use the VirtualDB to retrieve the locations as we do not want to return any location objects that are new as these may not have had the file placed there yet

Parameters:: baseStore - - the file store that the locations should be ordered by; version - - the version of the file to retrieve the locations for
Returns:: array of DBFileLocations objects
Throws:: java.lang.Exception - Serious error

extGetDerivedValue

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

Calculate the derived value for this field.

Overrides:: extGetDerivedValue in class DBFileTemplate
Parameters:: field - The field to get; params - The parameters for this field eg. language= or default=
Returns:: The calculated value
Throws:: java.lang.Exception - A serious problem

extFixUp
```
@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception
```
The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

displaysInBrowser
```
@CheckReturnValue
public boolean displaysInBrowser()
```
does this type of file normal display within the browser's window. Should we target another window ?

Returns:

true if the file will display in the browser

getInternalDir
```
@CheckReturnValue
 @Nonnull
public java.lang.String getInternalDir()
```
Generates the physical path of this file based on the modular of its id

Returns:

The path of the file

getInternalRawName
```
@CheckReturnValue
 @Nonnull
public java.lang.String getInternalRawName()
```
Generates the physical name of the raw file

Returns:

The name of the file

getInternalName
```
@CheckReturnValue
 @Nonnull
public java.lang.String getInternalName()
```
Generates the physical name of the file

Returns:

The name of the file

getCachePath
```
@CheckReturnValue
 @Nonnull
public java.lang.String getCachePath(boolean fullPath)
```
Retrieves the path used to cache files for this application server

Parameters:

fullPath - require the full path

Returns:

The path

extGetValue

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

This method will masks the default value returned to the user. The "real" value will still be used in searches etc

Overrides:: extGetValue 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.

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object orgValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

We prevent some values from being set by a user.

Overrides:: extSetValue in class DBObject
Parameters:: orgValue - The value being set; field - The field that is being changed; params - The extra parameters
Throws:: java.lang.Exception - A serious problem

lastModified

@CheckReturnValue
public long lastModified()

getCacheName

@CheckReturnValue
 @Nonnull
protected java.lang.String getCacheName(@Nonnull
                                                                    java.lang.String extension)

Specified by:: getCacheName in class DBFileTemplate

vName

@CheckReturnValue
 @Nonnull
public java.lang.String vName()

Overrides:: vName in class DBFileTemplate

vDisplayName

@CheckReturnValue
 @Nonnull
public java.lang.String vDisplayName()

Overrides:: vDisplayName in class DBFileTemplate

listNodes

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

Throws:: java.lang.Exception

Class DBFile

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

Field Summary

Fields inherited from class com.aspc.file.DBFileTemplate

Fields inherited from class com.aspc.DBObj.DBObject

Constructor Summary

Method Summary

Methods inherited from class com.aspc.file.DBFileTemplate

Methods inherited from class com.aspc.DBObj.DBObject

Methods inherited from class java.lang.Object

Field Detail

DBCLASS_NAME

DBCLASS_GID

TEMP_FILE_PREFIX

DBFILE_FMT_GZIP

DBFILE_FMT_ENCRYPTED

REQUIRE_LAYER

REQUIRE_FORMAT

REQUIRE_VERSION

DBFILE_MAGIC_NUMBER_PARAM_MODE

DBFILE_MAGIC_NUMBER_CREATE

DBFILE_PARAM_CALL_COUNT

FEATURE_SSL

Constructor Detail

DBFile