Package org.ametys.plugins.queriesdirectory

Class QueryDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.queriesdirectory.QueryDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class QueryDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for manipulating queries

Field Summary

Fields

Modifier and Type	Field	Description
protected ObservationManager	_observationManager	The observation manager
protected CurrentUserProvider	_userProvider	The current user provider
static final String	DELETE_ACCESS_PROPERTY	Propery key for delete access
static final String	EDIT_RIGHTS_ACCESS_PROPERTY	Propery key for edit rights access
static final String	QUERY_CONTAINER_HANDLE_RIGHT_ID	The right id to handle query container
static final String	QUERY_HANDLE_RIGHT_ID	The right id to handle query
static final String	READ_ACCESS_PROPERTY	Propery key for read access
static final String	RENAME_ACCESS_PROPERTY	Propery key for rename access
static final String	ROLE	The Avalon role
static final String	ROOT_QUERY_CONTAINER_ID	The alias id of the root QueryContainer
static final String	WRITE_ACCESS_PROPERTY	Propery key for write access

Constructor Summary

Constructors

Constructor	Description
QueryDAO()

Method Summary

Modifier and Type	Method	Description
protected boolean	_isRoot(QueryContainer queryContainer)	Determines if the query container is the root node
boolean	canAssignRights(UserIdentity userIdentity, Query query)	Check if a user can edit rights on a query
boolean	canAssignRights(UserIdentity userIdentity, QueryContainer queryContainer)	Check if a user can edit rights on a query container
boolean	canCreate(UserIdentity userIdentity, QueryContainer queryContainer)	Check if a user has creation rights on a query container
boolean	canDelete(UserIdentity userIdentity, Query query)	Determines if the user can delete a query
boolean	canDelete(UserIdentity userIdentity, QueryContainer queryContainer)	Determines if the user can delete a query container
boolean	canRead(UserIdentity userIdentity, Query query)	Determine if user has read access on a query
boolean	canRead(UserIdentity userIdentity, QueryContainer queryContainer)	Determines if the user has read access on a query container
boolean	canRename(UserIdentity userIdentity, QueryContainer queryContainer)	Determines if the user can rename a query container
boolean	canWrite(UserIdentity userIdentity, Query query)	Determines if the user has write access on a query
boolean	canWrite(UserIdentity userIdentity, QueryContainer queryContainer)	Check if a user has write access on a query container
boolean	canWrite(UserIdentity userIdentity, QueryContainer queryContainer, boolean recursively)	Check if a user has write access on a query container
Map<String,Object>	createQuery(String title, String desc, String documentation, String type, String content, String parentId)	Creates a new Query
Map<String,Object>	createQueryContainer(String parentId, String name)	Creates a new QueryContainer
Map<String,Object>	deleteQuery(List<String> ids)	Deletes Query(ies)
Map<String,Object>	deleteQueryContainer(List<String> ids)	Deletes QueryContainer(s)
AmetysObjectIterable<Query>	getChildQueriesForAdministrator(QueryContainer parent, boolean onlyDirect, Optional<String> type)	Gets all queries for administrator for given parent
Stream<Query>	getChildQueriesInReadAccess(QueryContainer parent, boolean onlyDirect, UserIdentity user, Optional<String> type)	Gets all queries in READ access for given parent
Stream<Query>	getChildQueriesInRightAccess(QueryContainer parent, boolean onlyDirect, UserIdentity user, Optional<String> type)	Gets all queries in WRITE access for given parent
Stream<Query>	getChildQueriesInWriteAccess(QueryContainer parent, boolean onlyDirect, UserIdentity user, Optional<String> type)	Gets all queries in WRITE access for given parent
AmetysObjectIterable<QueryContainer>	getChildQueryContainers(QueryContainer parent)	Gets all query containers for given parent
List<String>	getIdsOfPath(String queryId)	Gets the ids of the path elements of a query or query container, i.e.
Map<String,Object>	getQueriesProperties(List<String> queryIds)	Get queries' properties
QueryContainer	getQueriesRootNode()	Get the root plugin storage object.
Map<String,Object>	getQueryContainerProperties(String id)	Get the query container properties
Map<String,Object>	getQueryContainerProperties(QueryContainer queryContainer)	Get the query container properties
Map<String,Object>	getQueryProperties(Query query)	Get the query properties
Map<String,Object>	getRootProperties()	Get the root container properties
boolean	hasAnyAssignableDescendant(UserIdentity userIdentity, QueryContainer queryContainer)	Check if a folder have descendant in right assignment access for a given user
boolean	hasAnyReadableDescendant(UserIdentity userIdentity, QueryContainer queryContainer)	Check if a folder have a descendant in read access for a given user
Boolean	hasAnyWritableDescendant(UserIdentity userIdentity, QueryContainer queryContainer)	Check if a query container have descendant in write access for a given user
Map<String,Object>	moveQuery(String id, String newParentId)	Moves a Query
Map<String,Object>	moveQueryContainer(String id, String newParentId)	Moves a QueryContainer
boolean	mustWarnBeforeDeletion(List<String> ids)	Determines if application must warn before deleting the given QueryContainers
Map<String,Object>	renameQueryContainer(String id, String newName)	Renames a QueryContainer
Map<String,Object>	saveQuery(String id, String type, String content)	Saves a Query
void	service(ServiceManager serviceManager)
Map<String,Object>	updateQuery(String id, String title, String desc, String documentation)	Edits a Query

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The Avalon role

