org.tentackle.pdo

Class PersistentObjectClassVariables<T extends PersistentDomainObject<T>,P extends AbstractPersistentObject<T,P>>

java.lang.Object

org.tentackle.persist.DbObjectClassVariables<P>

org.tentackle.pdo.PersistentObjectClassVariables<T,P>

Type Parameters:

T - the PDO class type

P - the persistence class type

public class PersistentObjectClassVariables<T extends PersistentDomainObject<T>,P extends AbstractPersistentObject<T,P>>
extends DbObjectClassVariables<P>

Extends DbObjectClassVariables for AbstractPersistentObjects.

Author:

harald

Nested Class Summary

Nested classes/interfaces inherited from class org.tentackle.persist.DbObjectClassVariables

DbObjectClassVariables.ForeignReference

Field Summary

Fields

Modifier and Type	Field and Description
boolean	checkSecurity Flag is true to check the security rules for each access to objects of this class.
static String	CLASSVARIABLES_NAME the declared name of the static class variables.
List<Join<T,?>>	eagerJoins The optional eager join.
Class<T>	pdoClass The associated PDO class (i.e.
String	pdoClassBaseName the pdo base-classname.
static String	PROPERTY_CHECKSECURITY property key for the check security.
StatementId	selectAllCursorStatementId prepared statement ID for AbstractPersistentObject.selectAllAsCursor().
StatementId	selectAllStatementId prepared statement ID for AbstractPersistentObject.selectAll().
StatementId	selectByNormTextCursorStatementId prepared statement ID for AbstractPersistentObject.selectByNormTextAsCursor(java.lang.String).
StatementId	selectByNormTextStatementId prepared statement ID for AbstractPersistentObject.selectByNormText(java.lang.String).
StatementId	selectTokenLockStatementId prepared statement ID for select in AbstractPersistentObject.updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp).
PersistentObjectClassVariables<? super T,? super P>	superClassVariables The classvariables of the parent class. null if not inherited.
String	tableAlias The table alias to be used in joined selects.
PersistentObjectClassVariables<? super T,? super P>	topSuperClassVariables The classvariables of the topmost parent class. "this" if not inherited.
StatementId	transferTokenLockStatementId prepared statement ID for AbstractPersistentObject.transferTokenLock(long).
StatementId	updateTokenLockOnlyStatementId prepared statement ID for AbstractPersistentObject.updateTokenLockOnly().
StatementId	updateTokenLockStatementId prepared statement ID for AbstractPersistentObject.updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp).

Fields inherited from class org.tentackle.persist.DbObjectClassVariables

alwaysPrepare, classBaseName, classId, clazz, columnCount, deleteStatementId, dummyUpdateStatementId, expirationBacklog, foreignReferences, idSource, insertStatementId, properties, remoteDelegateId, selectAllIdSerialStatementId, selectAllObjectsStatementId, selectExpiredTableSerials1StatementId, selectExpiredTableSerials2StatementId, selectLockedStatementId, selectMaxIdStatementId, selectMaxTableSerialStatementId, selectObjectStatementId, selectSerialStatementId, tableName, updateSerialAndTableSerialStatementId, updateSerialStatementId, updateStatementId, updateTableSerialStatementId

Constructor Summary

Constructors

Constructor and Description
PersistentObjectClassVariables(Class<T> pdoClass, Class<P> poClass, String alias) Constructs a classvariable.
PersistentObjectClassVariables(Class<T> pdoClass, Class<P> poClass, String tableAlias, PersistentObjectClassVariables<? super T,? super P> superClassVariables, List<Join<T,?>> eagerJoins) Constructs a classvariable.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkClassPermission(DomainContext context, Permission permission) Check security for this class.
protected int	determineReferencePriority(Class<? extends AbstractDbObject<?>> clazz) Determine the referencing priority.
String	getColumnName(String name) Gets the full column name with optional table alias.
List<Join<T,?>>	getEagerJoins() Gets the eager joins.
String	getTableAlias() Gets the table alias.
String	getTableName() Returns the tablename for this classvariable.
PersistentObjectClassVariables<? super T,? super P>	getTopSuperClassVariables() Returns the topmost classvariables. Useful for multi-inheritance.
boolean	isAbstract() Returns whether the pdo class is abstract.
boolean	isEditAllowed(AbstractPersistentObject<?,?> object) Check the edit security for a single object.
boolean	isReadAllowed() Check the read security for this class in all contexts.
boolean	isReadAllowed(AbstractPersistentObject<?,?> object) Check the read security for a single object.
<T extends AbstractPersistentObject<?,?>,C extends Collection<T>> C	isReadAllowed(C objects) Checks the read security for a collection of objects of this class. The returned collection is of the same type as the original collection.
boolean	isReadAllowed(DomainContext context) Check the read security for this class.
boolean	isReferenced(Db db, long id) Determines whether the class of this variable holder is referenced.
boolean	isViewAllowed(AbstractPersistentObject<?,?> object) Check the view security for a single object.
boolean	isWriteAllowed() Check the write security for this class in all contexts.
boolean	isWriteAllowed(AbstractPersistentObject<?,?> object) Check the write security for a single object.
<T extends AbstractPersistentObject<?,?>,C extends Collection<T>> C	isWriteAllowed(C objects) Checks the write security for a collection of objects of this class. The returned collection is of the same type as the original collection.
boolean	isWriteAllowed(DomainContext context) Check the write security for this class.
protected void	loadMoreProperties() Loads more properties. Invoked from constructor.
String	toString()

