com.neurosys.saas.etl

Class TenantContextJPAQueryTransformer<O extends Organization,U extends SAASUser<O>>

java.lang.Object

com.neurosys.dao.jpa.EntityManagerLookupAware

com.neurosys.dao.jpa.JPAQueryTransformer

com.neurosys.saas.etl.TenantContextJPAQueryTransformer<O,U>

Type Parameters:

O - as Organization type

U - as SAASUser for O type

All Implemented Interfaces:

QueryTransformer, ContextConsumer<UserShell<U,?>>, UpdatableContext<javax.persistence.EntityManager>, Serializable, org.apache.commons.collections.Transformer

public abstract class TenantContextJPAQueryTransformer<O extends Organization,U extends SAASUser<O>>
extends JPAQueryTransformer
implements ContextConsumer<UserShell<U,?>>

This Transformer ensures all generic queries are made in context to the current Tenant.
By default the Tenant related to User#getOrganizations() and User#getPrimaryOrganization()

Author:

Arjun Dhar

See Also:

VerifyShellAccessToTenantTransformer, CurrentTenantSupplier, MultiTenantRecord, Serialized Form

Field Summary

Fields inherited from class com.neurosys.dao.jpa.JPAQueryTransformer

expectSingleResult, fieldMapping, query, queryIsNative, queryOptimizer, queryOptimizerEntityAlias

Constructor Summary

Constructors

Constructor and Description
TenantContextJPAQueryTransformer()
TenantContextJPAQueryTransformer(String query)

Method Summary

Modifier and Type	Method and Description
String	derivedQuery() Opportunity to override core JPAQueryTransformer.query string.
protected String	derivedQueryWhenNoContext() Special derivedQuery() version, when ContextConsumer.deriveContext() returns null (no context available)
protected Collection<O>	getAuthorizedUnits(U user) Based on context or current user get the Units the current session/request has access to.
protected abstract String	getTenantEntityName() Which JPA entity is Tenant/Organization representing
String	getTenantJoin() If not null will add to the end of the query AND <org=venue.owenerOrganization> OR {@code OR {@code
protected boolean	isAuthorizedAccessToAllOrgs(U user)
static void	main(String... args)
protected void	overrideFinalQuery(String queryString, javax.persistence.Query q) Opportunity to override any thing in the final generated Query Query in the JPAQueryTransformer.transform(Object) process.
protected void	overrideFinalQueryWhenNoContext() Special overrideFinalQuery(String, Query) version, when ContextConsumer.deriveContext() returns null (no context available)
void	setTenantJoin(String tenantJoin) If not null will add to the end of the query AND <org=venue.owenerOrganization> OR {@code OR {@code

Methods inherited from class com.neurosys.dao.jpa.JPAQueryTransformer

getFieldMapping, getPageInfo, getQuery, getQueryOptimizer, getQueryOptimizerEntityAlias, isExpectSingleResult, isParamAsSingleInput, isQueryIsNative, optimize, setExpectSingleResult, setFieldMapping, setPageInfo, setParamAsSingleInput, setQuery, setQueryIsNative, setQueryOptimizer, setQueryOptimizerEntityAlias, transform

Methods inherited from class com.neurosys.dao.jpa.EntityManagerLookupAware

getEntityManager, getEntityManagerProvider, setEntityManager, setEntityManagerProvider, updateContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.domain.ContextConsumer

deriveContext

Constructor Detail

TenantContextJPAQueryTransformer

public TenantContextJPAQueryTransformer()

TenantContextJPAQueryTransformer

public TenantContextJPAQueryTransformer(String query)

Method Detail

getTenantEntityName

protected abstract String getTenantEntityName()

Which JPA entity is Tenant/Organization representing

Returns:

String as name of Class/Entity

getAuthorizedUnits

protected Collection<O> getAuthorizedUnits(U user)

Based on context or current user get the Units the current session/request has access to. Can be injected, derived by methods like using a ThreadLocal or some way to tap into the session or request.

overrideFinalQuery

protected void overrideFinalQuery(String queryString,
                                  javax.persistence.Query q)

Opportunity to override any thing in the final generated Query Query in the JPAQueryTransformer.transform(Object) process.

Overrides:

overrideFinalQuery in class JPAQueryTransformer

Parameters:

queryString - as String (immutable, provided for reference purpose only)

q - as Query

See Also:

also, as these work together, overrideFinalQueryWhenNoContext()

main

public static void main(String... args)

derivedQuery

public String derivedQuery()

Opportunity to override core JPAQueryTransformer.query string.

Overrides:

derivedQuery in class JPAQueryTransformer

Returns:

String

See Also:

also, as these work together, derivedQueryWhenNoContext()

derivedQueryWhenNoContext

protected String derivedQueryWhenNoContext()

Special derivedQuery() version, when ContextConsumer.deriveContext() returns null (no context available)

Returns:

String

Default value:

By default will allow all access with an error logged.

overrideFinalQueryWhenNoContext

protected void overrideFinalQueryWhenNoContext()

Special overrideFinalQuery(String, Query) version, when ContextConsumer.deriveContext() returns null (no context available)

Default value:

By default do nothing

isAuthorizedAccessToAllOrgs

protected boolean isAuthorizedAccessToAllOrgs(U user)

getTenantJoin

public String getTenantJoin()

If not null will add to the end of the query
AND <org=venue.owenerOrganization> OR {@code OR {@code

Can be null:

true

setTenantJoin

public void setTenantJoin(String tenantJoin)

If not null will add to the end of the query
AND <org=venue.owenerOrganization> OR {@code OR {@code

Can be null:

true