com.aspc.DBObj.ACL

Class DBFilePermission

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.ACL.DBPermission

com.aspc.DBObj.ACL.DBFilePermission

All Implemented Interfaces:

SecondaryCacheGroup

public class DBFilePermission
extends DBPermission

Control access to a file.

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

Since:

8 September 2003

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 Control access to a file
static java.lang.String	DBCLASS_NAME Control access to a file

Fields inherited from class com.aspc.DBObj.ACL.DBPermission

TYPE_CREATE, TYPE_DELETE, TYPE_FULL, TYPE_MODIFY, TYPE_READ

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	displayName() The display name
protected ValidationError	extValidateField(DBField field, ValidationList list) You can have two permissions for the same user/group.
DBFile	findFile(java.lang.String... args) File.
DBFile	getFile(java.lang.String... args)
static java.lang.Boolean	hasCreateAccess(DBFile file, FldParams params) A CREATE permission for this file
static java.lang.Boolean	hasDeleteAccess(DBFile file, FldParams params) A DELETE permission for this file
static java.lang.Boolean	hasFullAccess(DBFile file, FldParams params) A FULL permission for this file
static java.lang.Boolean	hasModifyAccess(DBFile file, FldParams params) A MODIFY permission for this file
static java.lang.Boolean	hasReadAccess(DBFile file, FldParams params) A READ permission for this file
DBFilePermission	setFile(com.aspc.dal.file.DBFile value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.ACL.DBPermission

eventDataLoaded, eventFieldUpdated, extFixUp, findCreateAccess, findDeleteAccess, findFullControlAccess, findKey, findModifyAccess, findPermissionedContact, findReadAccess, getCreateAccess, getDeleteAccess, getExpiryTS, getFullControlAccess, getID, getModifyAccess, getPermissionedContact, getReadAccess, getType, iHasAccess, makeQuery, setCreateAccess, setDeleteAccess, setExpiryTS, setFullControlAccess, setID, setModifyAccess, setPermissionedContact, setReadAccess

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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Control access to a file

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Control access to a file

Constructor Detail

DBFilePermission

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

getFile

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

findFile

@CheckReturnValue
 @Nonnull
public final DBFile findFile(java.lang.String... args)
                                                  throws NotFoundException

File.

--> DBFile (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

File permission

Throws:

NotFoundException - DBFile was not found

setFile

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

Throws:

java.lang.Exception

displayName

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

The display name

Overrides:

displayName in class DBObject

Returns:

The display name.

extValidateField

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

You can have two permissions for the same user/group.

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to validate

list - The current validation list

Returns:

The validation Error if any

Throws:

java.lang.Exception - A serious problem

hasReadAccess

public static java.lang.Boolean hasReadAccess(DBFile file,
                                              FldParams params)
                                       throws java.lang.Exception

A READ permission for this file

Parameters:

file - The file to check

params - The parameters used

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem

hasModifyAccess

public static java.lang.Boolean hasModifyAccess(DBFile file,
                                                FldParams params)
                                         throws java.lang.Exception

A MODIFY permission for this file

Parameters:

file - The file to check

params - The parameters used

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem

hasDeleteAccess

public static java.lang.Boolean hasDeleteAccess(DBFile file,
                                                FldParams params)
                                         throws java.lang.Exception

A DELETE permission for this file

Parameters:

file - The file to check

params - The parameters used

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem

hasCreateAccess

public static java.lang.Boolean hasCreateAccess(DBFile file,
                                                FldParams params)
                                         throws java.lang.Exception

A CREATE permission for this file

Parameters:

file - The file to check

params - The parameters used

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem

hasFullAccess

public static java.lang.Boolean hasFullAccess(DBFile file,
                                              FldParams params)
                                       throws java.lang.Exception

A FULL permission for this file

Parameters:

file - The file to check

params - The parameters used

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem