Package org.ametys.plugins.forms.dao

Class FormDirectoryDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.dao.FormDirectoryDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FormDirectoryDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for manipulating form directories

Field Summary

Fields

Modifier and Type	Field	Description
protected FormDAO	_formDAO	The form DAO
protected ObservationManager	_observationManager	Observer manager.
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected RightManager	_rightManager	The right manager
protected SiteManager	_siteManager	The site manager
protected CurrentUserProvider	_userProvider	The current user provider
static final String	HANDLE_FORM_DIRECTORIES_RIGHT_ID	The right id to handle forms
static final String	ROLE	The Avalon role
static final String	ROOT_FORM_DIRECTORY_ID	The alias id of the root FormDirectory

Constructor Summary

Constructors

Constructor	Description
FormDirectoryDAO()

Method Summary

Modifier and Type	Method	Description
protected UserIdentity	_getCurrentUser()	Provides the current user.
protected Set<String>	_getUserRights(FormDirectory formDirectory)	Get user rights for the given form directory
protected boolean	canDeleteAllFormDirectories(List<String> ids)	Can the current user delete all the FormDirectorys from the list ?
Map<String,Boolean>	canDeleteFormDirectories(List<String> ids)	Determines if the current user can delete the given FormDirectorys
void	checkHandleFormDirectoriesRight(AmetysObject formElement)	Check rights for a form element as ametys object
Map<String,Object>	createFormDirectory(String siteName, String parentId, String name)	Creates a new FormDirectory
Map<String,Object>	deleteFormDirectory(List<String> ids)	Deletes FormDirectory(s)
AmetysObjectIterable<FormDirectory>	getChildFormDirectories(FormDirectory parent)	Gets all form directories for given parent
AmetysObjectIterable<Form>	getChildFormsForAdministrator(FormDirectory parent, boolean onlyDirect)	Gets all forms for administrator for given parent
Stream<Form>	getChildFormsInReadAccess(FormDirectory parent, boolean onlyDirect, UserIdentity user)	Gets all forms in READ access for given parent
Stream<Form>	getChildFormsInRightAccess(FormDirectory parent, boolean onlyDirect, UserIdentity user)	Gets all forms in WRITE access for given parent
Stream<Form>	getChildFormsInWriteAccess(FormDirectory parent, boolean onlyDirect, UserIdentity user)	Gets all forms in WRITE access for given parent
FormDirectory	getFormDirectoriesRootNode(String siteName)	Get the root plugin storage object.
FormDirectory	getFormDirectory(String siteName, String id)	Get form directory with given id
String	getFormDirectoryPath(FormDirectory formDirectory, String separator)	Get the path of a form directory
Map<String,Object>	getFormDirectoryProperties(String siteName, String id)	Get the form directory properties
Map<String,Object>	getFormDirectoryProperties(FormDirectory formDirectory, boolean withRights)	Get the form directory properties
Map<String,Object>	getRootProperties(String siteName)	Get the root directory properties
Boolean	hasAnyAssignableDescendant(UserIdentity userIdentity, FormDirectory formDirectory)	Check if a directory have descendant in right assignment access for a given user
Boolean	hasAnyReadableDescendant(UserIdentity userIdentity, FormDirectory formDirectory)	Check if a directory have a descendant in read access for a given user
Boolean	hasAnyWritableDescendant(UserIdentity userIdentity, FormDirectory formDirectory)	Check if a directory have descendant in write access for a given user
boolean	hasReadRightOnFormDirectory(UserIdentity userIdentity, FormDirectory directory)	Check if a user have read rights on a form directory
boolean	hasRightAffectationRightOnFormDirectory(UserIdentity userIdentity, FormDirectory formDirectory)	Check if a user have write rights on a form directory
boolean	hasWriteRightOnFormAndParent(UserIdentity userIdentity, Form form, FormDirectory formDirectory)	Check if a user have write rights on a form
boolean	hasWriteRightOnFormDirectory(UserIdentity userIdentity, FormDirectory formDirectory)	Check if a user have write rights on a form directory
boolean	isRoot(FormDirectory formDirectory)	Determines if the form directory is the root directory
void	move(MovableAmetysObject obj, String siteName, String newParentId, Map<String,Object> results)	Moves a FormDirectory or a Form
Map<String,Object>	moveFormDirectory(String siteName, String id, String newParentId)	Moves a FormDirectory
boolean	mustWarnBeforeDeletion(List<String> ids)	Determines if application must warn before deleting the given FormDirectorys
Map<String,Object>	renameFormDirectory(String id, String newName)	Renames a FormDirectory
void	service(ServiceManager manager)

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