Methods inherited from class org.tentackle.persist.DbObjectClassVariables

addReferencingClass, createBacklog, getIdSource, getProperty, getRemoteDelegate, getRemoteDelegateId, getVariables, isReferencedImpl, loadProperties, putProperty, putVariables, removeReferencingClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_CHECKSECURITY

public static final String PROPERTY_CHECKSECURITY

property key for the check security.

See Also:

Constant Field Values

CLASSVARIABLES_NAME

public static final String CLASSVARIABLES_NAME

the declared name of the static class variables.

See Also:

Constant Field Values

pdoClass

public final Class<T extends PersistentDomainObject<T>> pdoClass

The associated PDO class (i.e. the interface)

eagerJoins

public final List<Join<T extends PersistentDomainObject<T>,?>> eagerJoins

The optional eager join.

pdoClassBaseName

public final String pdoClassBaseName

the pdo base-classname.

tableAlias

public String tableAlias

The table alias to be used in joined selects.

superClassVariables

public final PersistentObjectClassVariables<? super T extends PersistentDomainObject<T>,? super P extends AbstractPersistentObject<T,P>> superClassVariables

The classvariables of the parent class.
null if not inherited.

topSuperClassVariables

public PersistentObjectClassVariables<? super T extends PersistentDomainObject<T>,? super P extends AbstractPersistentObject<T,P>> topSuperClassVariables

The classvariables of the topmost parent class.
"this" if not inherited.

checkSecurity

public boolean checkSecurity

Flag is true to check the security rules for each access to objects of this class. The rules will be checked in local db access only (i.e. the check will be applied already at the RMI-side *before* the data is leaving the client!) Because this check can be somewhat time consuming, it's turned off by default. The flag cannot be changed at runtime anymore!

selectByNormTextStatementId

public final StatementId selectByNormTextStatementId

prepared statement ID for AbstractPersistentObject.selectByNormText(java.lang.String).

selectAllStatementId

public final StatementId selectAllStatementId

prepared statement ID for AbstractPersistentObject.selectAll().

selectByNormTextCursorStatementId

public final StatementId selectByNormTextCursorStatementId

prepared statement ID for AbstractPersistentObject.selectByNormTextAsCursor(java.lang.String).

selectAllCursorStatementId

public final StatementId selectAllCursorStatementId

prepared statement ID for AbstractPersistentObject.selectAllAsCursor().

updateTokenLockStatementId

public final StatementId updateTokenLockStatementId

prepared statement ID for AbstractPersistentObject.updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp).

updateTokenLockOnlyStatementId

public final StatementId updateTokenLockOnlyStatementId

prepared statement ID for AbstractPersistentObject.updateTokenLockOnly().

selectTokenLockStatementId

public final StatementId selectTokenLockStatementId

prepared statement ID for select in AbstractPersistentObject.updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp).

transferTokenLockStatementId

public final StatementId transferTokenLockStatementId

prepared statement ID for AbstractPersistentObject.transferTokenLock(long).

Constructor Detail

PersistentObjectClassVariables

public PersistentObjectClassVariables(Class<T> pdoClass,
                                      Class<P> poClass,
                                      String tableAlias,
                                      PersistentObjectClassVariables<? super T,? super P> superClassVariables,
                                      List<Join<T,?>> eagerJoins)

Constructs a classvariable.

Notice: the superPoClass is necessary only in SINGLE and MULTI table inheritance configurations.

Parameters:

pdoClass - the PDO's class (i.e. interface)

poClass - the class of the persistence implementation

tableAlias - the table alias to be used in joined selects

superClassVariables - the class variables of the superclass, null if not inherited

eagerJoins - the optional eager joins, null of empty if none

PersistentObjectClassVariables

public PersistentObjectClassVariables(Class<T> pdoClass,
                                      Class<P> poClass,
                                      String alias)

Constructs a classvariable.

Parameters:

pdoClass - the PDO's class (i.e. interface)

poClass - the class of the persistence implementation

alias - the table alias to be used in joined selects

Method Detail

getEagerJoins

public List<Join<T,?>> getEagerJoins()

Gets the eager joins.

Returns:

the join, null or empty if none

getTableName

public String getTableName()

Returns the tablename for this classvariable.

If the class has no tablename, it is derived from its superclasses.

Returns:

the tablename, null if class does not map to any database table

getTableAlias

public String getTableAlias()

Gets the table alias.

If the class has no tablename, it is derived from its superclasses.

Returns:

the alias, null if class does not map to any database table

getColumnName

public String getColumnName(String name)

Gets the full column name with optional table alias.

Parameters:

