com.aspc.DBObj.ACL

Class AccessControl

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.ACL.AccessControl

All Implemented Interfaces:

DependanceListener, ReloadEventListener, Watcher, SecondaryCacheGroup

public class AccessControl
extends DBObject
implements DependanceListener, ReloadEventListener

AccessControl is used to limit the user access to DBObjects, based on the class and field values. ACL simulates additional WHERE clauses on every SELECT for a class. Users may only create/modify/delete objects that match the corresponding ACL's and of course the user must have read rights to be able to create/modify/delete an object.

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

Since:

May 1, 2001, 12:20 PM

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 AccessControl is used to limit the user access to DBObjects, based on the class and field values.
static java.lang.String	DBCLASS_NAME AccessControl is used to limit the user access to DBObjects, based on the class and field values.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
AccessControl(DBClass def, DataSource dataSource) Creates a new AccessControl object.

Method Summary

Modifier and Type	Method and Description
AccessControlClause	addClause(java.lang.String fieldPath, java.lang.String symbol, java.lang.String value)
protected void	clearCache(GlobalKey changedKey) Automatically called for eventDataLoaded() with this GlobalKey and getCleanVersion() with null for the global key.
static AccessControl	create(MutableDataSource mds) Make a new instance of this class.
protected void	doDependentsChanged() dependents have changed.
void	eventDependantAdded(GlobalKey addedKey, GlobalKey sourceFieldKey) A record that points to this record was added.
void	eventDependantRemoved(GlobalKey removedKey, GlobalKey sourceFieldKey) A record that points to this record was removed.
void	eventReload(DBObject obj) Called when a watched DBObject is reloaded, internally or externally.
protected void	extAutoEnterCreate() Extend this method to add functionality when a new DBObject is created. You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.
protected void	extPreValidate() Make sure that we validate all clauses when we validate an ACL.
protected ValidationError	extValidateField(DBField field, ValidationList list) Validates the fields of the restriction itself
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
AccessGroup	findAccessGroup(java.lang.String... args) Access group that this ACL applies to.
static AccessControl	findKey(DataSource ds, int key) Find the target for this class by the primary key
AccessGroup	getAccessGroup(java.lang.String... args)
DBClass	getBaseClass() Returns the base class for the restriction.
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getFieldPathDescOld(java.lang.String... args) Deprecated.
java.lang.String	getFieldPathOld(java.lang.String... args) Deprecated.
java.lang.String	getFieldValueOld(java.lang.String... args) Deprecated.
int	getID(java.lang.String... args)
java.lang.String	getSymbolOld(java.lang.String... args) Deprecated.
boolean	isCreateFg(java.lang.String... args)
boolean	isDeleteFg(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
boolean	isModifyFg(java.lang.String... args)
boolean	isOmitAllFg(java.lang.String... args)
boolean	isReadFg(java.lang.String... args)
AccessControlClause[]	listClauses() A short hand method of checking the omit all flag.
static DBQuery<AccessControl>	makeQuery(DataSource ds) Make a new QUERY for this class.
boolean	matches(DBObject obj) Checks that the passed object is allowed by this restriction.
AccessControl	setAccessGroup(com.aspc.dal.dbobj.acl.AccessGroup value, java.lang.String... args)
AccessControl	setBaseClass(com.aspc.dal.dbobj.DBClass value, java.lang.String... args)
AccessControl	setCreateFg(boolean value, java.lang.String... args)
AccessControl	setDeleteFg(boolean value, java.lang.String... args)
AccessControl	setDescription(java.lang.String value, java.lang.String... args)
AccessControl	setFieldPathDescOld(java.lang.String value, java.lang.String... args) Deprecated.
AccessControl	setFieldPathOld(java.lang.String value, java.lang.String... args) Deprecated.
AccessControl	setFieldValueOld(java.lang.String value, java.lang.String... args) Deprecated.
AccessControl	setFinalFg(boolean value, java.lang.String... args)
AccessControl	setID(int value, java.lang.String... args)
AccessControl	setModifyFg(boolean value, java.lang.String... args)
AccessControl	setOmitAllFg(boolean value, java.lang.String... args)
AccessControl	setReadFg(boolean value, java.lang.String... args)
AccessControl	setSymbolOld(java.lang.String value, java.lang.String... args) Deprecated.
java.lang.String	toString() A simple description of the restriction

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, eventFieldUpdated, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, 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, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.DBObj.Listeners.Watcher

registerWatchedObject

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

AccessControl is used to limit the user access to DBObjects, based on the class and field values. ACL simulates additional WHERE clauses on every SELECT for a class. Users may only create/modify/delete objects that match the corresponding ACL's and of course the user must have read rights to be able to create/modify/delete an object.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

AccessControl is used to limit the user access to DBObjects, based on the class and field values. ACL simulates additional WHERE clauses on every SELECT for a class. Users may only create/modify/delete objects that match the corresponding ACL's and of course the user must have read rights to be able to create/modify/delete an object.

Constructor Detail

AccessControl

public AccessControl(DBClass def,
                     DataSource dataSource)
              throws java.lang.Exception

Creates a new AccessControl object.

Parameters:

def - The dbClass of the DBObject

dataSource - The objects datasource

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

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

setID

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

Throws:

java.lang.Exception

getAccessGroup

@CheckReturnValue
 @Nullable
public AccessGroup getAccessGroup(java.lang.String... args)

findAccessGroup

@CheckReturnValue
 @Nonnull
public final AccessGroup findAccessGroup(java.lang.String... args)
                                                              throws NotFoundException

Access group that this ACL applies to.

--> AccessGroup (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

AccessGroup

Throws:

NotFoundException - AccessGroup was not found

setAccessGroup

@Nonnull
public AccessControl setAccessGroup(com.aspc.dal.dbobj.acl.AccessGroup value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

setBaseClass

@Nonnull
public AccessControl setBaseClass(com.aspc.dal.dbobj.DBClass value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isCreateFg

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

setCreateFg

@Nonnull
public AccessControl setCreateFg(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isDeleteFg

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

setDeleteFg

@Nonnull
public AccessControl setDeleteFg(boolean 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 AccessControl setDescription(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getFieldPathDescOld

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getFieldPathDescOld(java.lang.String... args)

Deprecated.

setFieldPathDescOld

@Deprecated
 @Nonnull
public AccessControl setFieldPathDescOld(java.lang.String value,
                                                               java.lang.String... args)
                                                        throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getFieldPathOld

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getFieldPathOld(java.lang.String... args)

Deprecated.

setFieldPathOld

@Deprecated
 @Nonnull
public AccessControl setFieldPathOld(java.lang.String value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getFieldValueOld

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getFieldValueOld(java.lang.String... args)

Deprecated.

setFieldValueOld

@Deprecated
 @Nonnull
public AccessControl setFieldValueOld(java.lang.String value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

isFinalFg

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

setFinalFg

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

Throws:

java.lang.Exception

isModifyFg

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

setModifyFg

@Nonnull
public AccessControl setModifyFg(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isOmitAllFg

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

setOmitAllFg

@Nonnull
public AccessControl setOmitAllFg(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isReadFg

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

setReadFg

@Nonnull
public AccessControl setReadFg(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getSymbolOld

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getSymbolOld(java.lang.String... args)

Deprecated.

setSymbolOld

@Deprecated
 @Nonnull
public AccessControl setSymbolOld(java.lang.String value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

create

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

extAutoEnterCreate

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

Description copied from class: DBObject

Extend this method to add functionality when a new DBObject is created.
You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

eventDependantAdded

public void eventDependantAdded(GlobalKey addedKey,
                                GlobalKey sourceFieldKey)

A record that points to this record was added. The object is available via findKey.

Specified by:

eventDependantAdded in interface DependanceListener

Parameters:

addedKey - The record's key that was added.

sourceFieldKey - Via which field is this object linked ?

See Also:

DependanceListener.eventDependantAdded( GlobalKey addedKey, GlobalKey sourceFieldKey)

eventDependantRemoved

public void eventDependantRemoved(GlobalKey removedKey,
                                  GlobalKey sourceFieldKey)

A record that points to this record was removed. Only the global key is available now.

Specified by:

eventDependantRemoved in interface DependanceListener

Parameters:

removedKey - The record key that was removed.

sourceFieldKey - Via which field is this object linked ?

See Also:

DependanceListener.eventDependantRemoved( GlobalKey removedKey, GlobalKey sourceFieldKey)

clearCache

@OverridingMethodsMustInvokeSuper
protected void clearCache(@Nullable
                                                            GlobalKey changedKey)

Description copied from class: DBObject

Automatically called for eventDataLoaded() with this GlobalKey and getCleanVersion() with null for the global key. The design should clear ALL cache if the changedKey is null.

Overrides:

clearCache in class DBObject

Parameters:

changedKey - The key that was changed.

eventReload

public void eventReload(@Nonnull
                        DBObject obj)

Called when a watched DBObject is reloaded, internally or externally. Use to clear secondary caches

Specified by:

eventReload in interface ReloadEventListener

Parameters:

obj - The object that was reloaded.

addClause

@Nonnull
public AccessControlClause addClause(java.lang.String fieldPath,
                                              java.lang.String symbol,
                                              java.lang.String value)

Parameters:

fieldPath - the path

symbol - the symbol

value - the value

Returns:

the clause

getBaseClass

@Nullable
 @CheckReturnValue
public DBClass getBaseClass()

Returns the base class for the restriction.

Returns:

The base class

listClauses

@CheckReturnValue
 @Nonnull
public AccessControlClause[] listClauses()

A short hand method of checking the omit all flag. If checked the restriction applies to all rows.

Returns:

True if omit all is checked.

matches

@CheckReturnValue
public boolean matches(@Nonnull
                                         DBObject obj)
                                  throws java.lang.Exception

Checks that the passed object is allowed by this restriction.

Parameters:

obj - The object to check

Returns:

True if the object matches the restriction ( OK)

Throws:

java.lang.Exception - A serious problem

toString

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

A simple description of the restriction

Overrides:

toString in class DBObject

Returns:

The description

extPreValidate

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

Make sure that we validate all clauses when we validate an ACL.

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

Validates the fields of the restriction itself

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to validated

Returns:

The validation error or warning.

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

doDependentsChanged

protected void doDependentsChanged()

dependents have changed.