com.aspc.DBObj.ACL

Class AccessControlClause

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.ACL.AccessControlClause

All Implemented Interfaces:

SecondaryCacheGroup

public class AccessControlClause
extends DBObject

A clause identifies a condition that should be applied to give the user access to 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 A clause identifies a condition that should be applied to give the user access to an object.
static java.lang.String	DBCLASS_NAME A clause identifies a condition that should be applied to give the user access to an object.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static AccessControlClause	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extDelete() Update the in-memory universe BEFORE validating
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
protected ValidationError	extValidateField(DBField field, ValidationList list) Validates the fields of the restriction itself
AccessControl	findAccessControl(java.lang.String... args) Identifies the Access Control item that this clause is part of.
static AccessControlClause	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBModuleOption	findModuleOption(java.lang.String... args) If the clause is associated with an Module Option then this clause will only be active if that option is enabled.
AccessControl	getAccessControl(java.lang.String... args)
DBClass	getBaseClass()
java.lang.String	getFieldPath() The field path for the restriction
java.lang.String	getFieldPathDesc(java.lang.String... args)
java.lang.String	getFieldValue(java.lang.String... args)
int	getID(java.lang.String... args)
DBModuleOption	getModuleOption(java.lang.String... args)
java.lang.String	getSymbol() The symbol to be used in the restriction.
java.lang.Object	getValue(Login login) Gets the expanded version of the value to be used in the restriction.
static DBQuery<AccessControlClause>	makeQuery(DataSource ds) Make a new QUERY for this class.
boolean	matches(DBObject obj) Checks that the passed object is allowed by this restriction.
AccessControlClause	setAccessControl(com.aspc.dal.dbobj.acl.AccessControl value, java.lang.String... args)
AccessControlClause	setFieldPath(java.lang.String value, java.lang.String... args)
AccessControlClause	setFieldPathDesc(java.lang.String value, java.lang.String... args)
AccessControlClause	setFieldValue(java.lang.String value, java.lang.String... args)
AccessControlClause	setID(int value, java.lang.String... args)
AccessControlClause	setModuleOption(com.aspc.dal.dbobj.module.DBModuleOption value, java.lang.String... args)
AccessControlClause	setSymbol(java.lang.String value, java.lang.String... args)
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, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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, 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 clause identifies a condition that should be applied to give the user access to an object.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A clause identifies a condition that should be applied to give the user access to an object.

Constructor Detail

AccessControlClause

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

Creates a new AccessControlClause 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 AccessControlClause setID(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getAccessControl

@CheckReturnValue
 @Nullable
public AccessControl getAccessControl(java.lang.String... args)

findAccessControl

@CheckReturnValue
 @Nonnull
public final AccessControl findAccessControl(java.lang.String... args)
                                                                  throws NotFoundException

Identifies the Access Control item that this clause is part of.

--> AccessControl (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

AccessControl

Throws:

NotFoundException - AccessControl was not found

setAccessControl

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

Throws:

java.lang.Exception

setFieldPath

@Nonnull
public AccessControlClause setFieldPath(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getFieldPathDesc

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

setFieldPathDesc

@Nonnull
public AccessControlClause setFieldPathDesc(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getFieldValue

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

setFieldValue

@Nonnull
public AccessControlClause setFieldValue(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getModuleOption

@CheckReturnValue
 @Nullable
public DBModuleOption getModuleOption(java.lang.String... args)

findModuleOption

@CheckReturnValue
 @Nonnull
public final DBModuleOption findModuleOption(java.lang.String... args)
                                                                  throws NotFoundException

If the clause is associated with an Module Option then this clause will only be active if that option is enabled.

--> DBModuleOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBModuleOption

Throws:

NotFoundException - DBModuleOption was not found

setModuleOption

@Nonnull
public AccessControlClause setModuleOption(com.aspc.dal.dbobj.module.DBModuleOption value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

setSymbol

@Nonnull
public AccessControlClause setSymbol(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

create

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

getBaseClass

public DBClass getBaseClass()

Returns:

the base class

getFieldPath

public java.lang.String getFieldPath()

The field path for the restriction

Returns:

The path

getSymbol

public java.lang.String getSymbol()

The symbol to be used in the restriction.

Returns:

The symbol

getValue

public java.lang.Object getValue(Login login)
                          throws java.lang.Exception

Gets the expanded version of the value to be used in the restriction. Expands $login$ -> the datasource's login. $loginGroup$ -> the datasource's login group $loginGroupParents$ -> the datasource's login group's parents

Parameters:

login - The login

Returns:

The expanded value.

Throws:

java.lang.Exception - A serious problem

matches

public boolean matches(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

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

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if mandatory

See Also:

DBObject.extIsMandatory( DBField)

extDelete

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

Update the in-memory universe BEFORE validating

Overrides:

extDelete in class DBObject

Throws:

java.lang.Exception - A serious problem

extPreValidate

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

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

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

update dependent fields.

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