com.logicaldoc.core.security.dao

Class HibernateFolderDAO

java.lang.Object

com.logicaldoc.core.HibernatePersistentObjectDAO<Folder>

com.logicaldoc.core.security.dao.HibernateFolderDAO

All Implemented Interfaces:

PersistentObjectDAO<Folder>, FolderDAO

public class HibernateFolderDAO
extends HibernatePersistentObjectDAO<Folder>
implements FolderDAO

Hibernate implementation of FolderDAO

Since:

6.0

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields

Modifier and Type	Field and Description
protected LockManager	lockManager

Fields inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

entityClass, log, sessionFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HibernateFolderDAO()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applyMetadataToTree(long id, FolderHistory transaction) Propagates the template metadata a node to the whole subree
boolean	applyRithtToTree(long rootId, FolderHistory transaction) Propagates the security policies of a node to the whole subree
String	computePathExtended(long folderId) Dynamically computes the path extended for the specified folder.
int	count(boolean computeDeleted) Counts the number of folders
Folder	create(Folder parent, Folder folderVO, boolean inheritSecurity, FolderHistory transaction) Creates a new folder in the parent Folder
Folder	createPath(Folder parent, String path, boolean inheritSecurity, FolderHistory transaction) Creates the folder for the specified path.
boolean	delete(long folderId, FolderHistory transaction) This method deletes the folder object and insert a new folder history entry.
void	deleteAll(List<Folder> folders, FolderHistory transaction) For each folder, save the folder delete history entry for each folder and delete the folder
List<Folder>	deleteTree(Folder folder, FolderHistory transaction) Delete a folder and all its sub-folders that a user can delete.
List<Folder>	deleteTree(long folderId, FolderHistory transaction) Delete a folder and all its sub-folders that a user can delete.
List<Folder>	find(String name) Useful method that allows to find all folders that contains the given name into their text.
List<Folder>	findByGroupId(long groupId) Finds all folders accessible by the passed group
List<Folder>	findByName(Folder parent, String name, boolean caseSensitive) Finds all folders by folder text, contained in the parent folder.
List<Folder>	findByName(String name) Finds all folders by folder name
List<Folder>	findByNameAndParentId(String name, long parentId) Finds that folder that lies under a specific parent (given by the id) an with a given name(like operator is used)
List<Folder>	findByParentId(long parentId) Finds all children(direct and indirect) by parentId
Folder	findByPath(String pathExtended) Retrieval of a folder by the extended path
List<Folder>	findByUserId(long userId) Finds authorized folders for a user
List<Folder>	findByUserId(long userId, long parentId) Finds direct children of a folder.
List<Folder>	findChildren(long parentId, Integer max) Finds direct children of a folder
List<Folder>	findChildren(long parentId, long userId) Finds direct children of a folder accessible by the given user
List<Folder>	findDeleted(long userId, Integer maxHits) Finds all deleted folders of a specific user.
Collection<Long>	findFolderIdByUserId(long userId, Long parentId, boolean tree) This method selects only the folder ID from the folders for which a user is authorized.
Collection<Long>	findFolderIdByUserIdAndPermission(long userId, Permission permission, Long parentId, boolean tree) Finds all folders ids with a specific permission enabled on the specifies user
Set<Long>	findFolderIdInTree(long rootId, boolean includeDeleted) Retrieve all the ids of the folder in a given tree
List<Long>	findIdByUserId(long userId, long parentId) This method selects only the folder ID from the folders for which a user is authorized.
List<Folder>	findParents(long folderId) Returns a List of folders being a parent of the given folder.
List<Folder>	findWorkspaces() Retrieves all the workspaces in the system, that are the first-level folders of type 1.
Set<Permission>	getEnabledPermissions(long folderId, long userId) Finds all permissions of a user enabled on the specified folder
FolderHistoryDAO	getHistoryDAO()
UserDAO	getUserDAO()
boolean	hasWriteAccess(Folder folder, long userId) Checks that the user has access to the folder and all its sub-items
void	initialize(Folder folder) Doesn't do anything by default
boolean	isInPath(long folderId, long targetId) Checks if a folder with the given folderId is parent of the folder with the given targetId
boolean	isPermissionEnabled(Permission permission, long folderId, long userId) This method checks if the given permission is enabled for a folder and an user.
boolean	isReadEnable(long folderId, long userId)
boolean	isWriteEnable(long folderId, long userId) This method is looking up for writing rights for a folder and an user.
void	move(Folder source, Folder target, FolderHistory transaction) Move a folder into another folder
void	restore(long folderId, long parentId, FolderHistory transaction) Restores a previously deleted folder
void	setConfig(ContextProperties config)
void	setHistoryDAO(FolderHistoryDAO historyDAO)
void	setLockManager(LockManager lockManager)
void	setUniqueName(Folder folder)
void	setUserDAO(UserDAO userDAO)
boolean	store(Folder folder) This method persists the entity object.
boolean	store(Folder folder, FolderHistory transaction) Same as store(Folder, boolean, FolderHistory)

