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 and Description
private static String	__PLUGIN_NODE_NAME
protected GroupManager	_groupManager The group manager
private AmetysObjectResolver	_resolver The Ametys object resolver
private RightManager	_rightManager
private UserHelper	_userHelper
protected CurrentUserProvider	_userProvider The current user provider
static String	ROLE The Avalon role
static String	ROOT_QUERY_CONTAINER_ID The alias id of the root QueryContainer

Constructor Summary

Constructors

Constructor and Description
QueryDAO()

Method Summary

Modifier and Type	Method and Description
private Map<String,Object>	_assignRights(String queryId, String profileId, String type, List<Map<String,String>> users, List<Map<String,String>> groups)
private boolean	_canDeleteQueryContainer(String id)
private boolean	_containsNotOwnQueries(AmetysObjectIterable<Query> allQueries)
private boolean	_containsSharedQueries(AmetysObjectIterable<Query> allQueries)
private static AmetysObject	_getOrCreateNode(ModifiableTraversableAmetysObject parentNode, String nodeName, String nodeType)
private QueryContainer	_getOrCreateRootNode()
private QueryContainer	_getQueryContainer(String id)
protected boolean	_hasRight(Query query) Test if the current user has the right required to access the query
private void	_move(MovableAmetysObject obj, String newParentId, Map<String,Object> results)
private boolean	_mustWarnBeforeDeletion(String id)
Map<String,Object>	addGrantedGroups(String queryId, String profileId, List<Map<String,String>> groups) Assign rigths to the given groups on the given query
Map<String,Object>	addGrantedUsers(String queryId, String profileId, List<Map<String,String>> users) Assign rights to the given users on the given query
protected boolean	canDeleteAllQueryContainers(List<String> ids) Can the current user delete all the QueryContainers from the list ?
Map<String,Boolean>	canDeleteQueryContainers(List<String> ids) Determines if the current user can delete the given QueryContainers
Map<String,Object>	changeVisibility(String queryId, String visibilityStr) Changes the visibility of a Query
Map<String,Object>	createQuery(String title, String desc, 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
AmetysObjectIterable<Query>	getChildQueriesInReadAccess(QueryContainer parent, boolean onlyDirect, QueryHelper.Visibility visibility, Optional<String> type) Gets all queries in READ access for given parent
AmetysObjectIterable<Query>	getChildQueriesInWriteAccess(QueryContainer parent, boolean onlyDirect, QueryHelper.Visibility visibility, 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(QueryContainer queryContainer) Get the query container properties
Map<String,Object>	getQueryContainerProperties(String id) Get the query container properties
Map<String,Object>	getQueryProperties(Query query) Get the query properties
boolean	hasRightOnContainers() Determines if the current user has right to handle QueryContainers
boolean	isAdministrator() Determines if the current user is administrator of queries
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>	removeAssignment(String queryId, String profileId, List<Map<String,String>> users, List<Map<String,String>> groups) Remove rights to the given users on the given query
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) 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 Detail

ROLE

public static final String ROLE

The Avalon role

ROOT_QUERY_CONTAINER_ID

public static final String ROOT_QUERY_CONTAINER_ID

The alias id of the root QueryContainer

See Also:

Constant Field Values

__PLUGIN_NODE_NAME

private static final String __PLUGIN_NODE_NAME

See Also:

Constant Field Values

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_groupManager

protected GroupManager _groupManager

The group manager

_resolver

private AmetysObjectResolver _resolver

The Ametys object resolver

_userHelper

private UserHelper _userHelper

_rightManager

private RightManager _rightManager

Constructor Detail

QueryDAO

public QueryDAO()

Method Detail

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.

_getOrCreateRootNode

private QueryContainer _getOrCreateRootNode()
                                     throws AmetysRepositoryException

Throws:

AmetysRepositoryException

_getOrCreateNode

private static AmetysObject _getOrCreateNode(ModifiableTraversableAmetysObject parentNode,
                                             String nodeName,
                                             String nodeType)
                                      throws AmetysRepositoryException

Throws:

AmetysRepositoryException

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

hasRightOnContainers

public boolean hasRightOnContainers()

Determines if the current user has right to handle QueryContainers

Returns:

true if the current user has right to handle QueryContainers

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 type,
                                      String content,
                                      String parentId)

