Package ubic.gemma.persistence.util

Class AclQueryUtils

java.lang.Object

ubic.gemma.persistence.util.AclQueryUtils

public class AclQueryUtils
extends Object

Utilities for integrating ACL into Query.

To build a query, sequentially proceed as follows:

1. form your select clause and your jointures
2. concatenate formAclRestrictionClause(String) or formNativeAclJoinClause(String) in the jointure section
3. form where clause and add your constraints
4. concatenate formNativeAclRestrictionClause(SessionFactoryImplementor) in the clause section (only for native queries)
5. bind all your parameters
6. bind ACL-specific parameters with addAclParameters(Query, Class) to the query object

Author:

poirigui

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACE_ALIAS	Alias used.
static String	AOI_ALIAS	Alias used.
static String	SID_ALIAS	Alias used.

Constructor Summary

Constructors

Constructor	Description
AclQueryUtils()

Method Summary

Modifier and Type	Method	Description
static void	addAclParameters(Query query, Class<? extends gemma.gsec.model.Securable> aoiType)	Bind Query parameters to a join clause generated with formAclRestrictionClause(String) and add ACL restriction parameters defined in formAclRestrictionClause(String).
static String	formAclRestrictionClause(String aoiIdColumn)	Create an HQL join clause for AclObjectIdentity, AclGrantedAuthoritySid and a restriction clause to limit the result only to objects the currently logged user can access.
static String	formNativeAclJoinClause(String aoiIdColumn)	Native SQL flavour of the ACL jointure.
static String	formNativeAclRestrictionClause(SessionFactoryImplementor sessionFactoryImplementor)	Native flavour of the ACL restriction clause.

Methods inherited from class java.lang.Object

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

Field Detail

AOI_ALIAS

public static final String AOI_ALIAS

Alias used.

See Also:

Constant Field Values

SID_ALIAS

public static final String SID_ALIAS

Alias used.

See Also:

Constant Field Values

ACE_ALIAS

public static final String ACE_ALIAS

Alias used.

See Also:

Constant Field Values

Constructor Detail

AclQueryUtils

public AclQueryUtils()

Method Detail

formAclRestrictionClause

public static String formAclRestrictionClause(String aoiIdColumn)

Create an HQL join clause for AclObjectIdentity, AclGrantedAuthoritySid and a restriction clause to limit the result only to objects the currently logged user can access.

Ensure that you use addAclParameters(Query, Class) afterward to bind the query parameters.

FIXME: this ACL jointure is really annoying because it is one-to-many, maybe handling everything in a sub-query would be preferable?

Parameters:

aoiIdColumn - column for the identifier e.g. "ee.id"

Returns:

clause to add to the query after any jointure

formNativeAclJoinClause

public static String formNativeAclJoinClause(String aoiIdColumn)

Native SQL flavour of the ACL jointure.

Note: unlike the HQL version, this query uses on to restrict the jointure, so you can define the where clause yourself.

See Also:

formAclRestrictionClause(String)

formNativeAclRestrictionClause

public static String formNativeAclRestrictionClause(SessionFactoryImplementor sessionFactoryImplementor)

Native flavour of the ACL restriction clause.

See Also:

formAclRestrictionClause(String)

addAclParameters

public static void addAclParameters(Query query,
                                    Class<? extends gemma.gsec.model.Securable> aoiType)
                             throws QueryParameterException

Bind Query parameters to a join clause generated with formAclRestrictionClause(String) and add ACL restriction parameters defined in formAclRestrictionClause(String).

This method also work for native queries formed with formNativeAclJoinClause(String) and formNativeAclRestrictionClause(SessionFactoryImplementor).

Parameters:

query - a Query object that contains the join and restriction clauses

aoiType - the AOI type to be bound in the query

Throws:

QueryParameterException - if any defined parameters are missing, which is typically due to a missing prior formAclRestrictionClause(String).