ROOT_FORM_DIRECTORY_ID

public static final String ROOT_FORM_DIRECTORY_ID

The alias id of the root FormDirectory

See Also:

• Constant Field Values

HANDLE_FORM_DIRECTORIES_RIGHT_ID

public static final String HANDLE_FORM_DIRECTORIES_RIGHT_ID

The right id to handle forms

See Also:

• Constant Field Values

_observationManager

protected ObservationManager _observationManager

Observer manager.

_siteManager

protected SiteManager _siteManager

The site manager

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_rightManager

protected RightManager _rightManager

The right manager

_formDAO

protected FormDAO _formDAO

The form DAO

Constructor Details

FormDirectoryDAO

public FormDirectoryDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

hasWriteRightOnFormDirectory

public boolean hasWriteRightOnFormDirectory(UserIdentity userIdentity,
 FormDirectory formDirectory)

Check if a user have write rights on a form directory

Parameters:

userIdentity - the user

formDirectory - the form directory

Returns:

true if the user have write rights on a form directory

checkHandleFormDirectoriesRight

public void checkHandleFormDirectoriesRight(AmetysObject formElement)

Check rights for a form element as ametys object

Parameters:

formElement - the form element as ametys object

getFormDirectoriesRootNode

public FormDirectory getFormDirectoriesRootNode(String siteName)
                                         throws AmetysRepositoryException

Get the root plugin storage object.

Parameters:

siteName - the site's name

Returns:

the root plugin storage object.

Throws:

AmetysRepositoryException - if a repository error occurs.

getRootProperties

public Map<String,Object> getRootProperties(String siteName)

Get the root directory properties

Parameters:

siteName - the site's name

Returns:

The root directory properties

getFormDirectoryProperties

public Map<String,Object> getFormDirectoryProperties(String siteName,
 String id)

Get the form directory properties

Parameters:

siteName - the site's name

id - The form directory id. Can be ROOT_FORM_DIRECTORY_ID for the root directory.

Returns:

The form directory properties

getFormDirectoryProperties

public Map<String,Object> getFormDirectoryProperties(FormDirectory formDirectory,
 boolean withRights)

Get the form directory properties

Parameters:

formDirectory - The form directory

withRights - true to add rights to the properties

Returns:

The form directory properties

_getUserRights

protected Set<String> _getUserRights(FormDirectory formDirectory)

Get user rights for the given form directory

Parameters:

formDirectory - the form directory

Returns:

the set of rights

getFormDirectory

public FormDirectory getFormDirectory(String siteName,
 String id)

Get form directory with given id

Parameters:

siteName - the site name where to search in jcr

id - the directory id

Returns:

the form directory having given id

getFormDirectoryPath

public String getFormDirectoryPath(FormDirectory formDirectory,
 String separator)

Get the path of a form directory

Parameters:

formDirectory - the form directory

separator - the seperator to use from path

Returns:

the path in form's directory

isRoot

public boolean isRoot(FormDirectory formDirectory)

Determines if the form directory is the root directory

Parameters:

formDirectory - the form directory. Cannot be null.

Returns:

true if is the root directory

createFormDirectory

public Map<String,Object> createFormDirectory(String siteName,
 String parentId,
 String name)

Creates a new FormDirectory

Parameters:

siteName - the site's name

parentId - The id of the parent. Use ROOT_FORM_DIRECTORY_ID for the root directory.

name - The desired name for the new FormDirectory

Returns:

A result map

renameFormDirectory

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

Renames a FormDirectory

Parameters:

id - The id of the form directory

newName - The new name of the directory

Returns:

A result map

deleteFormDirectory

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

Deletes FormDirectory(s)

Parameters:

ids - The ids of the form directories to delete

Returns:

A result map

moveFormDirectory

public Map<String,Object> moveFormDirectory(String siteName,
 String id,
 String newParentId)

