org.opencms.security

Class CmsOrgUnitManager

java.lang.Object

org.opencms.security.CmsOrgUnitManager

public class CmsOrgUnitManager
extends java.lang.Object

This manager provide access to the organizational unit related operations.

Since:

6.5.6

Constructor Summary

Constructors

Constructor and Description
CmsOrgUnitManager(CmsSecurityManager securityManager) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addResourceToOrgUnit(CmsObject cms, java.lang.String ouFqn, java.lang.String resourceName) Adds a resource to the given organizational unit.
long	countUsers(CmsObject cms, CmsUserSearchParameters params) Counts the users which fit the given search criteria.
CmsOrganizationalUnit	createOrganizationalUnit(CmsObject cms, java.lang.String ouFqn, java.lang.String description, int flags, java.lang.String resourceName) Creates a new organizational unit.
void	deleteOrganizationalUnit(CmsObject cms, java.lang.String ouFqn) Deletes an organizational unit.
java.util.List<CmsProject>	getAllAccessibleProjects(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all accessible projects of the given organizational unit.
java.util.List<CmsProject>	getAllManageableProjects(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all manageable projects of the given organizational unit.
java.util.List<CmsGroup>	getGroups(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all groups of the given organizational unit.
java.util.List<CmsOrganizationalUnit>	getOrganizationalUnits(CmsObject cms, java.lang.String ouFqn, boolean includeChildren) Returns all child organizational units of the given parent organizational unit including hierarchical deeper organization units if needed.
java.util.List<CmsResource>	getResourcesForOrganizationalUnit(CmsObject cms, java.lang.String ouFqn) Returns all resources of the given organizational unit.
java.util.List<CmsUser>	getUsers(CmsObject cms, java.lang.String ouFqn, boolean recursive) Returns all users of the given organizational unit.
java.util.List<CmsUser>	getUsersWithoutAdditionalInfo(CmsObject cms, java.lang.String ouFqn, boolean recursive) Returns all users of the given organizational unit, without their additional info.
void	initialize(CmsObject cms) Initializes the organizational units.
CmsOrganizationalUnit	readOrganizationalUnit(CmsObject cms, java.lang.String ouFqn) Reads an organizational Unit based on its fully qualified name.
void	removeResourceFromOrgUnit(CmsObject cms, java.lang.String ouFqn, java.lang.String resourceName) Removes a resource from the given organizational unit.
java.util.List<CmsUser>	searchUsers(CmsObject cms, CmsUserSearchParameters params) Searches users which fit the given search parameters.
void	setUsersOrganizationalUnit(CmsObject cms, java.lang.String ouFqn, java.lang.String userName) Moves an user to the given organizational unit.
void	writeOrganizationalUnit(CmsObject cms, CmsOrganizationalUnit organizationalUnit) Writes an already existing organizational unit.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsOrgUnitManager

public CmsOrgUnitManager(CmsSecurityManager securityManager)

Default constructor.

Parameters:

securityManager - the security manager

Method Detail

addResourceToOrgUnit

public void addResourceToOrgUnit(CmsObject cms,
                                 java.lang.String ouFqn,
                                 java.lang.String resourceName)
                          throws CmsException

Adds a resource to the given organizational unit.

Parameters:

cms - the opencms context

ouFqn - the full qualified name of the organizational unit to add the resource to

resourceName - the name of the resource that is to be added to the organizational unit

Throws:

CmsException - if something goes wrong

countUsers

public long countUsers(CmsObject cms,
                       CmsUserSearchParameters params)
                throws CmsException

Counts the users which fit the given search criteria.

Parameters:

cms - the current CMS context

params - the user search parameters

Returns:

the total number of users which fit the given search parameters

Throws:

CmsException - if something goes wrong

createOrganizationalUnit

public CmsOrganizationalUnit createOrganizationalUnit(CmsObject cms,
                                                      java.lang.String ouFqn,
                                                      java.lang.String description,
                                                      int flags,
                                                      java.lang.String resourceName)
                                               throws CmsException

Creates a new organizational unit.

The parent structure must exist.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the new organizational unit

description - the description of the new organizational unit

flags - the flags for the new organizational unit

resourceName - the first associated resource

Returns:

a CmsOrganizationalUnit object representing the newly created organizational unit

Throws:

CmsException - if operation was not successful

deleteOrganizationalUnit

public void deleteOrganizationalUnit(CmsObject cms,
                                     java.lang.String ouFqn)
                              throws CmsException

Deletes an organizational unit.

Only organizational units that contain no sub units can be deleted.

The organizational unit can not be delete if it is used in the request context, or if the current user belongs to it.

All users and groups in the given organizational unit will be deleted.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational unit to delete

Throws:

CmsException - if operation was not successful

getAllAccessibleProjects

public java.util.List<CmsProject> getAllAccessibleProjects(CmsObject cms,
                                                           java.lang.String ouFqn,
                                                           boolean includeSubOus)
                                                    throws CmsException

Returns all accessible projects of the given organizational unit. That is all projects which are owned by the current user or which are accessible for the group of the user.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational unit to get projects for

includeSubOus - if all projects of sub-organizational units should be retrieved too

Returns:

all CmsProject objects in the organizational unit

Throws:

CmsException - if operation was not successful

getAllManageableProjects

public java.util.List<CmsProject> getAllManageableProjects(CmsObject cms,
                                                           java.lang.String ouFqn,
                                                           boolean includeSubOus)
                                                    throws CmsException

Returns all manageable projects of the given organizational unit.

That is all projects which are owned by the current user or which are manageable for the group of the user.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational unit to get projects for

includeSubOus - if all projects of sub-organizational units should be retrieved too

Returns:

all CmsProject objects in the organizational unit

Throws:

CmsException - if operation was not successful

getGroups

public java.util.List<CmsGroup> getGroups(CmsObject cms,
                                          java.lang.String ouFqn,
                                          boolean includeSubOus)
                                   throws CmsException

Returns all groups of the given organizational unit.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational unit to get all principals for

includeSubOus - if all groups of sub-organizational units should be retrieved too

Returns:

all CmsGroup objects in the organizational unit

Throws:

CmsException - if operation was not successful

getOrganizationalUnits

public java.util.List<CmsOrganizationalUnit> getOrganizationalUnits(CmsObject cms,
                                                                    java.lang.String ouFqn,
                                                                    boolean includeChildren)
                                                             throws CmsException

Returns all child organizational units of the given parent organizational unit including hierarchical deeper organization units if needed.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the parent organizational unit

includeChildren - if hierarchical deeper organization units should also be returned

Returns:

a list of CmsOrganizationalUnit objects

Throws:

CmsException - if operation was not successful

getResourcesForOrganizationalUnit

public java.util.List<CmsResource> getResourcesForOrganizationalUnit(CmsObject cms,
                                                                     java.lang.String ouFqn)
                                                              throws CmsException

Returns all resources of the given organizational unit.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational unit to get all resources for

Returns:

all CmsResource objects in the organizational unit

Throws:

CmsException - if operation was not successful

getUsers

public java.util.List<CmsUser> getUsers(CmsObject cms,
                                        java.lang.String ouFqn,
                                        boolean recursive)
                                 throws CmsException

Returns all users of the given organizational unit.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational unit to get all principals for

recursive - if all users of sub-organizational units should be retrieved too

Returns:

all CmsUser objects in the organizational unit

Throws:

CmsException - if operation was not successful

getUsersWithoutAdditionalInfo

public java.util.List<CmsUser> getUsersWithoutAdditionalInfo(CmsObject cms,
                                                             java.lang.String ouFqn,
                                                             boolean recursive)
                                                      throws CmsException

Returns all users of the given organizational unit, without their additional info.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational unit to get all principals for

recursive - if all users of sub-organizational units should be retrieved too

Returns:

all CmsUser objects in the organizational unit

Throws:

CmsException - if operation was not successful

initialize

public void initialize(CmsObject cms)
                throws CmsException

Initializes the organizational units.

Parameters:

cms - the admin CMS context

Throws:

CmsException - if something goes wrong

readOrganizationalUnit

public CmsOrganizationalUnit readOrganizationalUnit(CmsObject cms,
                                                    java.lang.String ouFqn)
                                             throws CmsException

Reads an organizational Unit based on its fully qualified name.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational Unit to be read

Returns:

the organizational Unit with the provided fully qualified name

Throws:

CmsException - if something goes wrong

removeResourceFromOrgUnit

public void removeResourceFromOrgUnit(CmsObject cms,
                                      java.lang.String ouFqn,
                                      java.lang.String resourceName)
                               throws CmsException

Removes a resource from the given organizational unit.

Parameters:

cms - the opencms context

ouFqn - the fully qualified name of the organizational unit to remove the resource from

resourceName - the name of the resource that is to be removed from the organizational unit

Throws:

CmsException - if something goes wrong

searchUsers

public java.util.List<CmsUser> searchUsers(CmsObject cms,
                                           CmsUserSearchParameters params)
                                    throws CmsException

Searches users which fit the given search parameters.

Parameters:

cms - the current CMS context

params - the user search parameters

Returns:

the users which fit the given search criteria

Throws:

CmsException - if something goes wrong

setUsersOrganizationalUnit

public void setUsersOrganizationalUnit(CmsObject cms,
                                       java.lang.String ouFqn,
                                       java.lang.String userName)
                                throws CmsException

Moves an user to the given organizational unit.

Parameters:

cms - the opencms context

ouFqn - the full qualified name of the organizational unit to add the user to

userName - the name of the user that is to be added to the organizational unit

Throws:

CmsException - if something goes wrong

writeOrganizationalUnit

public void writeOrganizationalUnit(CmsObject cms,
                                    CmsOrganizationalUnit organizationalUnit)
                             throws CmsException

Writes an already existing organizational unit.

The organizational unit has to be a valid OpenCms organizational unit.
The organizational unit will be completely overridden by the given data.

Parameters:

cms - the opencms context

organizationalUnit - the organizational unit that should be written

Throws:

CmsException - if operation was not successful