com.aspc.file.remote_store

Class DBRemoteFileStoreVolume

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.file.remote_store.DBRemoteFileStoreVolume

All Implemented Interfaces:

SecondaryCacheGroup

public class DBRemoteFileStoreVolume
extends DBObject

A Volume within a Remote File Store.

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

Since:

24 Mar 2005

Author:

jj84001

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 Volume within a Remote File Store
static java.lang.String	DBCLASS_NAME A Volume within a Remote File Store

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBRemoteFileStoreVolume(DBClass dbClass, DataSource ds) Std.

Method Summary

Modifier and Type	Method and Description
static DBRemoteFileStoreVolume	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected ValidationError	extValidateField(DBField field, ValidationList list) Extended field level validation
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
static DBRemoteFileStoreVolume	findKey(DataSource ds, int key) Find the target for this class by the primary key
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)
int	getID(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getServerUrl(java.lang.String... args)
DBRemoteFileStore	getStore() Retrieves the file store the the associated volume is located on
DBSystemPropertyMatch	getSystemProperty(java.lang.String... args)
java.lang.String	getURL() get the URL
boolean	isActive(java.lang.String... args)
boolean	isDisabled(java.lang.String... args)
static DBQuery<DBRemoteFileStoreVolume>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBRemoteFileStoreVolume	setAdminLogin(java.lang.String value, java.lang.String... args)
DBRemoteFileStoreVolume	setAdminPassword(java.lang.String value, java.lang.String... args)
DBRemoteFileStoreVolume	setDisabled(boolean value, java.lang.String... args)
DBRemoteFileStoreVolume	setID(int value, java.lang.String... args)
DBRemoteFileStoreVolume	setName(java.lang.String value, java.lang.String... args)
DBRemoteFileStoreVolume	setServerUrl(java.lang.String value, java.lang.String... args)
DBRemoteFileStoreVolume	setStore(com.aspc.dal.file.remote_store.DBRemoteFileStore value, java.lang.String... args)
DBRemoteFileStoreVolume	setSystemProperty(com.aspc.dal.dbobj.misc.DBSystemPropertyMatch 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, 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, extPreSaveRecord, extPreValidate, 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

A Volume within a Remote File Store

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A Volume within a Remote File Store

Constructor Detail

DBRemoteFileStoreVolume

public DBRemoteFileStoreVolume(DBClass dbClass,
                               DataSource ds)
                        throws java.lang.Exception

Std. DBObject constructor

Parameters:

dbClass - The class of this object

ds - 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 DBRemoteFileStoreVolume 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 DBRemoteFileStoreVolume 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 DBRemoteFileStoreVolume setAdminPassword(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 DBRemoteFileStoreVolume setDisabled(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 DBRemoteFileStoreVolume setName(java.lang.String 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 DBRemoteFileStoreVolume setServerUrl(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

setStore

@Nonnull
public DBRemoteFileStoreVolume setStore(com.aspc.dal.file.remote_store.DBRemoteFileStore 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 DBRemoteFileStoreVolume setSystemProperty(com.aspc.dal.dbobj.misc.DBSystemPropertyMatch value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

create

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

getStore

public DBRemoteFileStore getStore()

Retrieves the file store the the associated volume is located on

Returns:

the associated DBFileStore

extGetDerivedValue

protected java.lang.Object extGetDerivedValue(DBField field,
                                              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

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

@OverridingMethodsMustInvokeSuper
 @CheckReturnValue
 @Nullable
protected ValidationError extValidateField(DBField field,
                                                                                                           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

getURL

public java.lang.String getURL()

get the URL

Returns:

the URL