Moves a FormDirectory

Parameters:

siteName - name of the site

id - The id of the form directory

newParentId - The id of the new parent directory of the form directory. Use ROOT_FORM_DIRECTORY_ID for the root directory.

Returns:

A result map

move

public void move(MovableAmetysObject obj,
 String siteName,
 String newParentId,
 Map<String,Object> results)

Moves a FormDirectory or a Form

Parameters:

obj - form or directory to move

siteName - name of the site

newParentId - id of directory where to drop obj

results - a result map

mustWarnBeforeDeletion

public boolean mustWarnBeforeDeletion(List<String> ids)

Determines if application must warn before deleting the given FormDirectorys

Parameters:

ids - The FormDirectory ids

Returns:

true if application must warn

canDeleteAllFormDirectories

protected boolean canDeleteAllFormDirectories(List<String> ids)

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

Parameters:

ids - The FormDirectory ids

Returns:

true if he can

canDeleteFormDirectories

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

Determines if the current user can delete the given FormDirectorys

Parameters:

ids - The FormDirectory ids

Returns:

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

hasWriteRightOnFormAndParent

public boolean hasWriteRightOnFormAndParent(UserIdentity userIdentity,
 Form form,
 FormDirectory formDirectory)

Check if a user have write rights on a form

Parameters:

userIdentity - the user

form - the source for the form

formDirectory - the form directory

Returns:

true if the user have write rights on a form

getChildFormsInWriteAccess

public Stream<Form> getChildFormsInWriteAccess(FormDirectory parent,
 boolean onlyDirect,
 UserIdentity user)

Gets all forms in WRITE access for given parent

Parameters:

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

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

user - The user

Returns:

all forms in WRITE access for given parent

getChildFormsInRightAccess

public Stream<Form> getChildFormsInRightAccess(FormDirectory parent,
 boolean onlyDirect,
 UserIdentity user)

Gets all forms in WRITE access for given parent

Parameters:

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

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

user - The user

Returns:

all forms in WRITE access for given parent

getChildFormsInReadAccess

public Stream<Form> getChildFormsInReadAccess(FormDirectory parent,
 boolean onlyDirect,
 UserIdentity user)

Gets all forms in READ access for given parent

Parameters:

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

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

user - The user

Returns:

all forms in READ access for given parent

getChildFormsForAdministrator

public AmetysObjectIterable<Form> getChildFormsForAdministrator(FormDirectory parent,
 boolean onlyDirect)

Gets all forms for administrator for given parent

Parameters:

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

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

Returns:

all forms for administrator for given parent

getChildFormDirectories

public AmetysObjectIterable<FormDirectory> getChildFormDirectories(FormDirectory parent)

Gets all form directories for given parent

Parameters:

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

Returns:

all form directories for given parent

_getCurrentUser

protected UserIdentity _getCurrentUser()

Provides the current user.

Returns:

the user which cannot be null.

hasRightAffectationRightOnFormDirectory

public boolean hasRightAffectationRightOnFormDirectory(UserIdentity userIdentity,
 FormDirectory formDirectory)

Check if a user have write rights on a form directory

Parameters:

userIdentity - the user

formDirectory - the form directory

Returns:

true if the user have write rights on a form

hasReadRightOnFormDirectory

public boolean hasReadRightOnFormDirectory(UserIdentity userIdentity,
 FormDirectory directory)

Check if a user have read rights on a form directory

Parameters:

userIdentity - the user

directory - the form directory

Returns:

true if the user have read rights on a form directory

hasAnyReadableDescendant

public Boolean hasAnyReadableDescendant(UserIdentity userIdentity,
 FormDirectory formDirectory)

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

Parameters:

userIdentity - the user

formDirectory - the form directory

Returns:

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

hasAnyWritableDescendant

public Boolean hasAnyWritableDescendant(UserIdentity userIdentity,
 FormDirectory formDirectory)

Check if a directory have descendant in write access for a given user

Parameters:

userIdentity - the user

formDirectory - the form directory

Returns:

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

hasAnyAssignableDescendant

public Boolean hasAnyAssignableDescendant(UserIdentity userIdentity,
 FormDirectory formDirectory)

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

Parameters:

userIdentity - the user

formDirectory - the form directory

Returns:

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