QUERY_HANDLE_RIGHT_ID

public static final String QUERY_HANDLE_RIGHT_ID

The right id to handle query

See Also:

• Constant Field Values

QUERY_CONTAINER_HANDLE_RIGHT_ID

public static final String QUERY_CONTAINER_HANDLE_RIGHT_ID

The right id to handle query container

See Also:

• Constant Field Values

ROOT_QUERY_CONTAINER_ID

public static final String ROOT_QUERY_CONTAINER_ID

The alias id of the root QueryContainer

See Also:

• Constant Field Values

READ_ACCESS_PROPERTY

public static final String READ_ACCESS_PROPERTY

Propery key for read access

See Also:

• Constant Field Values

WRITE_ACCESS_PROPERTY

public static final String WRITE_ACCESS_PROPERTY

Propery key for write access

See Also:

• Constant Field Values

RENAME_ACCESS_PROPERTY

public static final String RENAME_ACCESS_PROPERTY

Propery key for rename access

See Also:

• Constant Field Values

DELETE_ACCESS_PROPERTY

public static final String DELETE_ACCESS_PROPERTY

Propery key for delete access

See Also:

• Constant Field Values

EDIT_RIGHTS_ACCESS_PROPERTY

public static final String EDIT_RIGHTS_ACCESS_PROPERTY

Propery key for edit rights access

See Also:

• Constant Field Values

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_observationManager

protected ObservationManager _observationManager

The observation manager

Constructor Details

QueryDAO

public QueryDAO()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getQueriesRootNode

public QueryContainer getQueriesRootNode()
                                  throws AmetysRepositoryException

Get the root plugin storage object.

Returns:

the root plugin storage object.

Throws:

AmetysRepositoryException - if a repository error occurs.

getQueriesProperties

public Map<String,Object> getQueriesProperties(List<String> queryIds)

Get queries' properties

Parameters:

queryIds - The ids of queries to retrieve

Returns:

The queries' properties

getQueryProperties

public Map<String,Object> getQueryProperties(Query query)

Get the query properties

Parameters:

query - The query

Returns:

The query properties

getIdsOfPath

public List<String> getIdsOfPath(String queryId)

Gets the ids of the path elements of a query or query container, i.e. the parent ids.
For instance, if the query path is 'a/b/c', then the result list will be ["id-of-a", "id-of-b", "id-of-c"]

Parameters:

queryId - The id of the query

Returns:

the ids of the path elements of a query

getRootProperties

public Map<String,Object> getRootProperties()

Get the root container properties

Returns:

The root container properties

getQueryContainerProperties

public Map<String,Object> getQueryContainerProperties(String id)

Get the query container properties

Parameters:

id - The query container id. Can be ROOT_QUERY_CONTAINER_ID for the root container.

Returns:

The query container properties

getQueryContainerProperties

public Map<String,Object> getQueryContainerProperties(QueryContainer queryContainer)

Get the query container properties

Parameters:

queryContainer - The query container

Returns:

The query container properties

createQuery

