com.aspc.file

Class DBFileStore

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.file.DBFileStore

All Implemented Interfaces:

SecondaryCacheGroup

public class DBFileStore
extends DBObject

A location in which internal documents can be stored.

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

Since:

24 Mar 2005

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 location in which internal documents can be stored.
static java.lang.String	DBCLASS_NAME A location in which internal documents can be stored.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBFileStore	create(MutableDataSource mds) Make a new instance of this class.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Gets the value for the given field, using the given params, if any.
static DBFileStore	find(DataSource ds) Find the default file store for this layer.
DBFileStoreVolume	findCurrentVolume(java.lang.String... args) The current volume where files are to be stored.
static DBFileStore	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
DBLocation	findLocation(java.lang.String... args) The location of the DBFileStore.
static DBFileStore[]	findPreferred(DataSource ds) Finds the list of preferred file stores for the login associated with the given datasource, sorted by sequence.
static DBFileStore[]	findPreferred(VirtualDB layer, Login login, DBTimeZone tz) Finds the list of preferred file stores for the login passed .
static DBFileStore[]	getActiveFileStoreAndItsAlternate(DBFileStore[] fs) This function will check and populate the primary file store and its alternate into the lst object.
DBObject[]	getAlternateStores() get alternative store
java.lang.String	getCode(java.lang.String... args)
DBFileStoreVolume	getCurrentVolume(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
DBLocation	getLocation(java.lang.String... args)
java.lang.String	getURLs(boolean requireAdminURL, boolean haMode, int layerID) Returns the connection URL to the current storage location.
DBObject[]	getVolumes() get the volumes
boolean	isActive(java.lang.String... args)
static DBQuery<DBFileStore>	makeQuery(DataSource ds) Make a new QUERY for this class.
static void	populateActiveFileStoreAndItsAlternate(java.util.Set lst, DBFileStore fs) This function will check and populate the primary file sotre and its alternate into the lst object.
DBFileStore	setCode(java.lang.String value, java.lang.String... args)
DBFileStore	setLabel(java.lang.String value, java.lang.String... args)
DBFileStore	setLocation(com.aspc.dal.dbobj.misc.DBLocation 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, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

A location in which internal documents can be stored.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A location in which internal documents can be stored.

Constructor Detail

DBFileStore

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

getCode

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

setCode

@Nonnull
public DBFileStore setCode(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

isActive

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

getCurrentVolume

@CheckReturnValue
 @Nullable
public DBFileStoreVolume getCurrentVolume(java.lang.String... args)

findCurrentVolume

@CheckReturnValue
 @Nonnull
public final DBFileStoreVolume findCurrentVolume(java.lang.String... args)
                                                                      throws NotFoundException

The current volume where files are to be stored.

--> DBFileStoreVolume (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBFileStoreVolume

Throws:

NotFoundException - DBFileStoreVolume was not found

getLabel

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

setLabel

@Nonnull
public DBFileStore setLabel(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getLocation

@CheckReturnValue
 @Nullable
public DBLocation getLocation(java.lang.String... args)

findLocation

@CheckReturnValue
 @Nonnull
public final DBLocation findLocation(java.lang.String... args)
                                                          throws NotFoundException

The location of the DBFileStore.

--> DBLocation (String, Unique, Searchable)

Parameters:

args - the optional arguments

Returns:

DBLocation

Throws:

NotFoundException - DBLocation was not found

setLocation

@Nonnull
public DBFileStore setLocation(com.aspc.dal.dbobj.misc.DBLocation value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBFileStore 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<DBFileStore> 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 DBFileStore findKey(@Nonnull
                                                              DataSource ds,
                                                              @Nonnull
                                                              java.lang.String 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

extGetDerivedGlobalKey

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

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field that is being changed

params - The extra parameters

Returns:

The Global key

Throws:

java.lang.Exception - A serious problem. In general validation is done later.

extGetDerivedValue

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

Gets the value for the given field, using the given params, if any. Inherited fields are delegated to the super class.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - the field to get the value of

params - the field params

Returns:

Object the value of the field

Throws:

java.lang.Exception - a serious problem

find

public static DBFileStore find(DataSource ds)
                        throws java.lang.Exception

Find the default file store for this layer.

Parameters:

ds - The layer

Returns:

The file store.

Throws:

java.lang.Exception - A serious problem

findPreferred

public static DBFileStore[] findPreferred(DataSource ds)
                                   throws java.lang.Exception

Finds the list of preferred file stores for the login associated with the given datasource, sorted by sequence. only file stores that are active are returned in the file store list.

Parameters:

ds - The datasoure ( including timezone)

Returns:

The file store list

Throws:

java.lang.Exception - A serious problem

getActiveFileStoreAndItsAlternate

public static DBFileStore[] getActiveFileStoreAndItsAlternate(DBFileStore[] fs)

This function will check and populate the primary file store and its alternate into the lst object.

Parameters:

fs - DBFileStore a list of primary file stores

Returns:

DBFileStore[] it return the list of active file store including the primary file store and all its alternate file store.

populateActiveFileStoreAndItsAlternate

public static void populateActiveFileStoreAndItsAlternate(java.util.Set lst,
                                                          DBFileStore fs)

This function will check and populate the primary file sotre and its alternate into the lst object.

Parameters:

lst - Set filestore should populate all the filestores in this object

fs - DBFileStore the primary file store

findPreferred

public static DBFileStore[] findPreferred(VirtualDB layer,
                                          Login login,
                                          DBTimeZone tz)
                                   throws java.lang.Exception

Finds the list of preferred file stores for the login passed . Only file stores that are active are returned in the file store list.

Parameters:

layer - The layer

login - the login

tz - the timezone

Returns:

The file store list

Throws:

java.lang.Exception - A serious problem

getURLs

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

Returns the connection URL to the current storage location.

Parameters:

requireAdminURL - Return the URL for connecting as a administrator rather then as a user

haMode - Returns multiple urls if required for HA (high availability)

layerID - The layer of the file

Returns:

URL for connecting to storage location

Throws:

java.lang.Exception - Serious error

getAlternateStores

public DBObject[] getAlternateStores()

get alternative store

Returns:

the store

getVolumes

public DBObject[] getVolumes()

get the volumes

Returns:

the volumes