Methods inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

bulkUpdate, delete, deleteAll, evict, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, flush, getConnection, getCurrentSession, getDbms, getSessionFactory, isHsql, isMySQL, isOracle, isSqlServer, jdbcUpdate, jdbcUpdate, merge, prepareQuery, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet, refresh, saveOrUpdate, setSessionFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO

bulkUpdate, delete, deleteAll, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDbms, jdbcUpdate, jdbcUpdate, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet

Field Detail

lockManager

protected LockManager lockManager

Constructor Detail

HibernateFolderDAO

protected HibernateFolderDAO()

Method Detail

getUserDAO

public UserDAO getUserDAO()

setUserDAO

public void setUserDAO(UserDAO userDAO)

store

public boolean store(Folder folder)

Description copied from interface: PersistentObjectDAO

This method persists the entity object.

Specified by:

store in interface PersistentObjectDAO<Folder>

Overrides:

store in class HibernatePersistentObjectDAO<Folder>

Parameters:

folder - entity to be stored.

Returns:

True if successfully stored in a database.

store

public boolean store(Folder folder,
            FolderHistory transaction)

Description copied from interface: FolderDAO

Same as store(Folder, boolean, FolderHistory)

Specified by:

store in interface FolderDAO

findByUserId

public List<Folder> findByUserId(long userId)

Description copied from interface: FolderDAO

Finds authorized folders for a user

Specified by:

findByUserId in interface FolderDAO

Parameters:

userId - ID of the user

Returns:

List of found folders

findByUserId

public List<Folder> findByUserId(long userId,
                        long parentId)

Description copied from interface: FolderDAO

Finds direct children of a folder.

Specified by:

findByUserId in interface FolderDAO

parentId - ID of the folder which children are wanted

Returns:

List of found folders sorted by text

findChildren

public List<Folder> findChildren(long parentId,
                        Integer max)

Description copied from interface: FolderDAO

Finds direct children of a folder

Specified by:

findChildren in interface FolderDAO

Parameters:

parentId - Folder ID of the folder which children are wanted

max - Optional, maximum number of children

Returns:

List of found folders

findChildren

public List<Folder> findChildren(long parentId,
                        long userId)

Description copied from interface: FolderDAO

Finds direct children of a folder accessible by the given user

Specified by:

findChildren in interface FolderDAO

Parameters:

parentId - Folder ID of the folder which children are wanted

userId - Identifier of the user that must have read access

Returns:

List of found folders

findByParentId

public List<Folder> findByParentId(long parentId)

Description copied from interface: FolderDAO

Finds all children(direct and indirect) by parentId

Specified by:

findByParentId in interface FolderDAO

Returns:

isWriteEnable

public boolean isWriteEnable(long folderId,
                    long userId)

Description copied from interface: FolderDAO

This method is looking up for writing rights for a folder and an user.

Specified by:

isWriteEnable in interface FolderDAO

Parameters:

folderId - ID of the folder

userId - ID of the user

isReadEnable

public boolean isReadEnable(long folderId,
                   long userId)

Specified by:

isReadEnable in interface FolderDAO

findFolderIdByUserId

public Collection<Long> findFolderIdByUserId(long userId,
                                    Long parentId,
                                    boolean tree)

Description copied from interface: FolderDAO

This method selects only the folder ID from the folders for which a user is authorized.

Specified by:

findFolderIdByUserId in interface FolderDAO

Parameters:

userId - ID of the user.

parentId - The id of the parent folder to inspect (optional)

tree - If true, the parentId will be interpreted as the root of a tree

Returns:

List of selected folder ID's.

hasWriteAccess

public boolean hasWriteAccess(Folder folder,
                     long userId)

Description copied from interface: FolderDAO

Checks that the user has access to the folder and all its sub-items

Specified by:

hasWriteAccess in interface FolderDAO

findByGroupId

public List<Folder> findByGroupId(long groupId)

Description copied from interface: FolderDAO

Finds all folders accessible by the passed group

Specified by:

findByGroupId in interface FolderDAO

Parameters:

groupId - The group id

Returns:

The List of folders

findIdByUserId

public List<Long> findIdByUserId(long userId,
                        long parentId)

Description copied from interface: FolderDAO

This method selects only the folder ID from the folders for which a user is authorized. Only folders direct child of the specified parent are returned.

Specified by:

