com.logicaldoc.core.security.dao

Class HibernateMenuDAO

java.lang.Object

com.logicaldoc.core.HibernatePersistentObjectDAO<Menu>

com.logicaldoc.core.security.dao.HibernateMenuDAO

All Implemented Interfaces:

PersistentObjectDAO<Menu>, MenuDAO

public class HibernateMenuDAO
extends HibernatePersistentObjectDAO<Menu>
implements MenuDAO

Hibernate implementation of MenuDAO

Since:

3.0

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

entityClass, log, sessionFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HibernateMenuDAO()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applyRithtToTree(long id) Propagates the security policies of a node to the whole subree
String	computePathExtended(long menuId) Dynamically computes the path extended for the specified menu.
boolean	delete(long menuId) This method deletes an entity.
void	deleteAll(List<Menu> menus) For each menu, save the folder delete history entry for each folder and delete the folder
List<Menu>	findByGroupId(long groupId) Finds all menus accessible by the passed group
List<Menu>	findByParentId(long parentId) Finds all children(direct and indirect) by parentId
List<Menu>	findByText(Menu parent, String text, boolean caseSensitive) Finds all menus by menu text, contained in the parent menu
List<Menu>	findByText(String text) Finds all menus by menu text.
List<Menu>	findByTextAndParentId(String text, long parentId) Finds that folder that lies under a specific parent (given by the id) an with a given text(like operator is used)
List<Menu>	findByUserId(long userId) Finds authorized menus for a user.
List<Menu>	findByUserId(long userId, long parentId) Finds direct children of a menu.
List<Menu>	findByUserId(long userId, long parentId, Integer type)
List<Menu>	findChildren(long parentId, Integer max) Finds direct children of a menu.
List<Menu>	findChildren(long parentId, long userId) Finds direct children of a menu accessible by the given user.
List<Long>	findIdByUserId(long userId, long parentId) This method selects only the menuId from the menus for which a user is authorized.
List<Long>	findIdByUserId(long userId, long parentId, Integer type)
List<Long>	findMenuIdByUserId(long userId) This method selects only the menuId from the menus for which a user is authorized.
List<Long>	findMenuIdByUserIdAndPermission(long userId, Permission permission) Finds all menus ids with a specific permission enabled on the specifies user
List<Menu>	findParents(long menuId) Returns a List of menus being a parent of the given menu.
String	findTextById(long menuId) This method selects only the menu text from a menu.
UserDAO	getUserDAO()
boolean	hasWriteAccess(Menu menu, long userId) Checks that the user has access to the menu and all its sub-items
int	isMenuWriteable(long menuId, long userId) Returns if a menu is writeable for a user
boolean	isReadEnable(long menuId, long userId)
boolean	isWriteEnable(long menuId, long userId) This method is looking up for writing rights for a menu and an user.
void	restore(long menuId, boolean parents) Restores a previously deleted menu
void	setUserDAO(UserDAO userDAO)
boolean	store(Menu menu) This method persists the entity object.

Methods inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

bulkUpdate, deleteAll, evict, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, flush, getConnection, getCurrentSession, getDbms, getSessionFactory, initialize, 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, deleteAll, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDbms, initialize, jdbcUpdate, jdbcUpdate, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet

Constructor Detail

HibernateMenuDAO

protected HibernateMenuDAO()

Method Detail

getUserDAO

public UserDAO getUserDAO()

setUserDAO

public void setUserDAO(UserDAO userDAO)

store

public boolean store(Menu menu)

Description copied from interface: PersistentObjectDAO

This method persists the entity object.

Specified by:

store in interface PersistentObjectDAO<Menu>

Specified by:

store in interface MenuDAO

Overrides:

store in class HibernatePersistentObjectDAO<Menu>

Parameters:

menu - entity to be stored.

Returns:

True if successfully stored in a database.

findByUserId

public List<Menu> findByUserId(long userId)

Description copied from interface: MenuDAO

Finds authorized menus for a user.

Specified by:

findByUserId in interface MenuDAO

Parameters:

userId - ID of the user.

Returns:

List of found menus.

findByUserId

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

Description copied from interface: MenuDAO

Finds direct children of a menu.

Specified by:

findByUserId in interface MenuDAO

parentId - MenuId of the menu which children are wanted.

Returns:

List of found menus sorted by text

findByUserId

public List<Menu> findByUserId(long userId,
                      long parentId,
                      Integer type)

findChildren

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

Description copied from interface: MenuDAO

Finds direct children of a menu.

Specified by:

findChildren in interface MenuDAO

