Class HibernateMenuDAO
java.lang.Object
com.logicaldoc.core.HibernatePersistentObjectDAO<Menu>
com.logicaldoc.core.security.menu.HibernateMenuDAO
- All Implemented Interfaces:
PersistentObjectDAO<Menu>
,MenuDAO
Hibernate implementation of
MenuDAO
- Since:
- 3.0
- Author:
- Marco Meschieri - LogicalDOC
-
Field Summary
Fields inherited from interface com.logicaldoc.core.PersistentObjectDAO
ENTITY
-
Method Summary
Modifier and TypeMethodDescriptioncomputePathExtended
(long menuId) Dynamically computes the path extended for the specified menu.createPath
(long parentId, long tenantId, int type, String path, boolean inheritSecurity) Creates the menu for the specified path.void
delete
(long menuId, int code) This method deletes an entity and you can give a deletion codevoid
deleteAll
(Collection<Menu> menus) Deletes all entries form the databasefindByGroupId
(long groupId) Finds all menus accessible by the passed groupfindByName
(Menu parent, String name, boolean caseSensitive) Finds all menus by menu text, contained in the parent menufindByName
(String name) Finds all menus by menu text.findByNameAndParentId
(String name, long parentId) Finds that folder that lies under a specific parent (given by the id) an with a given text(like operator is used)findByParentId
(long parentId, boolean enaledOnly) Finds all children(direct and indirect) by parentIdfindByUserId
(long userId) Finds authorized menus for a user.findByUserId
(long userId, long parentId, boolean enabledOnly) Finds direct children of a menufindByUserId
(long userId, long parentId, Integer type, boolean enabledOnly) findChildren
(long parentId, long userId) Finds direct children of a menu accessible by the given user.findChildren
(long parentId, Integer max) Finds direct children of a menu.findIdByUserId
(long userId, long parentId) This method selects only the menuId from the menus for which a user is authorized.findIdByUserId
(long userId, long parentId, Integer type) findMenuIdByUserId
(long userId, boolean enabledOnly) This method selects only the menuId from the menus for which a user is authorizedfindMenuIdByUserIdAndPermission
(long userId, Permission permission, boolean enabledOnly) Finds all menus ids with a specific permission enabled on the specifies userfindNameById
(long menuId) This method selects only the menu text from a menufindParents
(long menuId) Returns a List of menus being a parent of the given menu.boolean
hasWriteAccess
(Menu menu, long userId) Checks that the user has access to the menu and all its sub-itemsint
isMenuWriteable
(long menuId, long userId) Returns if a menu is writeable for a userboolean
isReadEnable
(long menuId, long userId) This method is looking up for read rights for a menu and an userboolean
isWriteEnable
(long menuId, long userId) This method is looking up for writing rights for a menu and an uservoid
restore
(long menuId, boolean parents) Restores a previously deleted menuvoid
setUserDAO
(UserDAO userDAO) void
This method persists the entity objectMethods inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO
bulkUpdate, delete, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDatabaseMetadata, getDbms, getSessionFactory, initialize, isOracle, jdbcUpdate, jdbcUpdate, query, query, queryForDouble, queryForDouble, queryForInt, queryForList, queryForList, queryForList, queryForLong, queryForLong, queryForObject, queryForRowSet, queryForRowSet, queryForString, setSessionFactory
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO
bulkUpdate, delete, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDatabaseMetadata, getDbms, initialize, isOracle, jdbcUpdate, jdbcUpdate, query, query, queryForDouble, queryForDouble, queryForInt, queryForList, queryForList, queryForList, queryForLong, queryForLong, queryForObject, queryForRowSet, queryForRowSet, queryForString
-
Method Details
-
getUserDAO
-
setUserDAO
-
findByUserId
Description copied from interface:MenuDAO
Finds authorized menus for a user.- Specified by:
findByUserId
in interfaceMenuDAO
- Parameters:
userId
- ID of the user.- Returns:
- List of found menus.
-
findByUserId
Description copied from interface:MenuDAO
Finds direct children of a menu- Specified by:
findByUserId
in interfaceMenuDAO
- Parameters:
userId
- identifier of the userparentId
- MenuId of the menu which children are wantedenabledOnly
- if the menus must also be enabled- Returns:
- List of found menus sorted by name
-
findByUserId
-
findChildren
Description copied from interface:MenuDAO
Finds direct children of a menu.- Specified by:
findChildren
in interfaceMenuDAO
- Parameters:
parentId
- MenuId of the menu which children are wantedmax
- Optional, maximum number of children- Returns:
- List of found menus
-
findChildren
Description copied from interface:MenuDAO
Finds direct children of a menu accessible by the given user.- Specified by:
findChildren
in interfaceMenuDAO
- Parameters:
parentId
- MenuId of the menu which children are wanteduserId
- Identifier of the user that mush have read access- Returns:
- List of found menus.
-
findByParentId
Description copied from interface:MenuDAO
Finds all children(direct and indirect) by parentId- Specified by:
findByParentId
in interfaceMenuDAO
- Parameters:
parentId
- identifier of the parent menuenaledOnly
- if the menus must also be enabled- Returns:
- list of children menus
-
isWriteEnable
public boolean isWriteEnable(long menuId, long userId) Description copied from interface:MenuDAO
This method is looking up for writing rights for a menu and an user- Specified by:
isWriteEnable
in interfaceMenuDAO
- Parameters:
menuId
- ID of the menuuserId
- ID of the user- Returns:
- id the user has write permission
-
isReadEnable
public boolean isReadEnable(long menuId, long userId) Description copied from interface:MenuDAO
This method is looking up for read rights for a menu and an user- Specified by:
isReadEnable
in interfaceMenuDAO
- Parameters:
menuId
- ID of the menuuserId
- ID of the user- Returns:
- if the user can access the menu
-
findNameById
Description copied from interface:MenuDAO
This method selects only the menu text from a menu- Specified by:
findNameById
in interfaceMenuDAO
- Parameters:
menuId
- Id of the menu- Returns:
- Selected menu text
-
findMenuIdByUserId
Description copied from interface:MenuDAO
This method selects only the menuId from the menus for which a user is authorized- Specified by:
findMenuIdByUserId
in interfaceMenuDAO
- Parameters:
userId
- ID of the userenabledOnly
- if the menus must also be enabled- Returns:
- List of selected menuId's
-
isMenuWriteable
public int isMenuWriteable(long menuId, long userId) Description copied from interface:MenuDAO
Returns if a menu is writeable for a user- Specified by:
isMenuWriteable
in interfaceMenuDAO
- Parameters:
menuId
- check this menuuserId
- privileges for this should be checked- Returns:
- a 0 if false, a 1 if true
- See Also:
-
findByGroupId
Description copied from interface:MenuDAO
Finds all menus accessible by the passed group- Specified by:
findByGroupId
in interfaceMenuDAO
- Parameters:
groupId
- The group id- Returns:
- The List of menus
- Throws:
PersistenceException
- Error in the database
-
findIdByUserId
-
findByName
Description copied from interface:MenuDAO
Finds all menus by menu text.- Specified by:
findByName
in interfaceMenuDAO
- Parameters:
name
- name of the menu- Returns:
- List of menus with given menu text.
-
computePathExtended
Description copied from interface:MenuDAO
Dynamically computes the path extended for the specified menu. The path extended is a human readable path in the form: /menu1/menu2/menu3- Specified by:
computePathExtended
in interfaceMenuDAO
- Parameters:
menuId
- identifier of the menu- Returns:
- full path of the menu
-
findByNameAndParentId
Description copied from interface:MenuDAO
Finds that folder that lies under a specific parent (given by the id) an with a given text(like operator is used)- Specified by:
findByNameAndParentId
in interfaceMenuDAO
- Parameters:
name
- name of the menuparentId
- identifier of the parent menu- Returns:
- list of manues
-
findParents
Description copied from interface:MenuDAO
Returns a List of menus being a parent of the given menu. The list is ordered starting from the root of menus.- Specified by:
findParents
in interfaceMenuDAO
- Parameters:
menuId
- identifier of the group- Returns:
- hierarchy of parents
-
restore
Description copied from interface:MenuDAO
Restores a previously deleted menu- Specified by:
restore
in interfaceMenuDAO
- Parameters:
menuId
- The menu identifierparents
- true if parents must be restored also- Throws:
PersistenceException
- is happened a database error
-
findMenuIdByUserIdAndPermission
public List<Long> findMenuIdByUserIdAndPermission(long userId, Permission permission, boolean enabledOnly) Description copied from interface:MenuDAO
Finds all menus ids with a specific permission enabled on the specifies user- Specified by:
findMenuIdByUserIdAndPermission
in interfaceMenuDAO
- Parameters:
userId
- The user identifierpermission
- The permission to checkenabledOnly
- if the menus must also be enabled- Returns:
- list of folder IDs
-
deleteAll
Description copied from interface:PersistentObjectDAO
Deletes all entries form the database- Specified by:
deleteAll
in interfacePersistentObjectDAO<Menu>
- Overrides:
deleteAll
in classHibernatePersistentObjectDAO<Menu>
- Parameters:
menus
- The entities to be deleted- Throws:
PersistenceException
- raised in case of errors in the database
-
delete
Description copied from interface:PersistentObjectDAO
This method deletes an entity and you can give a deletion code- Specified by:
delete
in interfacePersistentObjectDAO<Menu>
- Overrides:
delete
in classHibernatePersistentObjectDAO<Menu>
- Parameters:
menuId
- ID of the entity which should be deletedcode
- Deletion code- Throws:
PersistenceException
- raised in case of errors in the database
-
findIdByUserId
Description copied from interface:MenuDAO
This method selects only the menuId from the menus for which a user is authorized. Only menus direct child of the specified parent are returned.- Specified by:
findIdByUserId
in interfaceMenuDAO
- Parameters:
userId
- ID of the user.parentId
- Parent menu- Returns:
- List of selected menuId's.
-
createPath
public Menu createPath(long parentId, long tenantId, int type, String path, boolean inheritSecurity) throws PersistenceException Description copied from interface:MenuDAO
Creates the menu for the specified path. All unexisting nodes specified in the path will be created.- Specified by:
createPath
in interfaceMenuDAO
- Parameters:
parentId
- Identifier of the parent menutenantId
- Identifier of the tenant that will own the new menutype
- The type of the created menuspath
- The folder path(for example /dog/cat/mouse)inheritSecurity
- If true the new menus will 'point' to the parent for the security policies.- Returns:
- The created folder
- Throws:
PersistenceException
- error at data layer
-