findIdByUserId in interface FolderDAO

Parameters:

userId - ID of the user

parentId - Parent folder

Returns:

List of selected folder ID's.

findByName

public List<Folder> findByName(String name)

Description copied from interface: FolderDAO

Finds all folders by folder name

Specified by:

findByName in interface FolderDAO

Returns:

List of folders with given folder name.

findByName

public List<Folder> findByName(Folder parent,
                      String name,
                      boolean caseSensitive)

Description copied from interface: FolderDAO

Finds all folders by folder text, contained in the parent folder.

Specified by:

findByName in interface FolderDAO

Parameters:

parent - The parent folder(optional)

name - The folder name to search for

Returns:

List of folders with given name

computePathExtended

public String computePathExtended(long folderId)

Description copied from interface: FolderDAO

Dynamically computes the path extended for the specified folder. The path extended is a human readable path in the form: /folder1/folder2/folder3

Specified by:

computePathExtended in interface FolderDAO

Returns:

findByNameAndParentId

public List<Folder> findByNameAndParentId(String name,
                                 long parentId)

Description copied from interface: FolderDAO

Finds that folder that lies under a specific parent (given by the id) an with a given name(like operator is used)

Specified by:

findByNameAndParentId in interface FolderDAO

Returns:

findParents

public List<Folder> findParents(long folderId)

Description copied from interface: FolderDAO

Returns a List of folders being a parent of the given folder. The list is ordered starting from the root of folders. The list doesn't include the given folder.

Specified by:

findParents in interface FolderDAO

isPermissionEnabled

public boolean isPermissionEnabled(Permission permission,
                          long folderId,
                          long userId)

Description copied from interface: FolderDAO

This method checks if the given permission is enabled for a folder and an user.

Specified by:

isPermissionEnabled in interface FolderDAO

Parameters:

permission - the permission to check

folderId - ID of the folder

userId - ID of the user

restore

public void restore(long folderId,
           long parentId,
           FolderHistory transaction)

Description copied from interface: FolderDAO

Restores a previously deleted folder

Specified by:

restore in interface FolderDAO

Parameters:

folderId - The folder identifier

parentId - The parent folder to restore in

transaction - Current session informations

getEnabledPermissions

public Set<Permission> getEnabledPermissions(long folderId,
                                    long userId)

Description copied from interface: FolderDAO

Finds all permissions of a user enabled on the specified folder

Specified by:

getEnabledPermissions in interface FolderDAO

Parameters:

folderId - ID of the folder

userId - ID of the user

Returns:

Collection of enabled permissions

findFolderIdByUserIdAndPermission

public Collection<Long> findFolderIdByUserIdAndPermission(long userId,
                                                 Permission permission,
                                                 Long parentId,
                                                 boolean tree)

Description copied from interface: FolderDAO

Finds all folders ids with a specific permission enabled on the specifies user

Specified by:

findFolderIdByUserIdAndPermission in interface FolderDAO

Parameters:

userId - The user identifier

permission - The permission to check

parentId - The id of the parent folder to inspect (optional)

tree - If true, the parentId will be interpreted as the root of a tree

Returns:

List of selected folder ID's.

getHistoryDAO

public FolderHistoryDAO getHistoryDAO()

setHistoryDAO

public void setHistoryDAO(FolderHistoryDAO historyDAO)

deleteAll

public void deleteAll(List<Folder> folders,
             FolderHistory transaction)

Description copied from interface: FolderDAO

For each folder, save the folder delete history entry for each folder and delete the folder

Specified by:

deleteAll in interface FolderDAO

transaction - entry to log the event on each folder

delete

public boolean delete(long folderId,
             FolderHistory transaction)

Description copied from interface: FolderDAO

This method deletes the folder object and insert a new folder history entry.

Specified by:

delete in interface FolderDAO

Parameters:

folderId - The id of the folder to delete

transaction - entry to log the event

Returns:

True if successfully deleted from the database.

applyRithtToTree

public boolean applyRithtToTree(long rootId,
                       FolderHistory transaction)

Description copied from interface: FolderDAO

Propagates the security policies of a node to the whole subree

Specified by:

applyRithtToTree in interface FolderDAO

applyMetadataToTree

public boolean applyMetadataToTree(long id,
                          FolderHistory transaction)

Description copied from interface: FolderDAO

Propagates the template metadata a node to the whole subree

Specified by:

applyMetadataToTree in interface FolderDAO

create

public Folder create(Folder parent,
            Folder folderVO,
            boolean inheritSecurity,
            FolderHistory transaction)

Description copied from interface: FolderDAO

Creates a new folder in the parent Folder

Specified by:

create in interface FolderDAO

Parameters:

parent - The parent folder