Creates a new Query

Parameters:

title - The title of the query

desc - The description 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)

Edits a Query

Parameters:

id - The id of the query

title - The title of the query

desc - The description 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

_move

private void _move(MovableAmetysObject obj,
                   String newParentId,
                   Map<String,Object> results)

_getQueryContainer

private QueryContainer _getQueryContainer(String id)

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

canDeleteAllQueryContainers

protected boolean canDeleteAllQueryContainers(List<String> ids)

Can the current user delete all the QueryContainers from the list ?

Parameters:

ids - The QueryContainer ids

Returns:

true if he can

canDeleteQueryContainers

public Map<String,Boolean> canDeleteQueryContainers(List<String> ids)

Determines if the current user can delete the given QueryContainers

Parameters:

ids - The QueryContainer ids

Returns:

A map with true for each id if the current user can delete the associated QueryContainer

_canDeleteQueryContainer

private boolean _canDeleteQueryContainer(String id)

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

_mustWarnBeforeDeletion

private boolean _mustWarnBeforeDeletion(String id)

_containsNotOwnQueries

private boolean _containsNotOwnQueries(AmetysObjectIterable<Query> allQueries)

_containsSharedQueries

private boolean _containsSharedQueries(AmetysObjectIterable<Query> allQueries)

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

changeVisibility

public Map<String,Object> changeVisibility(String queryId,
                                           String visibilityStr)

Changes the visibility of a Query

Parameters:

queryId - The id of the query

visibilityStr - The new visibility

Returns:

A result map

addGrantedUsers

public Map<String,Object> addGrantedUsers(String queryId,
                                          String profileId,
                                          List<Map<String,String>> users)

Assign rights to the given users on the given query

Parameters:

queryId - The query id

profileId - The profile id

users - The users to grant

Returns:

A result map

addGrantedGroups

public Map<String,Object> addGrantedGroups(String queryId,
                                           String profileId,
                                           List<Map<String,String>> groups)

Assign rigths to the given groups on the given query

Parameters:

queryId - The query id

profileId - The profile id

groups - The groups to grant

Returns:

A result map

_assignRights

private Map<String,Object> _assignRights(String queryId,
                                         String profileId,
                                         String type,
                                         List<Map<String,String>> users,
                                         List<Map<String,String>> groups)

removeAssignment

public Map<String,Object> removeAssignment(String queryId,
                                           String profileId,
                                           List<Map<String,String>> users,
                                           List<Map<String,String>> groups)

Remove rights to the given users on the given query

Parameters:

queryId - The query id

profileId - The profile id

users - The users to remove

groups - The groups to remove

Returns:

A result map

isAdministrator

public boolean isAdministrator()

Determines if the current user is administrator of queries

Returns:

true if current user is administrator

_hasRight

protected boolean _hasRight(Query query)

Test if the current user has the right required to access the query

Parameters:

query - The query

Returns:

true if the user has the right needed, false otherwise.

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 AmetysObjectIterable<Query> getChildQueriesInReadAccess(QueryContainer parent,
                                                               boolean onlyDirect,
                                                               QueryHelper.Visibility visibility,
                                                               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

visibility - The user and its groups for checking visibility

type - The query type

Returns:

all queries in READ access for given parent

getChildQueriesInWriteAccess

public AmetysObjectIterable<Query> getChildQueriesInWriteAccess(QueryContainer parent,
                                                                boolean onlyDirect,
                                                                QueryHelper.Visibility visibility,
                                                                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

visibility - The user and its groups for checking visibility

type - The query type

Returns:

all queries in WRITE access for given parent

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