name - the short name

Returns:

the full name

getTopSuperClassVariables

public PersistentObjectClassVariables<? super T,? super P> getTopSuperClassVariables()

Returns the topmost classvariables.
Useful for multi-inheritance.

Returns:

the topmost variables, this if not inherited, never null

loadMoreProperties

protected void loadMoreProperties()

Loads more properties.
Invoked from constructor.

isReferenced

public boolean isReferenced(Db db,
                            long id)

Description copied from class: DbObjectClassVariables

Determines whether the class of this variable holder is referenced.

Overrides:

isReferenced in class DbObjectClassVariables<P extends AbstractPersistentObject<T,P>>

Parameters:

db - the Db connection

id - the object id to test whether it is referenced by any other objects

Returns:

true if referenced

toString

public String toString()

Overrides:

toString in class DbObjectClassVariables<P extends AbstractPersistentObject<T,P>>

isAbstract

public boolean isAbstract()

Returns whether the pdo class is abstract.

Returns:

true if abstract

isReadAllowed

public boolean isReadAllowed(DomainContext context)

Check the read security for this class. The implementation checks that the class rules will accept and that no object rule denies.

Notice that SecurityPersistenceImpl objects are always readable!

Parameters:

context - the current domain context, null = all

Returns:

false if operation (select) is denied.

isReadAllowed

public boolean isReadAllowed()

Check the read security for this class in all contexts.

Returns:

false if operation (select) is denied.

isWriteAllowed

public boolean isWriteAllowed(DomainContext context)

Check the write security for this class. The implementation checks that the class rules will accept and that no object rule denies.

Parameters:

context - the current domain context, null = all

Returns:

false if operation (delete, update or insert) is denied.

isWriteAllowed

public boolean isWriteAllowed()

Check the write security for this class in all contexts.

Returns:

false if operation (delete, update or insert) is denied.

isReadAllowed

public boolean isReadAllowed(AbstractPersistentObject<?,?> object)

Check the read security for a single object.

This is a low-level method. Only root entities are checked. Components must check their root-entity!

Parameters:

object - the object to check the security rules for.

Returns:

false if operation (select) is denied.

isWriteAllowed

public boolean isWriteAllowed(AbstractPersistentObject<?,?> object)

Check the write security for a single object.

This is a low-level method. Only root entities are checked. Components must check their root-entity!

Parameters:

object - the object to check the security rules for.

Returns:

false if operation is denied

isViewAllowed

public boolean isViewAllowed(AbstractPersistentObject<?,?> object)

Check the view security for a single object.

This is a low-level method. Only root entities are checked. Components must check their root-entity!

Parameters:

object - the object to check the security rules for.

Returns:

false if operation is denied

isEditAllowed

public boolean isEditAllowed(AbstractPersistentObject<?,?> object)

Check the edit security for a single object.

This is a low-level method. Only root entities are checked. Components must check their root-entity!

Parameters:

object - the object to check the security rules for.

Returns:

false if operation is denied

isReadAllowed

public <T extends AbstractPersistentObject<?,?>,C extends Collection<T>> C isReadAllowed(C objects)

Checks the read security for a collection of objects of this class.
The returned collection is of the same type as the original collection. Notice that this method is provided for applications that circumvent readFromResultsetWrapper() somehow (which checks the read permission). Tentackle is not using this method.

Notice that SecurityPersistenceImpl objects are always readable!

Type Parameters:

T - AbstractPersistentObject class

C - Collection class

Parameters:

objects - the collection to check the security rules for.

Returns:

the objects with permission accepted.

isWriteAllowed

public <T extends AbstractPersistentObject<?,?>,C extends Collection<T>> C isWriteAllowed(C objects)

Checks the write security for a collection of objects of this class.
The returned collection is of the same type as the original collection. Notice that this method is provided for applications that circumvent deleteObject, updateObject or insertObject somehow (all of them check the write permission). Tentackle is not using this method. Furthermore, special care must be taken for "deleteBy..." methods that delete objects by an sql-statement via "DELETE ...".

Type Parameters:

T - AbstractPersistentObject class

C - Collection class

Parameters:

objects - the collection to check the security rules for.

Returns:

the objects with permission accepted.

determineReferencePriority

protected int determineReferencePriority(Class<? extends AbstractDbObject<?>> clazz)

Determine the referencing priority.

The default implementation returns 0. Provided to be overridden.

Overridden to determine the priority according to the presence of a cache:

1. high: class provides a preloading cache (low volume data, usually master data)
2. medium: class provides a non-preloading cache (medium volume data)
3. low: class provides no cache (high volume, usually transaction data)

Notice that the cache must be named "cache". This is the case for wurblet generated caches.

Overrides:

determineReferencePriority in class DbObjectClassVariables<P extends AbstractPersistentObject<T,P>>

Parameters:

clazz - the referencing class

Returns:

the priority

checkClassPermission

protected boolean checkClassPermission(DomainContext context,
                                       Permission permission)

Check security for this class.

Parameters:

context - the domain context

permission - the permission

Returns:

true if accepted