Parameters:

parentId - MenuId of the menu which children are wanted

max - Optional, maximum number of children

Returns:

List of found menus

findChildren

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

Description copied from interface: MenuDAO

Finds direct children of a menu accessible by the given user.

Specified by:

findChildren in interface MenuDAO

Parameters:

parentId - MenuId of the menu which children are wanted

userId - Identifier of the user that mush have read access

Returns:

List of found menus.

findByParentId

public List<Menu> findByParentId(long parentId)

Description copied from interface: MenuDAO

Finds all children(direct and indirect) by parentId

Specified by:

findByParentId in interface MenuDAO

Returns:

See Also:

MenuDAO.findByParentId(long)

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 interface MenuDAO

Parameters:

menuId - ID of the menu.

userId - ID of the user.

isReadEnable

public boolean isReadEnable(long menuId,
                   long userId)

Specified by:

isReadEnable in interface MenuDAO

findTextById

public String findTextById(long menuId)

Description copied from interface: MenuDAO

This method selects only the menu text from a menu.

Specified by:

findTextById in interface MenuDAO

Parameters:

menuId - Id of the menu.

Returns:

Selected menu text.

findMenuIdByUserId

public List<Long> findMenuIdByUserId(long userId)

Description copied from interface: MenuDAO

This method selects only the menuId from the menus for which a user is authorized.

Specified by:

findMenuIdByUserId in interface MenuDAO

Parameters:

userId - ID of the user.

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 interface MenuDAO

Parameters:

menuId - check this menu

userId - privileges for this should be checked

Returns:

a 0 if false, a 1 if true

See Also:

MenuDAO.isMenuWriteable(long, long)

hasWriteAccess

public boolean hasWriteAccess(Menu menu,
                     long userId)

Description copied from interface: MenuDAO

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

Specified by:

hasWriteAccess in interface MenuDAO

findByGroupId

public List<Menu> findByGroupId(long groupId)

Description copied from interface: MenuDAO

Finds all menus accessible by the passed group

Specified by:

findByGroupId in interface MenuDAO

Parameters:

groupId - The group id

Returns:

The List of menus

findIdByUserId

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

findByText

public List<Menu> findByText(String text)

Description copied from interface: MenuDAO

Finds all menus by menu text.

Specified by:

findByText in interface MenuDAO

Returns:

List of menus with given menu text.

findByText

public List<Menu> findByText(Menu parent,
                    String text,
                    boolean caseSensitive)

Description copied from interface: MenuDAO

Finds all menus by menu text, contained in the parent menu

Specified by:

findByText in interface MenuDAO

Parameters:

parent - The parent menu(optional)

text - The menutext to search for

Returns:

List of menus with given menu text.

computePathExtended

public String computePathExtended(long menuId)

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: /folder1/folder2/folder3

Specified by:

computePathExtended in interface MenuDAO

Returns:

findByTextAndParentId

public List<Menu> findByTextAndParentId(String text,
                               long parentId)

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:

findByTextAndParentId in interface MenuDAO

Returns:

findParents

public List<Menu> findParents(long menuId)

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 interface MenuDAO

restore

public void restore(long menuId,
           boolean parents)

Description copied from interface: MenuDAO

Restores a previously deleted menu

Specified by:

restore in interface MenuDAO

Parameters:

menuId - The menu identifier

parents - true if parents must be restored also

findMenuIdByUserIdAndPermission

public List<Long> findMenuIdByUserIdAndPermission(long userId,
                                         Permission permission)

Description copied from interface: MenuDAO

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

Specified by:

findMenuIdByUserIdAndPermission in interface MenuDAO

Parameters:

userId - The user identifier

permission - The permission to check

Returns:

deleteAll

public void deleteAll(List<Menu> menus)

Description copied from interface: MenuDAO

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

Specified by:

deleteAll in interface MenuDAO

delete

public boolean delete(long menuId)

Description copied from interface: PersistentObjectDAO

This method deletes an entity.

Specified by:

delete in interface PersistentObjectDAO<Menu>

Overrides:

delete in class HibernatePersistentObjectDAO<Menu>

Parameters:

menuId - ID of the entity which should be deleted.

applyRithtToTree

public boolean applyRithtToTree(long id)

Description copied from interface: MenuDAO

Propagates the security policies of a node to the whole subree

Specified by:

applyRithtToTree in interface MenuDAO

findIdByUserId

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

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 interface MenuDAO

Parameters:

userId - ID of the user.

parentId - Parent menu

Returns:

List of selected menuId's.