com.aspc.file

Class DBFileStoreVolume

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.file.DBFileStoreVolume

All Implemented Interfaces:

SecondaryCacheGroup

public class DBFileStoreVolume
extends DBObject

Represents a storage volume for a file store.
The primary volume for a DBFileStore can be changed to indicate the device to store new documents.
Once stored on a volume the document will be associated to that file through the DBFileLocation object and will not be affected by changes to the primary volume for DBFileStore.

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

Since:

9 September 2005

Author:

Jason McGrath

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 Represents a storage volume for a file store.
static java.lang.String	DBCLASS_NAME Represents a storage volume for a file store.
static java.lang.String	LOCAL_DOC_PATH LOCAL doc store directory path
static java.lang.String	MASTER_DOC_URL the master doc URL
static java.lang.ThreadLocal<java.lang.Integer>	THREAD_DEFAULT_SORT_ORDER

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	checkDefaultFolders() Checks that the admin login and user login have the same default folder.
protected void	clearCache(GlobalKey key) change the clear cache of the URLs.
static DBFileStoreVolume	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) Additional business logic when a field is updated.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreValidate() Before validation of the record.
protected ValidationError	extValidateField(DBField field, ValidationList list) Extended field level validation
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
static DBFileStoreVolume	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBFileStore	findStore(java.lang.String... args) The FileStore that this volume is on.
DBSystemPropertyMatch	findSystemProperty(java.lang.String... args) To check if environment variable is set.
java.lang.String	getAdminLogin(java.lang.String... args)
java.lang.String	getAdminPassword(java.lang.String... args)
java.lang.String	getDetails(java.lang.String... args)
java.lang.String	getFolder(java.lang.String... args)
java.lang.String	getFullName(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getServerUrl(java.lang.String... args)
DBFileStore	getStore(java.lang.String... args)
DBSystemPropertyMatch	getSystemProperty(java.lang.String... args)
java.lang.String	getURI(boolean requireAdminURI) get the URL
java.lang.String	getURLs(boolean requireAdminURL, boolean haMode, int layerID)
java.lang.String	getUserLogin(java.lang.String... args)
java.lang.String	getUserPassword(java.lang.String... args)
boolean	isActive(java.lang.String... args)
boolean	isDisabled(java.lang.String... args)
boolean	isReadOnly(java.lang.String... args)
boolean	isSetUp() Checks that the volume is set up, will try to set it up if it isn't
static DBQuery<DBFileStoreVolume>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBFileStoreVolume	setAdminLogin(java.lang.String value, java.lang.String... args)
DBFileStoreVolume	setAdminPassword(java.lang.String value, java.lang.String... args)
DBFileStoreVolume	setDetails(java.lang.String value, java.lang.String... args)
DBFileStoreVolume	setDisabled(boolean value, java.lang.String... args)
DBFileStoreVolume	setFolder(java.lang.String value, java.lang.String... args)
DBFileStoreVolume	setID(int value, java.lang.String... args)
DBFileStoreVolume	setName(java.lang.String value, java.lang.String... args)
DBFileStoreVolume	setReadOnly(boolean value, java.lang.String... args)
DBFileStoreVolume	setServerUrl(java.lang.String value, java.lang.String... args)
DBFileStoreVolume	setSetUp(boolean value, java.lang.String... args)
void	setSortOrder(int order) Change the sort order of the URLs so that we can determine which URL will be used if there is a number of them.
DBFileStoreVolume	setStore(com.aspc.dal.file.DBFileStore value, java.lang.String... args)
DBFileStoreVolume	setSystemProperty(com.aspc.dal.dbobj.misc.DBSystemPropertyMatch value, java.lang.String... args)
DBFileStoreVolume	setUserLogin(java.lang.String value, java.lang.String... args)
DBFileStoreVolume	setUserPassword(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

Represents a storage volume for a file store.
The primary volume for a DBFileStore can be changed to indicate the device to store new documents.
Once stored on a volume the document will be associated to that file through the DBFileLocation object and will not be affected by changes to the primary volume for DBFileStore.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Represents a storage volume for a file store.
The primary volume for a DBFileStore can be changed to indicate the device to store new documents.
Once stored on a volume the document will be associated to that file through the DBFileLocation object and will not be affected by changes to the primary volume for DBFileStore.

THREAD_DEFAULT_SORT_ORDER

public static final java.lang.ThreadLocal<java.lang.Integer> THREAD_DEFAULT_SORT_ORDER

MASTER_DOC_URL

public static final java.lang.String MASTER_DOC_URL

the master doc URL

See Also:

Constant Field Values

LOCAL_DOC_PATH

public static final java.lang.String LOCAL_DOC_PATH

LOCAL doc store directory path

See Also:

Constant Field Values

Constructor Detail

DBFileStoreVolume

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

getID

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

setID

@Nonnull
public DBFileStoreVolume setID(int value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isActive

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

getAdminLogin

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

setAdminLogin

@Nonnull
public DBFileStoreVolume setAdminLogin(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getAdminPassword

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

setAdminPassword

@Nonnull
public DBFileStoreVolume setAdminPassword(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getDetails

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

setDetails

@Nonnull
public DBFileStoreVolume setDetails(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isDisabled

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

setDisabled

@Nonnull
public DBFileStoreVolume setDisabled(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getFolder

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

setFolder

@Nonnull
public DBFileStoreVolume setFolder(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getFullName

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

setSetUp

@Nonnull
public DBFileStoreVolume setSetUp(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public DBFileStoreVolume setName(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isReadOnly

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

setReadOnly

@Nonnull
public DBFileStoreVolume setReadOnly(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getServerUrl

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

setServerUrl

@Nonnull
public DBFileStoreVolume setServerUrl(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getStore

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

findStore

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

The FileStore that this volume is on.

--> DBFileStore (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBFileStore

Throws:

NotFoundException - DBFileStore was not found

setStore

@Nonnull
public DBFileStoreVolume setStore(com.aspc.dal.file.DBFileStore value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSystemProperty

@CheckReturnValue
 @Nullable
public DBSystemPropertyMatch getSystemProperty(java.lang.String... args)

findSystemProperty

@CheckReturnValue
 @Nonnull
public final DBSystemPropertyMatch findSystemProperty(java.lang.String... args)
                                                                           throws NotFoundException

To check if environment variable is set.

--> DBSystemPropertyMatch (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBSystemPropertyMatch

Throws:

NotFoundException - DBSystemPropertyMatch was not found

setSystemProperty

@Nonnull
public DBFileStoreVolume setSystemProperty(com.aspc.dal.dbobj.misc.DBSystemPropertyMatch value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getUserLogin

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

setUserLogin

@Nonnull
public DBFileStoreVolume setUserLogin(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getUserPassword

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

setUserPassword

@Nonnull
public DBFileStoreVolume setUserPassword(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

create

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

setSortOrder

public void setSortOrder(int order)

Change the sort order of the URLs so that we can determine which URL will be used if there is a number of them.

Parameters:

order - The new order to use.

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

Additional business logic when a field is updated.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - A serious problem

See Also:

DBObject.eventFieldUpdated( DBField, Object, GlobalKey, FldParams)

clearCache

@OverridingMethodsMustInvokeSuper
protected void clearCache(@Nullable
                                                            GlobalKey key)

change the clear cache of the URLs.

Overrides:

clearCache in class DBObject

Parameters:

key - The global key of this record.

getURLs

@CheckReturnValue
 @Nonnull
public java.lang.String getURLs(boolean requireAdminURL,
                                                            boolean haMode,
                                                            int layerID)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

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 DBObject

Parameters:

params - The parameters for this field eg. language= or default=

field - The field to get

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

extPreValidate

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

Before validation of the record.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - pre validation failure

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

extValidateField

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

Extended field level validation

Overrides:

extValidateField in class DBObject

Parameters:

field - the field to validate

list - the list of validation errors

Returns:

ValidationError not null if field failed validation

Throws:

java.lang.Exception - a serious problem

isSetUp

@CheckReturnValue
public boolean isSetUp()
                                  throws java.lang.Exception

Checks that the volume is set up, will try to set it up if it isn't

Returns:

boolean true if the volume is known to be setup

Throws:

java.lang.Exception - if the urls cannot be found for the volume

getURI

@CheckReturnValue
 @Nonnull
public java.lang.String getURI(boolean requireAdminURI)

get the URL

Parameters:

requireAdminURI - The admin URL is required

Returns:

the URL

checkDefaultFolders

@CheckReturnValue
public boolean checkDefaultFolders()
                                              throws java.lang.Exception

Checks that the admin login and user login have the same default folder. This is done by uploading a temp file with the user login and then downloading it with the admin login.

Returns:

boolean true if the logins have the same default folder

Throws:

java.lang.Exception - a serious problem