Class DefaultOrganizationController
- java.lang.Object
-
- org.silverpeas.core.admin.service.DefaultOrganizationController
-
- All Implemented Interfaces:
Serializable
,OrganizationController
@Service @Singleton public class DefaultOrganizationController extends Object implements OrganizationController
This object is used by all the admin jsp such as SpaceManagement, UserManagement, etc... It provides access functions to query and modify the domains as well as the company organization It should be used only by a client that has the administrator rights. The OrganizationController extends {@link AdministrationServiceProvider]} that maintains a static reference to anAdministration
instance. During the initialization of the Admin instance, some computations require services published by the underlying IoC container. So, an instance of OrganizationController is created by the IoC container and published under the name 'organizationController' so that the initialization of the static Admin instance can be performed correctly within the execution context of IoC container.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefaultOrganizationController()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String[]
getAdministratorUserIds(String fromUserId)
Return all administrators idsString[]
getAllComponentIds(String sSpaceId)
Returns all the component identifiers of the space represented by the given identifier.String[]
getAllComponentIdsRecur(String sSpaceId)
Returns all the component identifiers of the space, and its sub spaces, represented by the given identifier.Domain[]
getAllDomains()
String[]
getAllGroupIdsOfUser(String userId)
Group[]
getAllGroups()
Return all the groups of silverpeasString[]
getAllowedComponentIds(String userId)
String[]
getAllowedSubSpaceIds(String userId, String spaceFatherId)
Group[]
getAllRootGroups()
Return all root groups of silverpeas or null if an error occured when getting the root groups.Group[]
getAllRootGroupsInDomain(String domainId)
Gets all the user groups that belong to the specified domain.String[]
getAllRootSpaceIds()
Return all the root spaceIdsString[]
getAllRootSpaceIds(String sUserId)
Return all the root spaceIds available for the user sUserIdString[]
getAllSpaceIds()
Return all the spaces available in silverpeasString[]
getAllSpaceIds(String sUserId)
Group[]
getAllSubGroups(String parentGroupId)
For use in userPanel : return the direct sub-groupsString[]
getAllSubSpaceIds(String sSpaceId)
Return all the subSpaces available in silverpeas given a space id (driver format)String[]
getAllSubSpaceIds(String sSpaceId, String sUserId)
Return all the subSpaces Id available in webactiv given a space id (driver format)int
getAllSubUsersNumber(String sGroupId)
Returns the total number of distinct users recursively contained in the specified groupUserDetail[]
getAllUsers()
Return all the users of SilverpeasUserDetail[]
getAllUsers(String componentId)
Return all the users allowed to acces the given componentList<UserDetail>
getAllUsersFromNewestToOldest()
String[]
getAllUsersIds()
Return all the users of SilverpeasUserDetail[]
getAllUsersInDomain(String domainId)
Gets all the users that belong to the specified domain.UserDetail[]
getAllUsersOfGroup(String groupId)
Get ALL the users that are in a group or his sub groupsList<String>
getAvailableComponentsByUser(String userId)
Gets the component instance identifiers available for the specified user?String[]
getAvailCompoIds(String sUserId)
Return the component ids available for the current user IdString[]
getAvailCompoIds(String sClientSpaceId, String sUserId)
Return the component ids available for the current user Id in the given space idString[]
getAvailCompoIdsAtRoot(String sClientSpaceId, String sUserId)
Return the component ids available for the current user id in the given space idList<ComponentInstLight>
getAvailComponentInstLights(String userId, String componentName)
Gets the available component for a given userCompoSpace[]
getCompoForUser(String sUserId, String sCompoName)
Return the tuples (space id, compo id) allowed for the given user and given component nameString[]
getCompoId(String sCompoName)
Return the compo id for the given component nameString[]
getComponentIdsForUser(String sUserId, String sCompoName)
ComponentInst
getComponentInst(String sComponentId)
Return the component Instance corresponding to the given component idOptional<SilverpeasComponentInstance>
getComponentInstance(String componentInstanceIdentifier)
Gets the component instance related to the given identifier.
In contrary toOrganizationController.getComponentInst(String)
,OrganizationController.getComponentInstLight(String)
signatures, this one is able to return different kinds of implementation ofSilverpeasComponentInstance
and it is able to deal with administration cache too.
So, this signature is useful into contexts of transverse treatments.ComponentInstLight
getComponentInstLight(String sComponentId)
Return the component Instance Light corresponding to the given component idString
getComponentParameterValue(String sComponentId, String parameterName)
List<ComponentInstLight>
getComponentsWithParameterValue(String param, String value)
List<GroupDetail>
getDirectGroupsOfUser(String userId)
Domain
getDomain(String domainId)
UserDetail[]
getFilteredDirectUsers(String sGroupId, String sUserLastNameFilter)
For use in userPanel : return the users that are direct child of a given groupSpaceWithSubSpacesAndComponents
getFullTreeview()
SpaceWithSubSpacesAndComponents
getFullTreeview(String userId)
SpaceWithSubSpacesAndComponents
getFullTreeview(String userId, String spaceId)
SpaceWithSubSpacesAndComponents
getFullTreeviewOnComponentName(String userId, String componentName)
Group
getGroup(String sGroupId)
Return the Group of the group with the given IdGroup[]
getGroups(String[] groupsId)
Return all groups specified by the groupsIdsMap<String,Map<String,String>>
getParameterValuesByComponentIdThenByParamName(Collection<String> componentIds, Collection<String> paramNames)
Gets all parameters values by component and by parameter name.List<SpaceInstLight>
getPathToComponent(String componentId)
List<String>
getPathToGroup(String groupId)
Get path to GroupList<SpaceInstLight>
getPathToSpace(String spaceId)
Group[]
getRecursivelyAllSubgroups(String parentGroupId)
Gets all the groups and sub groups that are children of the specified group.SpaceInstLight
getRootSpace(String spaceId)
List<SpaceInstLight>
getRootSpacesContainingComponent(String userId, String componentName)
List<String>
getSearchableComponentsByCriteria(ComponentSearchCriteria criteria)
Gets the identifier of the component instances that are both searchable and that satisfy the specified criteria.SpaceInst
getSpaceInstById(String sSpaceId)
Return the space Instance corresponding to the given space idSpaceInstLight
getSpaceInstLightById(String spaceId)
Return the space light corresponding to the given space idString[]
getSpaceNames(String[] asSpaceIds)
Return the spaces name corresponding to the given space ids.SpaceProfile
getSpaceProfile(String spaceId, SilverpeasRole role)
Gets the space profile instance which provides all user and group identifiers through simple methods.List<SpaceInstLight>
getSpaceTreeview(String userId)
List<SpaceInstLight>
getSubSpacesContainingComponent(String spaceId, String userId, String componentName)
UserDetail
getUserDetail(String sUserId)
Return the detail of the user with the given ldap IdUserDetail[]
getUserDetails(String[] asUserIds)
Return an array of users corresponding to the given user Id arrayUserFull
getUserFull(String sUserId)
Return the full detail of the user with the given ldap IdList<UserFull>
getUserFulls(Collection<String> userIds)
Return a list of full detail of users corresponding toString[]
getUserManageableSpaceIds(String sUserId)
Return all the spaces Id manageable by given user in SilverpeasMap<String,List<String>>
getUserObjectProfiles(String userId, String componentId, ProfiledObjectType profiledObjectType)
ProfileInst
getUserProfile(String profileId)
String[]
getUserProfiles(String userId, String componentId)
String[]
getUserProfiles(String userId, String componentId, ProfiledObjectId objectId)
List<ProfileInst>
getUserProfiles(String componentId, ProfiledObjectId objectId)
Map<String,Set<String>>
getUserProfilesByComponentId(String userId, Collection<String> componentIds)
Gets the profile names of given user indexed by the given component instances.Map<Pair<String,String>,Set<String>>
getUserProfilesByComponentIdAndObjectId(String userId, Collection<String> componentIds, ProfiledObjectIds profiledObjectIds)
Gets the profile names of given user indexed by couple of given component instances and object instances.UserDetail[]
getUsers(String sPrefixTableName, String sComponentName, String sProfile)
Return all the users with the given profile allowed to access the given component of the given spaceString[]
getUsersIdsByRoleNames(String componentId, List<String> profileNames)
Return userIds according to a list of profile namesString[]
getUsersIdsByRoleNames(String componentId, ProfiledObjectId objectId, List<String> profileNames)
Collection<SilverpeasRole>
getUserSilverpeasRolesOn(User user, String componentInstanceIdentifier)
Gets the collection of silverpeas roles the given user has on the component instance represented by the given identifier.
In contrary toOrganizationController.getUserProfiles(String, String)
,OrganizationController.getUserProfiles(String, ProfiledObjectId)
orOrganizationController.getUserProfiles(String, String, ProfiledObjectId)
signatures, this one is able to return user roles of different kinds of implementation ofSilverpeasComponentInstance
.
So, this signature is useful into contexts of transversal treatments.
BE CAREFUL, the manager role is never returned as it corresponds to a space role.<T extends User>
List<T>getUsersOfDomains(List<String> domainIds)
<T extends User>
List<T>getUsersOfDomainsFromNewestToOldest(List<String> domainIds)
boolean
isAdminTool(String toolId)
Is the specified tool belongs to the administration component?boolean
isAnonymousAccessActivated()
Is the anonymous access is activated for the running Silverpeas?boolean
isComponentAvailableToGroup(String componentId, String groupId)
boolean
isComponentAvailableToUser(String componentId, String userId)
Is the specified component instance available among the components instances accessible by the specified user?boolean
isComponentExist(String componentId)
boolean
isComponentManageable(String componentId, String userId)
boolean
isObjectAvailableToGroup(ProfiledObjectId objectId, String componentId, String groupId)
boolean
isObjectAvailableToUser(ProfiledObjectId objectId, String componentId, String userId)
boolean
isSpaceAvailable(String spaceId, String userId)
boolean
isToolAvailable(String toolId)
Is the specified tool is available in Silverpeas?<T extends Group>
SilverpeasList<T>searchGroups(GroupsSearchCriteria criteria)
Searches the groups that match the specified criteria.<T extends User>
SilverpeasList<T>searchUsers(UserDetailsSearchCriteria criteria)
Searches the users that match the specified criteria.
-
-
-
Method Detail
-
getAllSpaceIds
public String[] getAllSpaceIds()
Description copied from interface:OrganizationController
Return all the spaces available in silverpeas- Specified by:
getAllSpaceIds
in interfaceOrganizationController
- Returns:
- an array with the identifiers of the spaces
-
getAllSubSpaceIds
public String[] getAllSubSpaceIds(String sSpaceId)
Description copied from interface:OrganizationController
Return all the subSpaces available in silverpeas given a space id (driver format)- Specified by:
getAllSubSpaceIds
in interfaceOrganizationController
- Parameters:
sSpaceId
- the identifier of the parent space- Returns:
- an array with the identifiers of the subspaces.
-
getSpaceNames
public String[] getSpaceNames(String[] asSpaceIds)
Description copied from interface:OrganizationController
Return the spaces name corresponding to the given space ids.- Specified by:
getSpaceNames
in interfaceOrganizationController
- Parameters:
asSpaceIds
- one or more space identifiers.- Returns:
- the names of the specified spaces
-
getSpaceInstLightById
public SpaceInstLight getSpaceInstLightById(String spaceId)
Description copied from interface:OrganizationController
Return the space light corresponding to the given space id- Specified by:
getSpaceInstLightById
in interfaceOrganizationController
- Parameters:
spaceId
- the unique identifier of a space.- Returns:
- the space
-
getSpaceInstById
public SpaceInst getSpaceInstById(String sSpaceId)
Description copied from interface:OrganizationController
Return the space Instance corresponding to the given space id- Specified by:
getSpaceInstById
in interfaceOrganizationController
-
getAvailCompoIds
public String[] getAvailCompoIds(String sClientSpaceId, String sUserId)
Description copied from interface:OrganizationController
Return the component ids available for the current user Id in the given space id- Specified by:
getAvailCompoIds
in interfaceOrganizationController
-
getAvailCompoIds
public String[] getAvailCompoIds(String sUserId)
Description copied from interface:OrganizationController
Return the component ids available for the current user Id- Specified by:
getAvailCompoIds
in interfaceOrganizationController
-
getAvailCompoIdsAtRoot
public String[] getAvailCompoIdsAtRoot(String sClientSpaceId, String sUserId)
Description copied from interface:OrganizationController
Return the component ids available for the current user id in the given space id- Specified by:
getAvailCompoIdsAtRoot
in interfaceOrganizationController
-
getCompoForUser
public CompoSpace[] getCompoForUser(String sUserId, String sCompoName)
Description copied from interface:OrganizationController
Return the tuples (space id, compo id) allowed for the given user and given component name- Specified by:
getCompoForUser
in interfaceOrganizationController
- Parameters:
sUserId
- the identifier of a usersCompoName
- the name of a component- Returns:
- an array of tuples (space id, component instance id) of resources available by the user
-
getAvailComponentInstLights
public List<ComponentInstLight> getAvailComponentInstLights(String userId, String componentName)
Description copied from interface:OrganizationController
Gets the available component for a given user- Specified by:
getAvailComponentInstLights
in interfaceOrganizationController
- Parameters:
userId
- user identifier used to get componentcomponentName
- type of component to retrieve ( for example : kmelia, forums, blog)- Returns:
- a list of ComponentInstLight object
-
getComponentIdsForUser
public String[] getComponentIdsForUser(String sUserId, String sCompoName)
- Specified by:
getComponentIdsForUser
in interfaceOrganizationController
-
getCompoId
public String[] getCompoId(String sCompoName)
Description copied from interface:OrganizationController
Return the compo id for the given component name- Specified by:
getCompoId
in interfaceOrganizationController
- Parameters:
sCompoName
- the name of a component- Returns:
- an array of identifiers of instances of the given component
-
getComponentParameterValue
public String getComponentParameterValue(String sComponentId, String parameterName)
- Specified by:
getComponentParameterValue
in interfaceOrganizationController
-
getComponentsWithParameterValue
public List<ComponentInstLight> getComponentsWithParameterValue(String param, String value)
- Specified by:
getComponentsWithParameterValue
in interfaceOrganizationController
-
getParameterValuesByComponentIdThenByParamName
public Map<String,Map<String,String>> getParameterValuesByComponentIdThenByParamName(Collection<String> componentIds, Collection<String> paramNames)
Description copied from interface:OrganizationController
Gets all parameters values by component and by parameter name.- Specified by:
getParameterValuesByComponentIdThenByParamName
in interfaceOrganizationController
- Parameters:
componentIds
- list of component identifier.paramNames
- optional list of parameter name. All parameters are retrieved if it is not filled or null- Returns:
- a map filled with couples of parameter name / value per component instance identifier.
-
getComponentInstance
public Optional<SilverpeasComponentInstance> getComponentInstance(String componentInstanceIdentifier)
Description copied from interface:OrganizationController
Gets the component instance related to the given identifier.
In contrary toOrganizationController.getComponentInst(String)
,OrganizationController.getComponentInstLight(String)
signatures, this one is able to return different kinds of implementation ofSilverpeasComponentInstance
and it is able to deal with administration cache too.
So, this signature is useful into contexts of transverse treatments.- Specified by:
getComponentInstance
in interfaceOrganizationController
- Parameters:
componentInstanceIdentifier
- the identifier of the requested component instance.- Returns:
- an optional component instance.
-
getComponentInst
public ComponentInst getComponentInst(String sComponentId)
Description copied from interface:OrganizationController
Return the component Instance corresponding to the given component id- Specified by:
getComponentInst
in interfaceOrganizationController
-
getComponentInstLight
public ComponentInstLight getComponentInstLight(String sComponentId)
Description copied from interface:OrganizationController
Return the component Instance Light corresponding to the given component id- Specified by:
getComponentInstLight
in interfaceOrganizationController
-
getUserFull
public UserFull getUserFull(String sUserId)
Description copied from interface:OrganizationController
Return the full detail of the user with the given ldap Id- Specified by:
getUserFull
in interfaceOrganizationController
-
getUserFulls
public List<UserFull> getUserFulls(Collection<String> userIds)
Description copied from interface:OrganizationController
Return a list of full detail of users corresponding to- Specified by:
getUserFulls
in interfaceOrganizationController
-
getUserDetail
public UserDetail getUserDetail(String sUserId)
Description copied from interface:OrganizationController
Return the detail of the user with the given ldap Id- Specified by:
getUserDetail
in interfaceOrganizationController
-
getUserDetails
public UserDetail[] getUserDetails(String[] asUserIds)
Description copied from interface:OrganizationController
Return an array of users corresponding to the given user Id array- Specified by:
getUserDetails
in interfaceOrganizationController
-
getAllUsers
public UserDetail[] getAllUsers(String componentId)
Description copied from interface:OrganizationController
Return all the users allowed to acces the given component- Specified by:
getAllUsers
in interfaceOrganizationController
-
getAllUsersInDomain
public UserDetail[] getAllUsersInDomain(String domainId)
Description copied from interface:OrganizationController
Gets all the users that belong to the specified domain.- Specified by:
getAllUsersInDomain
in interfaceOrganizationController
- Parameters:
domainId
- the unique identifier of the domain.- Returns:
- an array of users objects or null if no such domain exists.
-
getUsersOfDomains
public <T extends User> List<T> getUsersOfDomains(List<String> domainIds)
- Specified by:
getUsersOfDomains
in interfaceOrganizationController
-
getUsersOfDomainsFromNewestToOldest
public <T extends User> List<T> getUsersOfDomainsFromNewestToOldest(List<String> domainIds)
- Specified by:
getUsersOfDomainsFromNewestToOldest
in interfaceOrganizationController
-
searchUsers
public <T extends User> SilverpeasList<T> searchUsers(UserDetailsSearchCriteria criteria)
Description copied from interface:OrganizationController
Searches the users that match the specified criteria.- Specified by:
searchUsers
in interfaceOrganizationController
- Parameters:
criteria
- the criteria in searching of user details.- Returns:
- a slice of the list of user details matching the criteria or an empty list of no ones are found. user details.
-
getAllRootGroupsInDomain
public Group[] getAllRootGroupsInDomain(String domainId)
Description copied from interface:OrganizationController
Gets all the user groups that belong to the specified domain.- Specified by:
getAllRootGroupsInDomain
in interfaceOrganizationController
- Parameters:
domainId
- the unique identifier of the domain.- Returns:
- an array of Group objects or null if no such domain exists.
-
getFilteredDirectUsers
public UserDetail[] getFilteredDirectUsers(String sGroupId, String sUserLastNameFilter)
Description copied from interface:OrganizationController
For use in userPanel : return the users that are direct child of a given group- Specified by:
getFilteredDirectUsers
in interfaceOrganizationController
-
searchGroups
public <T extends Group> SilverpeasList<T> searchGroups(GroupsSearchCriteria criteria)
Description copied from interface:OrganizationController
Searches the groups that match the specified criteria.- Specified by:
searchGroups
in interfaceOrganizationController
- Parameters:
criteria
- the criteria in searching of user groups.- Returns:
- a slice of the list of user groups matching the criteria or an empty list of no ones are found. user groups.
-
getAllSubUsersNumber
public int getAllSubUsersNumber(String sGroupId)
Description copied from interface:OrganizationController
Returns the total number of distinct users recursively contained in the specified group- Specified by:
getAllSubUsersNumber
in interfaceOrganizationController
-
getAllSubGroups
public Group[] getAllSubGroups(String parentGroupId)
Description copied from interface:OrganizationController
For use in userPanel : return the direct sub-groups- Specified by:
getAllSubGroups
in interfaceOrganizationController
-
getRecursivelyAllSubgroups
public Group[] getRecursivelyAllSubgroups(String parentGroupId)
Description copied from interface:OrganizationController
Gets all the groups and sub groups that are children of the specified group.- Specified by:
getRecursivelyAllSubgroups
in interfaceOrganizationController
- Parameters:
parentGroupId
- the unique identifier of a group.- Returns:
- an array with all the groups that are children of the specified group.
-
getAllUsers
public UserDetail[] getAllUsers()
Description copied from interface:OrganizationController
Return all the users of Silverpeas- Specified by:
getAllUsers
in interfaceOrganizationController
-
getAllUsersFromNewestToOldest
public List<UserDetail> getAllUsersFromNewestToOldest()
- Specified by:
getAllUsersFromNewestToOldest
in interfaceOrganizationController
-
getUsers
public UserDetail[] getUsers(String sPrefixTableName, String sComponentName, String sProfile)
Description copied from interface:OrganizationController
Return all the users with the given profile allowed to access the given component of the given space- Specified by:
getUsers
in interfaceOrganizationController
-
getUserSilverpeasRolesOn
public Collection<SilverpeasRole> getUserSilverpeasRolesOn(User user, String componentInstanceIdentifier)
Description copied from interface:OrganizationController
Gets the collection of silverpeas roles the given user has on the component instance represented by the given identifier.
In contrary toOrganizationController.getUserProfiles(String, String)
,OrganizationController.getUserProfiles(String, ProfiledObjectId)
orOrganizationController.getUserProfiles(String, String, ProfiledObjectId)
signatures, this one is able to return user roles of different kinds of implementation ofSilverpeasComponentInstance
.
So, this signature is useful into contexts of transversal treatments.
BE CAREFUL, the manager role is never returned as it corresponds to a space role.- Specified by:
getUserSilverpeasRolesOn
in interfaceOrganizationController
componentInstanceIdentifier
- the identifier of the component instance.- Returns:
- an optional component instance.
-
getUserProfiles
public String[] getUserProfiles(String userId, String componentId)
- Specified by:
getUserProfiles
in interfaceOrganizationController
-
getUserProfilesByComponentId
public Map<String,Set<String>> getUserProfilesByComponentId(String userId, Collection<String> componentIds)
Description copied from interface:OrganizationController
Gets the profile names of given user indexed by the given component instances.- Specified by:
getUserProfilesByComponentId
in interfaceOrganizationController
- Parameters:
userId
- a user identifier as string.componentIds
- list of component instance identifier as string.- Returns:
- a map filled with list of profile name as string by component instance identifier as string.
-
getUserProfiles
public String[] getUserProfiles(String userId, String componentId, ProfiledObjectId objectId)
- Specified by:
getUserProfiles
in interfaceOrganizationController
-
getUserProfilesByComponentIdAndObjectId
public Map<Pair<String,String>,Set<String>> getUserProfilesByComponentIdAndObjectId(String userId, Collection<String> componentIds, ProfiledObjectIds profiledObjectIds)
Description copied from interface:OrganizationController
Gets the profile names of given user indexed by couple of given component instances and object instances.- Specified by:
getUserProfilesByComponentIdAndObjectId
in interfaceOrganizationController
- Parameters:
userId
- a user identifier as string.componentIds
- list of component instance identifier as string.profiledObjectIds
- if NOTHING is given, then all the rows associated to the type are returned, otherwise all the rows associated to type and ids.- Returns:
- a map filled with list of profile name as string by couple component instance identifier as string - object identifier as String.
-
getUserObjectProfiles
public Map<String,List<String>> getUserObjectProfiles(String userId, String componentId, ProfiledObjectType profiledObjectType)
- Specified by:
getUserObjectProfiles
in interfaceOrganizationController
-
getUserProfiles
public List<ProfileInst> getUserProfiles(String componentId, ProfiledObjectId objectId)
- Specified by:
getUserProfiles
in interfaceOrganizationController
-
getUserProfile
public ProfileInst getUserProfile(String profileId)
- Specified by:
getUserProfile
in interfaceOrganizationController
-
getAdministratorUserIds
public String[] getAdministratorUserIds(String fromUserId)
Description copied from interface:OrganizationController
Return all administrators ids- Specified by:
getAdministratorUserIds
in interfaceOrganizationController
-
getGroup
public Group getGroup(String sGroupId)
Description copied from interface:OrganizationController
Return the Group of the group with the given Id- Specified by:
getGroup
in interfaceOrganizationController
-
getGroups
public Group[] getGroups(String[] groupsId)
Description copied from interface:OrganizationController
Return all groups specified by the groupsIds- Specified by:
getGroups
in interfaceOrganizationController
-
getAllGroups
public Group[] getAllGroups()
Description copied from interface:OrganizationController
Return all the groups of silverpeas- Specified by:
getAllGroups
in interfaceOrganizationController
-
getAllRootGroups
public Group[] getAllRootGroups()
Description copied from interface:OrganizationController
Return all root groups of silverpeas or null if an error occured when getting the root groups.- Specified by:
getAllRootGroups
in interfaceOrganizationController
-
getAllUsersOfGroup
public UserDetail[] getAllUsersOfGroup(String groupId)
Description copied from interface:OrganizationController
Get ALL the users that are in a group or his sub groups- Specified by:
getAllUsersOfGroup
in interfaceOrganizationController
-
getPathToGroup
public List<String> getPathToGroup(String groupId)
Description copied from interface:OrganizationController
Get path to Group- Specified by:
getPathToGroup
in interfaceOrganizationController
-
getAllSpaceIds
public String[] getAllSpaceIds(String sUserId)
- Specified by:
getAllSpaceIds
in interfaceOrganizationController
-
getUserManageableSpaceIds
public String[] getUserManageableSpaceIds(String sUserId)
Description copied from interface:OrganizationController
Return all the spaces Id manageable by given user in Silverpeas- Specified by:
getUserManageableSpaceIds
in interfaceOrganizationController
-
getAllRootSpaceIds
public String[] getAllRootSpaceIds()
Description copied from interface:OrganizationController
Return all the root spaceIds- Specified by:
getAllRootSpaceIds
in interfaceOrganizationController
-
getAllRootSpaceIds
public String[] getAllRootSpaceIds(String sUserId)
Description copied from interface:OrganizationController
Return all the root spaceIds available for the user sUserId- Specified by:
getAllRootSpaceIds
in interfaceOrganizationController
-
getAllSubSpaceIds
public String[] getAllSubSpaceIds(String sSpaceId, String sUserId)
Description copied from interface:OrganizationController
Return all the subSpaces Id available in webactiv given a space id (driver format)- Specified by:
getAllSubSpaceIds
in interfaceOrganizationController
-
getAllComponentIds
public String[] getAllComponentIds(String sSpaceId)
Description copied from interface:OrganizationController
Returns all the component identifiers of the space represented by the given identifier.Component instance of sub spaces are not retrieved.
It returns also ids of
SilverpeasPersonalComponentInstance
instances.- Specified by:
getAllComponentIds
in interfaceOrganizationController
-
getAllComponentIdsRecur
public String[] getAllComponentIdsRecur(String sSpaceId)
Description copied from interface:OrganizationController
Returns all the component identifiers of the space, and its sub spaces, represented by the given identifier.It returns also ids of
SilverpeasPersonalComponentInstance
instances.- Specified by:
getAllComponentIdsRecur
in interfaceOrganizationController
-
getRootSpacesContainingComponent
public List<SpaceInstLight> getRootSpacesContainingComponent(String userId, String componentName)
- Specified by:
getRootSpacesContainingComponent
in interfaceOrganizationController
-
getSubSpacesContainingComponent
public List<SpaceInstLight> getSubSpacesContainingComponent(String spaceId, String userId, String componentName)
- Specified by:
getSubSpacesContainingComponent
in interfaceOrganizationController
-
isAdminTool
public boolean isAdminTool(String toolId)
Is the specified tool belongs to the administration component? The administration component (or administrative console) forms a particular component made up of several tools, each of them providing an administrative feature. Each tool in the administration component have the same identifier that refers in fact the administration console.- Specified by:
isAdminTool
in interfaceOrganizationController
- Parameters:
toolId
- the unique identifier of the tool.- Returns:
- true if the tool belongs to the administration component.
-
isToolAvailable
public boolean isToolAvailable(String toolId)
Is the specified tool is available in Silverpeas? A tool in Silverpeas is a singleton component that is dedicated to a given user. Each tool is identified by a unique identifier, and it is unique to each user.- Specified by:
isToolAvailable
in interfaceOrganizationController
- Parameters:
toolId
- the unique identifier of a tool.- Returns:
- true if the tool is available, false otherwise.
-
getAvailableComponentsByUser
public List<String> getAvailableComponentsByUser(String userId)
Description copied from interface:OrganizationController
Gets the component instance identifiers available for the specified user? A component is an application in Silverpeas to perform some tasks and to manage some resources. Each component in Silverpeas can be instantiated several times, each of them corresponding then to a running application in Silverpeas and it is uniquely identified from others instances by a given identifier.- Specified by:
getAvailableComponentsByUser
in interfaceOrganizationController
- Parameters:
userId
- the unique identifier of a user.- Returns:
- a list of component instance identifier as string.
-
isComponentAvailableToUser
public boolean isComponentAvailableToUser(String componentId, String userId)
Description copied from interface:OrganizationController
Is the specified component instance available among the components instances accessible by the specified user? A component is an application in Silverpeas to perform some tasks and to manage some resources. Each component in Silverpeas can be instantiated several times, each of them corresponding then to a running application in Silverpeas and it is uniquely identified from others instances by a given identifier.- Specified by:
isComponentAvailableToUser
in interfaceOrganizationController
- Parameters:
componentId
- the unique identifier of a component instance.userId
- the unique identifier of a user.- Returns:
- true if the component instance is available, false otherwise.
-
isComponentAvailableToGroup
public boolean isComponentAvailableToGroup(String componentId, String groupId)
- Specified by:
isComponentAvailableToGroup
in interfaceOrganizationController
-
isComponentExist
public boolean isComponentExist(String componentId)
- Specified by:
isComponentExist
in interfaceOrganizationController
-
isComponentManageable
public boolean isComponentManageable(String componentId, String userId)
- Specified by:
isComponentManageable
in interfaceOrganizationController
-
isSpaceAvailable
public boolean isSpaceAvailable(String spaceId, String userId)
- Specified by:
isSpaceAvailable
in interfaceOrganizationController
-
isObjectAvailableToUser
public boolean isObjectAvailableToUser(ProfiledObjectId objectId, String componentId, String userId)
- Specified by:
isObjectAvailableToUser
in interfaceOrganizationController
-
isObjectAvailableToGroup
public boolean isObjectAvailableToGroup(ProfiledObjectId objectId, String componentId, String groupId)
- Specified by:
isObjectAvailableToGroup
in interfaceOrganizationController
-
getSpaceTreeview
public List<SpaceInstLight> getSpaceTreeview(String userId)
- Specified by:
getSpaceTreeview
in interfaceOrganizationController
-
getAllowedSubSpaceIds
public String[] getAllowedSubSpaceIds(String userId, String spaceFatherId)
- Specified by:
getAllowedSubSpaceIds
in interfaceOrganizationController
-
getRootSpace
public SpaceInstLight getRootSpace(String spaceId)
- Specified by:
getRootSpace
in interfaceOrganizationController
-
getAllUsersIds
public String[] getAllUsersIds()
Description copied from interface:OrganizationController
Return all the users of Silverpeas- Specified by:
getAllUsersIds
in interfaceOrganizationController
-
getUsersIdsByRoleNames
public String[] getUsersIdsByRoleNames(String componentId, List<String> profileNames)
Description copied from interface:OrganizationController
Return userIds according to a list of profile names- Specified by:
getUsersIdsByRoleNames
in interfaceOrganizationController
- Parameters:
componentId
- the instance idprofileNames
- the list which contains the profile names- Returns:
- a string array of user id
-
getUsersIdsByRoleNames
public String[] getUsersIdsByRoleNames(String componentId, ProfiledObjectId objectId, List<String> profileNames)
- Specified by:
getUsersIdsByRoleNames
in interfaceOrganizationController
-
getDomain
public Domain getDomain(String domainId)
- Specified by:
getDomain
in interfaceOrganizationController
-
getAllDomains
public Domain[] getAllDomains()
- Specified by:
getAllDomains
in interfaceOrganizationController
-
getDirectGroupsOfUser
public List<GroupDetail> getDirectGroupsOfUser(String userId)
- Specified by:
getDirectGroupsOfUser
in interfaceOrganizationController
-
getAllGroupIdsOfUser
public String[] getAllGroupIdsOfUser(String userId)
- Specified by:
getAllGroupIdsOfUser
in interfaceOrganizationController
-
isAnonymousAccessActivated
public boolean isAnonymousAccessActivated()
Description copied from interface:OrganizationController
Is the anonymous access is activated for the running Silverpeas? When the anonymous access is activated, then a specific user for anonymous access should be set; all anonym accesses to the running Silverpeas are done with this user profile.- Specified by:
isAnonymousAccessActivated
in interfaceOrganizationController
- Returns:
- true if the anonym access is activated, false otherwise.
-
getAllowedComponentIds
public String[] getAllowedComponentIds(String userId)
- Specified by:
getAllowedComponentIds
in interfaceOrganizationController
-
getSearchableComponentsByCriteria
public List<String> getSearchableComponentsByCriteria(ComponentSearchCriteria criteria)
Description copied from interface:OrganizationController
Gets the identifier of the component instances that are both searchable and that satisfy the specified criteria.- Specified by:
getSearchableComponentsByCriteria
in interfaceOrganizationController
- Parameters:
criteria
- the criteria on the component instances to get.- Returns:
- a list of component instance identifiers.
-
getSpaceProfile
public SpaceProfile getSpaceProfile(String spaceId, SilverpeasRole role)
Description copied from interface:OrganizationController
Gets the space profile instance which provides all user and group identifiers through simple methods.- Specified by:
getSpaceProfile
in interfaceOrganizationController
- Parameters:
spaceId
- the identifier of aimed space.role
- the aimed technical role name.- Returns:
- the
SpaceProfile
instance.
-
getFullTreeview
public SpaceWithSubSpacesAndComponents getFullTreeview() throws AdminException
- Specified by:
getFullTreeview
in interfaceOrganizationController
- Throws:
AdminException
-
getFullTreeview
public SpaceWithSubSpacesAndComponents getFullTreeview(String userId) throws AdminException
- Specified by:
getFullTreeview
in interfaceOrganizationController
- Throws:
AdminException
-
getFullTreeviewOnComponentName
public SpaceWithSubSpacesAndComponents getFullTreeviewOnComponentName(String userId, String componentName) throws AdminException
- Specified by:
getFullTreeviewOnComponentName
in interfaceOrganizationController
- Throws:
AdminException
-
getFullTreeview
public SpaceWithSubSpacesAndComponents getFullTreeview(String userId, String spaceId) throws AdminException
- Specified by:
getFullTreeview
in interfaceOrganizationController
- Throws:
AdminException
-
getPathToSpace
public List<SpaceInstLight> getPathToSpace(String spaceId)
- Specified by:
getPathToSpace
in interfaceOrganizationController
-
getPathToComponent
public List<SpaceInstLight> getPathToComponent(String componentId)
- Specified by:
getPathToComponent
in interfaceOrganizationController
-
-