Interface OrganizationController
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
DefaultOrganizationController
public interface OrganizationController extends Serializable
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static OrganizationController
get()
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)
<T extends Group>
T[]getAllGroups()
Return all the groups of silverpeasString[]
getAllowedComponentIds(String userId)
String[]
getAllowedSubSpaceIds(String userId, String spaceFatherId)
<T extends Group>
T[]getAllRootGroups()
Return all root groups of silverpeas or null if an error occured when getting the root groups.<T extends Group>
T[]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)
<T extends Group>
T[]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 group<T extends User>
T[]getAllUsers()
Return all the users of Silverpeas<T extends User>
T[]getAllUsers(String componentId)
Return all the users allowed to acces the given component<T extends User>
List<T>getAllUsersFromNewestToOldest()
String[]
getAllUsersIds()
Return all the users of Silverpeas<T extends User>
T[]getAllUsersInDomain(String domainId)
Gets all the users that belong to the specified domain.<T extends User>
T[]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 togetComponentInst(String)
,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)
<T extends User>
T[]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)
<T extends Group>
TgetGroup(String sGroupId)
Return the Group of the group with the given Id<T extends Group>
T[]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)
<T extends Group>
T[]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)
<T extends User>
TgetUserDetail(String sUserId)
Return the detail of the user with the given ldap Id<T extends User>
T[]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.<T extends User>
T[]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 togetUserProfiles(String, String)
,getUserProfiles(String, ProfiledObjectId)
orgetUserProfiles(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)
<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
-
get
static OrganizationController get()
-
getAllSpaceIds
String[] getAllSpaceIds()
Return all the spaces available in silverpeas- Returns:
- an array with the identifiers of the spaces
-
getAllSubSpaceIds
String[] getAllSubSpaceIds(String sSpaceId)
Return all the subSpaces available in silverpeas given a space id (driver format)- Parameters:
sSpaceId
- the identifier of the parent space- Returns:
- an array with the identifiers of the subspaces.
-
getSpaceNames
String[] getSpaceNames(String[] asSpaceIds)
Return the spaces name corresponding to the given space ids.- Parameters:
asSpaceIds
- one or more space identifiers.- Returns:
- the names of the specified spaces
-
getSpaceInstLightById
SpaceInstLight getSpaceInstLightById(String spaceId)
Return the space light corresponding to the given space id- Parameters:
spaceId
- the unique identifier of a space.- Returns:
- the space
-
getSpaceInstById
SpaceInst getSpaceInstById(String sSpaceId)
Return the space Instance corresponding to the given space id
-
getAvailCompoIds
String[] getAvailCompoIds(String sClientSpaceId, String sUserId)
Return the component ids available for the current user Id in the given space id
-
getAvailCompoIds
String[] getAvailCompoIds(String sUserId)
Return the component ids available for the current user Id
-
getAvailCompoIdsAtRoot
String[] getAvailCompoIdsAtRoot(String sClientSpaceId, String sUserId)
Return the component ids available for the current user id in the given space id
-
getCompoForUser
CompoSpace[] getCompoForUser(String sUserId, String sCompoName)
Return the tuples (space id, compo id) allowed for the given user and given component name- 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
List<ComponentInstLight> getAvailComponentInstLights(String userId, String componentName)
Gets the available component for a given user- Parameters:
userId
- user identifier used to get componentcomponentName
- type of component to retrieve ( for example : kmelia, forums, blog)- Returns:
- a list of ComponentInstLight object
-
getCompoId
String[] getCompoId(String sCompoName)
Return the compo id for the given component name- Parameters:
sCompoName
- the name of a component- Returns:
- an array of identifiers of instances of the given component
-
getComponentParameterValue
String getComponentParameterValue(String sComponentId, String parameterName)
-
getComponentsWithParameterValue
List<ComponentInstLight> getComponentsWithParameterValue(String param, String value)
-
getParameterValuesByComponentIdThenByParamName
Map<String,Map<String,String>> getParameterValuesByComponentIdThenByParamName(Collection<String> componentIds, Collection<String> paramNames)
Gets all parameters values by component and by parameter name.- 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
Optional<SilverpeasComponentInstance> getComponentInstance(String componentInstanceIdentifier)
Gets the component instance related to the given identifier.
In contrary togetComponentInst(String)
,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.- Parameters:
componentInstanceIdentifier
- the identifier of the requested component instance.- Returns:
- an optional component instance.
-
getComponentInst
ComponentInst getComponentInst(String sComponentId)
Return the component Instance corresponding to the given component id
-
getComponentInstLight
ComponentInstLight getComponentInstLight(String sComponentId)
Return the component Instance Light corresponding to the given component id
-
getUserFull
UserFull getUserFull(String sUserId)
Return the full detail of the user with the given ldap Id
-
getUserFulls
List<UserFull> getUserFulls(Collection<String> userIds)
Return a list of full detail of users corresponding to
-
getUserDetail
<T extends User> T getUserDetail(String sUserId)
Return the detail of the user with the given ldap Id
-
getUserDetails
<T extends User> T[] getUserDetails(String[] asUserIds)
Return an array of users corresponding to the given user Id array
-
getAllUsers
<T extends User> T[] getAllUsers(String componentId)
Return all the users allowed to acces the given component
-
getAllUsersInDomain
<T extends User> T[] getAllUsersInDomain(String domainId)
Gets all the users that belong to the specified domain.- Parameters:
domainId
- the unique identifier of the domain.- Returns:
- an array of users objects or null if no such domain exists.
-
searchUsers
<T extends User> SilverpeasList<T> searchUsers(UserDetailsSearchCriteria criteria)
Searches the users that match the specified criteria.- 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
<T extends Group> T[] getAllRootGroupsInDomain(String domainId)
Gets all the user groups that belong to the specified domain.- Parameters:
domainId
- the unique identifier of the domain.- Returns:
- an array of Group objects or null if no such domain exists.
-
getFilteredDirectUsers
<T extends User> T[] getFilteredDirectUsers(String sGroupId, String sUserLastNameFilter)
For use in userPanel : return the users that are direct child of a given group
-
searchGroups
<T extends Group> SilverpeasList<T> searchGroups(GroupsSearchCriteria criteria)
Searches the groups that match the specified criteria.- 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
int getAllSubUsersNumber(String sGroupId)
Returns the total number of distinct users recursively contained in the specified group
-
getAllSubGroups
<T extends Group> T[] getAllSubGroups(String parentGroupId)
For use in userPanel : return the direct sub-groups
-
getRecursivelyAllSubgroups
<T extends Group> T[] getRecursivelyAllSubgroups(String parentGroupId)
Gets all the groups and sub groups that are children of the specified group.- Type Parameters:
T
- the concrete type of theGroup
instances to return.- Parameters:
parentGroupId
- the unique identifier of a group.- Returns:
- an array with all the groups that are children of the specified group.
-
getAllUsers
<T extends User> T[] getAllUsers()
Return all the users of Silverpeas
-
getUsers
<T extends User> T[] getUsers(String sPrefixTableName, String sComponentName, String sProfile)
Return all the users with the given profile allowed to access the given component of the given space
-
getUserSilverpeasRolesOn
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 togetUserProfiles(String, String)
,getUserProfiles(String, ProfiledObjectId)
orgetUserProfiles(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.- Parameters:
componentInstanceIdentifier
- the identifier of the component instance.- Returns:
- an optional component instance.
-
getUserProfilesByComponentId
Map<String,Set<String>> getUserProfilesByComponentId(String userId, Collection<String> componentIds)
Gets the profile names of given user indexed by the given component instances.- 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
String[] getUserProfiles(String userId, String componentId, ProfiledObjectId objectId)
-
getUserProfilesByComponentIdAndObjectId
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.- 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
Map<String,List<String>> getUserObjectProfiles(String userId, String componentId, ProfiledObjectType profiledObjectType)
-
getUserProfiles
List<ProfileInst> getUserProfiles(String componentId, ProfiledObjectId objectId)
-
getUserProfile
ProfileInst getUserProfile(String profileId)
-
getAdministratorUserIds
String[] getAdministratorUserIds(String fromUserId)
Return all administrators ids
-
getGroup
<T extends Group> T getGroup(String sGroupId)
Return the Group of the group with the given Id
-
getGroups
<T extends Group> T[] getGroups(String[] groupsId)
Return all groups specified by the groupsIds
-
getAllGroups
<T extends Group> T[] getAllGroups()
Return all the groups of silverpeas
-
getAllRootGroups
<T extends Group> T[] getAllRootGroups()
Return all root groups of silverpeas or null if an error occured when getting the root groups.
-
getAllUsersOfGroup
<T extends User> T[] getAllUsersOfGroup(String groupId)
Get ALL the users that are in a group or his sub groups
-
getUserManageableSpaceIds
String[] getUserManageableSpaceIds(String sUserId)
Return all the spaces Id manageable by given user in Silverpeas
-
getAllRootSpaceIds
String[] getAllRootSpaceIds()
Return all the root spaceIds
-
getAllRootSpaceIds
String[] getAllRootSpaceIds(String sUserId)
Return all the root spaceIds available for the user sUserId
-
getAllSubSpaceIds
String[] getAllSubSpaceIds(String sSpaceId, String sUserId)
Return all the subSpaces Id available in webactiv given a space id (driver format)
-
getAllComponentIds
String[] getAllComponentIds(String sSpaceId)
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.
-
getAllComponentIdsRecur
String[] getAllComponentIdsRecur(String sSpaceId)
Returns all the component identifiers of the space, and its sub spaces, represented by the given identifier.It returns also ids of
SilverpeasPersonalComponentInstance
instances.
-
getRootSpacesContainingComponent
List<SpaceInstLight> getRootSpacesContainingComponent(String userId, String componentName)
-
getSubSpacesContainingComponent
List<SpaceInstLight> getSubSpacesContainingComponent(String spaceId, String userId, String componentName)
-
isToolAvailable
boolean isToolAvailable(String toolId)
-
getAvailableComponentsByUser
List<String> getAvailableComponentsByUser(String userId)
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.- Parameters:
userId
- the unique identifier of a user.- Returns:
- a list of component instance identifier as string.
-
isComponentAvailableToUser
boolean isComponentAvailableToUser(String componentId, String userId)
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.- 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
boolean isComponentAvailableToGroup(String componentId, String groupId)
-
isComponentExist
boolean isComponentExist(String componentId)
-
isObjectAvailableToUser
boolean isObjectAvailableToUser(ProfiledObjectId objectId, String componentId, String userId)
-
isObjectAvailableToGroup
boolean isObjectAvailableToGroup(ProfiledObjectId objectId, String componentId, String groupId)
-
getSpaceTreeview
List<SpaceInstLight> getSpaceTreeview(String userId)
-
getRootSpace
SpaceInstLight getRootSpace(String spaceId)
-
getAllUsersIds
String[] getAllUsersIds()
Return all the users of Silverpeas
-
getUsersIdsByRoleNames
String[] getUsersIdsByRoleNames(String componentId, List<String> profileNames)
Return userIds according to a list of profile names- Parameters:
componentId
- the instance idprofileNames
- the list which contains the profile names- Returns:
- a string array of user id
-
getUsersIdsByRoleNames
String[] getUsersIdsByRoleNames(String componentId, ProfiledObjectId objectId, List<String> profileNames)
-
getAllDomains
Domain[] getAllDomains()
-
getDirectGroupsOfUser
List<GroupDetail> getDirectGroupsOfUser(String userId)
-
isAnonymousAccessActivated
boolean isAnonymousAccessActivated()
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.- Returns:
- true if the anonym access is activated, false otherwise.
-
getUsersOfDomainsFromNewestToOldest
<T extends User> List<T> getUsersOfDomainsFromNewestToOldest(List<String> domainIds)
-
isAdminTool
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.- Parameters:
toolId
- the unique identifier of the tool.- Returns:
- true if the tool belongs to the administration component.
-
getSearchableComponentsByCriteria
List<String> getSearchableComponentsByCriteria(ComponentSearchCriteria criteria)
Gets the identifier of the component instances that are both searchable and that satisfy the specified criteria.- Parameters:
criteria
- the criteria on the component instances to get.- Returns:
- a list of component instance identifiers.
-
getSpaceProfile
SpaceProfile getSpaceProfile(String spaceId, SilverpeasRole role)
Gets the space profile instance which provides all user and group identifiers through simple methods.- Parameters:
spaceId
- the identifier of aimed space.role
- the aimed technical role name.- Returns:
- the
SpaceProfile
instance.
-
getFullTreeview
SpaceWithSubSpacesAndComponents getFullTreeview() throws AdminException
- Throws:
AdminException
-
getFullTreeview
SpaceWithSubSpacesAndComponents getFullTreeview(String userId) throws AdminException
- Throws:
AdminException
-
getFullTreeviewOnComponentName
SpaceWithSubSpacesAndComponents getFullTreeviewOnComponentName(String userId, String componentName) throws AdminException
- Throws:
AdminException
-
getFullTreeview
SpaceWithSubSpacesAndComponents getFullTreeview(String userId, String spaceId) throws AdminException
- Throws:
AdminException
-
getPathToSpace
List<SpaceInstLight> getPathToSpace(String spaceId)
-
getPathToComponent
List<SpaceInstLight> getPathToComponent(String componentId)
-
-