public Map<String,Object> createQuery(String title,
 String desc,
 String documentation,
 String type,
 String content,
 String parentId)

Creates a new Query

Parameters:

title - The title of the query

desc - The description of the query

documentation - The documentation of the query

type - The type of the query

content - The content of the query

parentId - The id of the parent of the query. Use ROOT_QUERY_CONTAINER_ID for the root container.

Returns:

A result map

createQueryContainer

public Map<String,Object> createQueryContainer(String parentId,
 String name)

Creates a new QueryContainer

Parameters:

parentId - The id of the parent. Use ROOT_QUERY_CONTAINER_ID for the root container.

name - The desired name for the new QueryContainer

Returns:

A result map

updateQuery

public Map<String,Object> updateQuery(String id,
 String title,
 String desc,
 String documentation)

Edits a Query

Parameters:

id - The id of the query

title - The title of the query

desc - The description of the query

documentation - The documentation of the query

Returns:

A result map

renameQueryContainer

public Map<String,Object> renameQueryContainer(String id,
 String newName)

Renames a QueryContainer

Parameters:

id - The id of the query container

newName - The new name of the container

Returns:

A result map

moveQuery

public Map<String,Object> moveQuery(String id,
 String newParentId)

Moves a Query

Parameters:

id - The id of the query

newParentId - The id of the new parent container of the query. Use ROOT_QUERY_CONTAINER_ID for the root container.

Returns:

A result map

moveQueryContainer

public Map<String,Object> moveQueryContainer(String id,
 String newParentId)

Moves a QueryContainer

Parameters:

id - The id of the query container

newParentId - The id of the new parent container of the query container. Use ROOT_QUERY_CONTAINER_ID for the root container.

Returns:

A result map

saveQuery

public Map<String,Object> saveQuery(String id,
 String type,
 String content)

Saves a Query

Parameters:

id - The id of the query

type - The type of the query

content - The content of the query

Returns:

A result map

deleteQuery

public Map<String,Object> deleteQuery(List<String> ids)

Deletes Query(ies)

Parameters:

ids - The ids of the queries to delete

Returns:

A result map

mustWarnBeforeDeletion

public boolean mustWarnBeforeDeletion(List<String> ids)

Determines if application must warn before deleting the given QueryContainers

Parameters:

ids - The QueryContainer ids

Returns:

true if application must warn

deleteQueryContainer

public Map<String,Object> deleteQueryContainer(List<String> ids)

Deletes QueryContainer(s)

Parameters:

ids - The ids of the query containers to delete

Returns:

A result map

getChildQueriesForAdministrator

public AmetysObjectIterable<Query> getChildQueriesForAdministrator(QueryContainer parent,
 boolean onlyDirect,
 Optional<String> type)

Gets all queries for administrator for given parent

Parameters:

parent - The QueryContainer, defining the context from which getting children

onlyDirect - true in order to have only direct child queries from parent path, false otherwise to have all queries at any level underneath the parent path

type - The query type

Returns:

all queries for administrator for given parent

getChildQueriesInReadAccess

public Stream<Query> getChildQueriesInReadAccess(QueryContainer parent,
 boolean onlyDirect,
 UserIdentity user,
 Optional<String> type)

Gets all queries in READ access for given parent

Parameters:

parent - The QueryContainer, defining the context from which getting children

onlyDirect - true in order to have only direct child queries from parent path, false otherwise to have all queries at any level underneath the parent path

user - The user

type - The query type

Returns:

all queries in READ access for given parent

canRead

public boolean canRead(UserIdentity userIdentity,
 Query query)

Determine if user has read access on a query

Parameters:

userIdentity - the user

query - the query

Returns:

true if the user have read rights on a query

canRead

public boolean canRead(UserIdentity userIdentity,
 QueryContainer queryContainer)

Determines if the user has read access on a query container

Parameters:

userIdentity - the user

queryContainer - the query container

Returns:

true if the user has read access on the query container

getChildQueriesInWriteAccess

public Stream<Query> getChildQueriesInWriteAccess(QueryContainer parent,
 boolean onlyDirect,
 UserIdentity user,
 Optional<String> type)

Gets all queries in WRITE access for given parent

Parameters:

parent - The QueryContainer, defining the context from which getting children