folderVO - The folder's metadata

inheritSecurity - If true the new folder will 'point' to the parent for the security policies.

Returns:

The newly created folder

createPath

public Folder createPath(Folder parent,
                String path,
                boolean inheritSecurity,
                FolderHistory transaction)

Description copied from interface: FolderDAO

Creates the folder for the specified path. All unexisting nodes specified in the path will be created.

Specified by:

createPath in interface FolderDAO

Parameters:

parent - The parent folder

path - The folder path(for example /dog/cat/mouse)

inheritSecurity - If true the new folders will 'point' to the parent for the security policies.

Returns:

The created folder

findByPath

public Folder findByPath(String pathExtended)

Description copied from interface: FolderDAO

Retrieval of a folder by the extended path

Specified by:

findByPath in interface FolderDAO

Returns:

setUniqueName

public void setUniqueName(Folder folder)

Specified by:

setUniqueName in interface FolderDAO

move

public void move(Folder source,
        Folder target,
        FolderHistory transaction)
          throws Exception

Description copied from interface: FolderDAO

Move a folder into another folder

Specified by:

move in interface FolderDAO

Parameters:

source - The folder to move

target - The target folder

transaction - entry to log the event (set the user)

Throws:

Exception

deleteTree

public List<Folder> deleteTree(long folderId,
                      FolderHistory transaction)
                        throws Exception

Description copied from interface: FolderDAO

Delete a folder and all its sub-folders that a user can delete. After recovering of all sub-folders inside the folder, will be canceled all folders for which the user has the delete permission or there isn't an immutable document inside it.

Important: All the contained documents will be deleted

Specified by:

deleteTree in interface FolderDAO

Parameters:

folderId - Folder to delete

transaction - entry to log the event (set the user)

Returns:

List of folders that the user cannot delete(permissions, o immutable documents presents)

Throws:

Exception

deleteTree

public List<Folder> deleteTree(Folder folder,
                      FolderHistory transaction)
                        throws Exception

Description copied from interface: FolderDAO

Delete a folder and all its sub-folders that a user can delete. After recovering of all sub-folders inside the folder, will be canceled all folders for which the user has the delete permission or there isn't an immutable document inside it.

Important: Remember to delete orphaned documents.

Specified by:

deleteTree in interface FolderDAO

Parameters:

folder - Folder to delete

transaction - entry to log the event (set the user)

Returns:

List of folders that the user cannot delete(permissions, o immutable documents presents)

Throws:

Exception

findFolderIdInTree

public Set<Long> findFolderIdInTree(long rootId,
                           boolean includeDeleted)

Description copied from interface: FolderDAO

Retrieve all the ids of the folder in a given tree

Specified by:

findFolderIdInTree in interface FolderDAO

Parameters:

rootId - Root of the folder

includeDeleted - True if the deleted records need to be loaded

Returns:

find

public List<Folder> find(String name)

Description copied from interface: FolderDAO

Useful method that allows to find all folders that contains the given name into their text.

Specified by:

find in interface FolderDAO

Parameters:

name - The name to be found

Returns:

List of folders that contains the given name into their text.

isInPath

public boolean isInPath(long folderId,
               long targetId)

Description copied from interface: FolderDAO

Checks if a folder with the given folderId is parent of the folder with the given targetId

Specified by:

isInPath in interface FolderDAO

Parameters:

folderId - The folder to be checked

targetId - The target folder

Returns:

True if the folder with the given folderId is parent of the folder with the given targetId

count

public int count(boolean computeDeleted)

Description copied from interface: FolderDAO

Counts the number of folders

Specified by:

count in interface FolderDAO

findWorkspaces

public List<Folder> findWorkspaces()

Description copied from interface: FolderDAO

Retrieves all the workspaces in the system, that are the first-level folders of type 1.

Specified by:

findWorkspaces in interface FolderDAO

initialize

public void initialize(Folder folder)

Description copied from class: HibernatePersistentObjectDAO

Doesn't do anything by default

Specified by:

initialize in interface PersistentObjectDAO<Folder>

Specified by:

initialize in interface FolderDAO

Overrides:

initialize in class HibernatePersistentObjectDAO<Folder>

Parameters:

folder - The entity to be initialised

setConfig

public void setConfig(ContextProperties config)

setLockManager

public void setLockManager(LockManager lockManager)

findDeleted

public List<Folder> findDeleted(long userId,
                       Integer maxHits)

Description copied from interface: FolderDAO

Finds all deleted folders of a specific user.

Specified by:

findDeleted in interface FolderDAO

Parameters:

userId - The user that performed the deletion

maxHits - Optional defines the max number of returned hits

Returns:

The folders list ordered by descending lastModified