com.aspc.DBObj.ACL

Class DBPermission

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.ACL.DBPermission

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

CPModulePermission, CPNewObjPermission, DBCommandPermission, DBFilePermission, DBFolderPermission, DBHelpPermission, DBModulePermission, DBTaskNotePermission, DBWikiPagePermission, RestPermission, SDBMenuItemPermission

public class DBPermission
extends DBObject

Permissions for files or folders.

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 Permissions for files or folders.
static java.lang.String	DBCLASS_NAME Permissions for files or folders.
static java.lang.String	TYPE_CREATE create
static java.lang.String	TYPE_DELETE delete
static java.lang.String	TYPE_FULL full access
static java.lang.String	TYPE_MODIFY modify
static java.lang.String	TYPE_READ read

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	eventDataLoaded() When the underlying DBData is changed/ loaded.
void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extFixUp() The extended fix up routine for known problems.
DBPermissionType	findCreateAccess(java.lang.String... args) Allow/Deny creatation of elements.
DBPermissionType	findDeleteAccess(java.lang.String... args) Allow/Deny deletion of elements.
DBPermissionType	findFullControlAccess(java.lang.String... args) Can assign permissions etc.
static DBPermission	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBPermissionType	findModifyAccess(java.lang.String... args) Allow/Deny modication of elements.
PermissionedContact	findPermissionedContact(java.lang.String... args) The person/group for this permission.
DBPermissionType	findReadAccess(java.lang.String... args) Allow/Deny read of elements.
DBPermissionType	getCreateAccess(java.lang.String... args)
DBPermissionType	getDeleteAccess(java.lang.String... args)
java.util.Date	getExpiryTS(java.lang.String... args)
DBPermissionType	getFullControlAccess(java.lang.String... args)
int	getID(java.lang.String... args)
DBPermissionType	getModifyAccess(java.lang.String... args)
PermissionedContact	getPermissionedContact(java.lang.String... args)
DBPermissionType	getReadAccess(java.lang.String... args)
java.lang.String	getType(java.lang.String fieldName)
static java.lang.Boolean	iHasAccess(DBObject[] list, java.lang.String type, FldParams params) Do we have access ?
static DBQuery<DBPermission>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBPermission	setCreateAccess(com.aspc.dal.dbobj.acl.DBPermissionType value, java.lang.String... args)
DBPermission	setDeleteAccess(com.aspc.dal.dbobj.acl.DBPermissionType value, java.lang.String... args)
DBPermission	setExpiryTS(java.util.Date value, java.lang.String... args)
DBPermission	setFullControlAccess(com.aspc.dal.dbobj.acl.DBPermissionType value, java.lang.String... args)
DBPermission	setID(int value, java.lang.String... args)
DBPermission	setModifyAccess(com.aspc.dal.dbobj.acl.DBPermissionType value, java.lang.String... args)
DBPermission	setPermissionedContact(com.aspc.dal.dbobj.contact.PermissionedContact value, java.lang.String... args)
DBPermission	setReadAccess(com.aspc.dal.dbobj.acl.DBPermissionType 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, 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, 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

TYPE_READ

public static final java.lang.String TYPE_READ

read

See Also:

Constant Field Values

TYPE_CREATE

public static final java.lang.String TYPE_CREATE

create

See Also:

Constant Field Values

TYPE_MODIFY

public static final java.lang.String TYPE_MODIFY

modify

See Also:

Constant Field Values

TYPE_DELETE

public static final java.lang.String TYPE_DELETE

delete

See Also:

Constant Field Values

TYPE_FULL

public static final java.lang.String TYPE_FULL

full access

See Also:

Constant Field Values

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Permissions for files or folders.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Permissions for files or folders.

Constructor Detail

DBPermission

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

getID

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

setID

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

Throws:

java.lang.Exception

getCreateAccess

@CheckReturnValue
 @Nullable
public DBPermissionType getCreateAccess(java.lang.String... args)

findCreateAccess

@CheckReturnValue
 @Nonnull
public final DBPermissionType findCreateAccess(java.lang.String... args)
                                                                    throws NotFoundException

Allow/Deny creatation of elements.

--> DBPermissionType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBPermissionType

Throws:

NotFoundException - DBPermissionType was not found

setCreateAccess

@Nonnull
public DBPermission setCreateAccess(com.aspc.dal.dbobj.acl.DBPermissionType value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDeleteAccess

@CheckReturnValue
 @Nullable
public DBPermissionType getDeleteAccess(java.lang.String... args)

findDeleteAccess

@CheckReturnValue
 @Nonnull
public final DBPermissionType findDeleteAccess(java.lang.String... args)
                                                                    throws NotFoundException

Allow/Deny deletion of elements.

--> DBPermissionType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBPermissionType

Throws:

NotFoundException - DBPermissionType was not found

setDeleteAccess

@Nonnull
public DBPermission setDeleteAccess(com.aspc.dal.dbobj.acl.DBPermissionType value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getExpiryTS

@CheckReturnValue
 @Nullable
public java.util.Date getExpiryTS(java.lang.String... args)

setExpiryTS

@Nonnull
public DBPermission setExpiryTS(java.util.Date value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getFullControlAccess

@CheckReturnValue
 @Nullable
public DBPermissionType getFullControlAccess(java.lang.String... args)

findFullControlAccess

@CheckReturnValue
 @Nonnull
public final DBPermissionType findFullControlAccess(java.lang.String... args)
                                                                         throws NotFoundException

Can assign permissions etc.

--> DBPermissionType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBPermissionType

Throws:

NotFoundException - DBPermissionType was not found

setFullControlAccess

@Nonnull
public DBPermission setFullControlAccess(com.aspc.dal.dbobj.acl.DBPermissionType value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getModifyAccess

@CheckReturnValue
 @Nullable
public DBPermissionType getModifyAccess(java.lang.String... args)

findModifyAccess

@CheckReturnValue
 @Nonnull
public final DBPermissionType findModifyAccess(java.lang.String... args)
                                                                    throws NotFoundException

Allow/Deny modication of elements.

--> DBPermissionType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBPermissionType

Throws:

NotFoundException - DBPermissionType was not found

setModifyAccess

@Nonnull
public DBPermission setModifyAccess(com.aspc.dal.dbobj.acl.DBPermissionType value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getPermissionedContact

@CheckReturnValue
 @Nullable
public PermissionedContact getPermissionedContact(java.lang.String... args)

findPermissionedContact

@CheckReturnValue
 @Nonnull
public final PermissionedContact findPermissionedContact(java.lang.String... args)
                                                                              throws NotFoundException

The person/group for this permission.

--> PermissionedContact (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

PermissionedContact

Throws:

NotFoundException - PermissionedContact was not found

setPermissionedContact

@Nonnull
public DBPermission setPermissionedContact(com.aspc.dal.dbobj.contact.PermissionedContact value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getReadAccess

@CheckReturnValue
 @Nullable
public DBPermissionType getReadAccess(java.lang.String... args)

findReadAccess

@CheckReturnValue
 @Nonnull
public final DBPermissionType findReadAccess(java.lang.String... args)
                                                                  throws NotFoundException

Allow/Deny read of elements.

--> DBPermissionType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBPermissionType

Throws:

NotFoundException - DBPermissionType was not found

setReadAccess

@Nonnull
public DBPermission setReadAccess(com.aspc.dal.dbobj.acl.DBPermissionType value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

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

extFixUp

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

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
public 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

eventDataLoaded

public void eventDataLoaded()

When the underlying DBData is changed/ loaded.

Overrides:

eventDataLoaded in class DBObject

getType

public java.lang.String getType(java.lang.String fieldName)

Parameters:

fieldName -

Returns:

the value

iHasAccess

public static java.lang.Boolean iHasAccess(DBObject[] list,
                                           java.lang.String type,
                                           FldParams params)
                                    throws java.lang.Exception

Do we have access ?

Parameters:

list - The list

type - The type

params - the params

Returns:

TRUE if has access

Throws:

java.lang.Exception - A serious problem