onlyDirect - true in order to have only direct child queries from parent path, false otherwise to have all queries at any level underneath the parent path

user - The user

type - The query type

Returns:

all queries in WRITE access for given parent

canWrite

public boolean canWrite(UserIdentity userIdentity,
 Query query)

Determines if the user has write access on a query

Parameters:

userIdentity - the user

query - the query

Returns:

true if the user has write access on query

canDelete

public boolean canDelete(UserIdentity userIdentity,
 Query query)

Determines if the user can delete a query

Parameters:

userIdentity - the user

query - the query

Returns:

true if the user can delete the query

canRename

public boolean canRename(UserIdentity userIdentity,
 QueryContainer queryContainer)

Determines if the user can rename a query container

Parameters:

userIdentity - the user

queryContainer - the query container

Returns:

true if the user can delete the query

canDelete

public boolean canDelete(UserIdentity userIdentity,
 QueryContainer queryContainer)

Determines if the user can delete a query container

Parameters:

userIdentity - the user

queryContainer - the query container

Returns:

true if the user can delete the query container

_isRoot

protected boolean _isRoot(QueryContainer queryContainer)

Determines if the query container is the root node

Parameters:

queryContainer - the query container

Returns:

true if is root

getChildQueriesInRightAccess

public Stream<Query> getChildQueriesInRightAccess(QueryContainer parent,
 boolean onlyDirect,
 UserIdentity user,
 Optional<String> type)

Gets all queries in WRITE access for given parent

Parameters:

parent - The QueryContainer, defining the context from which getting children

onlyDirect - true in order to have only direct child queries from parent path, false otherwise to have all queries at any level underneath the parent path

user - The user

type - The query type

Returns:

all queries in WRITE access for given parent

canAssignRights

public boolean canAssignRights(UserIdentity userIdentity,
 Query query)

Check if a user can edit rights on a query

Parameters:

userIdentity - the user

query - the query

Returns:

true if the user can edit rights on a query

canCreate

public boolean canCreate(UserIdentity userIdentity,
 QueryContainer queryContainer)

Check if a user has creation rights on a query container

Parameters:

userIdentity - the user identity

queryContainer - the query container

Returns:

true if the user has creation rights on a query container

canWrite

public boolean canWrite(UserIdentity userIdentity,
 QueryContainer queryContainer)

Check if a user has write access on a query container

Parameters:

userIdentity - the user identity

queryContainer - the query container

Returns:

true if the user has write access on the a query container

canWrite

public boolean canWrite(UserIdentity userIdentity,
 QueryContainer queryContainer,
 boolean recursively)

Check if a user has write access on a query container

Parameters:

userIdentity - the user user identity

queryContainer - the query container

recursively - true to check write access on all descendants recursively

Returns:

true if the user has write access on the a query container

canAssignRights

public boolean canAssignRights(UserIdentity userIdentity,
 QueryContainer queryContainer)

Check if a user can edit rights on a query container

Parameters:

userIdentity - the user

queryContainer - the query container

Returns:

true if the user can edit rights on a query

getChildQueryContainers

public AmetysObjectIterable<QueryContainer> getChildQueryContainers(QueryContainer parent)

Gets all query containers for given parent

Parameters:

parent - The QueryContainer, defining the context from which getting children

Returns:

all query containers for given parent

hasAnyReadableDescendant

public boolean hasAnyReadableDescendant(UserIdentity userIdentity,
 QueryContainer queryContainer)

Check if a folder have a descendant in read access for a given user

Parameters:

userIdentity - the user

queryContainer - the query container

Returns:

true if the user have read right for at least one child of this container

hasAnyWritableDescendant

public Boolean hasAnyWritableDescendant(UserIdentity userIdentity,
 QueryContainer queryContainer)

Check if a query container have descendant in write access for a given user

Parameters:

userIdentity - the user identity

queryContainer - the query container

Returns:

true if the user have write right for at least one child of this container

hasAnyAssignableDescendant

public boolean hasAnyAssignableDescendant(UserIdentity userIdentity,
 QueryContainer queryContainer)

Check if a folder have descendant in right assignment access for a given user

Parameters:

userIdentity - the user identity

queryContainer - the query container

Returns:

true if the user have right assignment right for at least one child of this container