com.stratelia.webactiv.beans.admin
Class Admin

java.lang.Object
  com.stratelia.webactiv.beans.admin.Admin

public class Admin
extends Object

The class Admin is the main class of the Administrator.
The role of the administrator is to create and maintain spaces.

Field Summary

static String	ADMIN_COMPONENT_ID
static String	basketSuffix
static String	SPACE_KEY_PREFIX

Method Summary

void	activateUser(String userId) Activate the user represented by the given identifier.
String	addComponentInst(String sUserId, ComponentInst componentInst)
String	addComponentInst(String userId, ComponentInst componentInst, boolean startNewTransaction) Add the given component instance in Silverpeas.
String	addDomain(Domain theDomain) Create a new domain
String	addGroup(Group group) Add the given group in Silverpeas.
String	addGroup(Group group, boolean onlyInSilverpeas) Add the given group in Silverpeas.
String	addGroupProfileInst(GroupProfileInst spaceProfileInst)
String	addGroupProfileInst(GroupProfileInst groupProfileInst, boolean startNewTransaction) Add the space profile instance from Silverpeas
String	addProfileInst(ProfileInst profileInst)
String	addProfileInst(ProfileInst profileInst, String userId)
String	addSpaceInst(String userId, SpaceInst spaceInst) add a space instance in database
String	addSpaceProfileInst(SpaceProfileInst spaceProfile, String userId)
String	addUser(UserDetail userDetail) Add the given user in Silverpeas and specific domain.
String	addUser(UserDetail userDetail, boolean addOnlyInSilverpeas) Add the given user in Silverpeas and specific domain
void	addUserInGroup(String sUserId, String sGroupId)
void	assignRightsFromGroupToGroup(RightAssignationContext.MODE operationMode, String sourceGroupId, String targetGroupId, boolean nodeAssignRights, String authorId)
void	assignRightsFromGroupToUser(RightAssignationContext.MODE operationMode, String sourceGroupId, String targetUserId, boolean nodeAssignRights, String authorId)
void	assignRightsFromUserToGroup(RightAssignationContext.MODE operationMode, String sourceUserId, String targetGroupId, boolean nodeAssignRights, String authorId)
void	assignRightsFromUserToUser(RightAssignationContext.MODE operationMode, String sourceUserId, String targetUserId, boolean nodeAssignRights, String authorId)
void	blockUser(String userId) Blocks the user represented by the given identifier.
String	copyAndPasteComponent(PasteDetail pasteDetail)
String	copyAndPasteSpace(PasteDetail pasteDetail)
void	createComponentIndex(ComponentInstLight componentInst) Create the index for the specified component.
void	createComponentIndex(String componentId) Create the index for the specified component.
void	createSpaceIndex(int spaceId)
void	createSpaceIndex(SpaceInstLight spaceInst)
void	deactivateUser(String userId) Deactivates the user represented by the given identifier.
String	deleteComponentInst(String userId, String componentId, boolean definitive) Delete the specified component.
String	deleteGroupById(String sGroupId) Delete the group with the given Id The delete is apply recursively to the sub-groups.
String	deleteGroupById(String sGroupId, boolean onlyInSilverpeas) Delete the group with the given Id The delete is apply recursively to the sub-groups.
String	deleteGroupProfileInst(String groupId)
String	deleteGroupProfileInst(String groupId, boolean startNewTransaction) Delete the given space profile from Silverpeas
String	deleteProfileInst(String sProfileId, String userId)
void	deleteSpaceIndex(SpaceInst spaceInst)
String	deleteSpaceInstById(String userId, String spaceId, boolean definitive) Delete the given space The delete is apply recursively to the sub-spaces
String	deleteSpaceInstById(String userId, String spaceId, boolean startNewTransaction, boolean definitive) Delete the given space if it's not the general space The delete is apply recursively to the sub-spaces
String	deleteSpaceProfileInst(String sSpaceProfileId, String userId)
String	deleteUser(String sUserId) Delete the given user from silverpeas and specific domain
String	deleteUser(String sUserId, boolean onlyInSilverpeas) Delete the given user from silverpeas and specific domain
String	getAdministratorEmail() Get administrator Email
String[]	getAdministratorUserIds(String fromUserId) Get the Ids of the administrators
AdminGroupInst[]	getAdminOrganization() Get Silverpeas organization
String[]	getAllComponentIds(String sSpaceId) Return all the components Id in the subspaces available in webactiv given a space id
String[]	getAllComponentIdsRecur(String sSpaceId) Return all the componentIds recursively in the subspaces available in webactiv given a space id
String[]	getAllComponentIdsRecur(String sSpaceId, String sUserId, String componentNameRoot, boolean inCurrentSpace, boolean inAllSpaces) Return all the components Id recursively in (Space+subspaces, or only subspaces or in Silverpeas) available in silverpeas given a userId and a componentNameRoot
Map<String,WAComponent>	getAllComponents() Return all the components of silverpeas read in the xmlComponent directory.
Map<String,String>	getAllComponentsNames() Return all the components name available in Silverpeas.
List<String>	getAllDomainIdsForLogin(String login) Get all domain ids for the specified login.
Domain[]	getAllDomains() Get all domains
String[]	getAllGroupIds() Get the all the groups ids available in Silverpeas.
String[]	getAllowedSubSpaceIds(String userId, String spaceFatherId)
String[]	getAllProfilesNames(String sComponentName) Get all the profiles name available for the given component.
String[]	getAllRootGroupIds() Gets the set of Ids denoting the groups without any parent.
Group[]	getAllRootGroups() Gets all root user groups in Silverpeas.
String[]	getAllRootSpaceIds() Return all the root spaces Ids available in Silverpeas.
String[]	getAllRootSpaceIds(String sUserId) Return all the root spaces Id available in webactiv
String[]	getAllSpaceIds() Return the all the spaces Ids available in Silverpeas.
String[]	getAllSpaceIds(String sUserId)
Map<String,SpaceTemplate>	getAllSpaceTemplates()
String[]	getAllSubGroupIds(String groupId) Gets the set of Ids denoting the direct subgroups of a given group
String[]	getAllSubGroupIdsRecursively(String groupId)
Group[]	getAllSubGroups(String parentGroupId) For use in userPanel : return the direct sub-groups
String[]	getAllSubSpaceIds(String domainFatherId) Get all the subspaces Ids available in Silverpeas given a domainFatherId (client id 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) For use in userPanel : return the total number of users recursively contained in a group
List<UserDetail>	getAllUsers() Get all users (except delete ones) from all domains.
List<UserDetail>	getAllUsersFromNewestToOldest() Get all users (except delete ones) from all domains.
String[]	getAllUsersIds() Get all the users Ids available in Silverpeas
UserDetail[]	getAllUsersOfGroup(String groupId)
String[]	getAvailCompoIds(String userId) Get the component ids allowed for the given user Id.
String[]	getAvailCompoIds(String sClientSpaceId, String sUserId) Get the component ids allowed for the given user Id in the given space
String[]	getAvailCompoIdsAtRoot(String sClientSpaceId, String sUserId) Get ids of components allowed to user in given space (not in subspaces)
List<String>	getAvailCompoIdsAtRoot(String sClientSpaceId, String sUserId, String componentNameRoot) Get the componentIds allowed for the given user Id in the given space and the componentNameRoot
List<ComponentInstLight>	getAvailCompoInSpace(String userId, String spaceId) Get components of a given space (and subspaces) available to a user.
List<ComponentInstLight>	getAvailComponentInstLights(String userId, String componentName) gets the available component for a given user
String[]	getAvailDriverCompoIds(String sClientSpaceId, String sUserId) Get the driver component ids allowed for the given user Id in the given space
String	getClientSpaceId(String sDriverSpaceId) Converts driver space id to client space id
String[]	getClientSpaceIds(String[] asDriverSpaceIds) Converts driver space ids to client space ids
CompoSpace[]	getCompoForUser(String sUserId, String sComponentName) Get the tuples (space id, compo id) allowed for the given user and given component name
String[]	getCompoId(String sComponentName) Return the compo id for the given component name
String[]	getComponentIdsByNameAndUserId(String sUserId, String sComponentName)
ComponentInst	getComponentInst(String sClientComponentId) Return the component Inst corresponding to the given ID
ComponentInstLight	getComponentInstLight(String componentId) Return the component Inst Light corresponding to the given ID
List<Parameter>	getComponentParameters(String componentId) Get the parameters for the given component.
String	getComponentParameterValue(String componentId, String parameterName) Return the value of the parameter for the given component and the given name of parameter
String[]	getCurrentProfiles(String sUserId, ComponentInst componentInst) Get the profile names of the given user for the given component
String[]	getCurrentProfiles(String sUserId, String componentId) Get the profile names of the given user for the given component
String	getDAPIGeneralAdminId() Get the administrator email
String[]	getDirectGroupsIdsOfUser(String userId)
Domain	getDomain(String domainId) Get a domain with given id
long	getDomainActions(String domainId) Get a domain with given id
UserDetail[]	getFiltredDirectUsers(String sGroupId, String sUserLastNameFilter) For use in userPanel : return the users that are direct child of a given group
String	getGeneralSpaceId() Get Enterprise space id.
Group	getGroup(String groupId) Get group information with the given id
Group	getGroupByNameInDomain(String groupName, String domainFatherId) Get group information with the given group name.
String[]	getGroupManageableSpaceIds(String sGroupId) Get the spaces ids manageable by given group Id
String	getGroupName(String sGroupId) Get the group name corresponding to the given group id.
String[]	getGroupNames(String[] groupIds) Get the group names corresponding to the given group ids.
GroupProfileInst	getGroupProfileInst(String groupId) Get the group profile instance corresponding to the given ID
Group[]	getGroups(String[] asGroupId) Get groups information with the given ids.
String	getNextDomainId() Create a new domain
List<SpaceInstLight>	getPathToComponent(String componentId) Retrieve spaces from root to component
List<String>	getPathToGroup(String groupId)
List<SpaceInstLight>	getPathToSpace(String spaceId, boolean includeTarget) Retrieve spaces from root to space identified by spaceId
SpaceInst	getPersonalSpace(String userId)
String[]	getProfileIds(String sUserId) Get all the profiles Id for the given user
String[]	getProfileIdsOfGroup(String sGroupId) Get all the profiles Id for the given group
ProfileInst	getProfileInst(String sProfileId) Get the profile instance corresponding to the given id
String	getProfileLabelfromName(String sComponentName, String sProfileName, String lang) Get the profile label from its name.
List<ProfileInst>	getProfilesByObject(String objectId, String objectType, String componentId)
String[]	getProfilesByObjectAndUserId(int objectId, String objectType, String componentId, String userId)
Map<Integer,List<String>>	getProfilesByObjectTypeAndUserId(String objectType, String componentId, String userId)
List<ComponentInstLight>	getRemovedComponents() Returns all components which has been removed but not definitely deleted.
List<SpaceInstLight>	getRemovedSpaces() Returns all spaces which has been removed but not definitely deleted.
String	getRequestRouter(String sComponentName)
String[]	getRootGroupIdsOfDomain(String domainId)
Group[]	getRootGroupsOfDomain(String domainId)
SpaceInstLight	getRootSpace(String spaceId) Return the higher space according to a subspace (N level compliant)
List<SpaceInstLight>	getRootSpacesContainingComponent(String userId, String componentName) This method returns all root spaces which contains at least one allowed component of type componentName in this space or subspaces.
SpaceInst	getSpaceInstById(String spaceId) Get the space instance with the given space id.
SpaceInst	getSpaceInstFromTemplate(String templateName)
SpaceInstLight	getSpaceInstLightById(String sClientSpaceId) Get the space instance light (only spaceid, fatherId and name) with the given space id
String[]	getSpaceNames(String[] asClientSpaceIds) Return the the spaces name corresponding to the given space ids
SpaceProfileInst	getSpaceProfileInst(String spaceProfileId) Get the space profile instance corresponding to the given ID
List<DomainProperty>	getSpecificPropertiesToImportUsers(String domainId, String language)
List<SpaceInstLight>	getSubSpaces(String spaceId)
List<SpaceInstLight>	getSubSpacesContainingComponent(String spaceId, String userId, String componentName) This method returns all sub spaces which contains at least one allowed component of type componentName in this space or subspaces.
List<SpaceInstLight>	getSubSpacesOfUser(String userId, String spaceId) Get subspaces of a given space available to a user.
Group[]	getSynchronizedGroups()
Map<String,SpaceAndChildren>	getTreeView(String userId, String spaceId)
UserLog[]	getUserConnected() Get the list of connected users
UserDetail	getUserDetail(String sUserId) Get the user detail corresponding to the given user Id
UserDetail[]	getUserDetails(String[] userIds) Get the user details corresponding to the given user Ids.
UserFull	getUserFull(String sUserId) Get the user corresponding to the given user Id (only infos in cache table)
UserFull	getUserFull(String domainId, String specificId)
String	getUserIdByAuthenticationKey(String authenticationKey)
String	getUserIdByLoginAndDomain(String sLogin, String sDomainId) Get the user Id corresponding to Domain/Login
String[]	getUserIdsOfDomain(String domainId)
List<String>	getUserManageableGroupIds(String sUserId)
String[]	getUserManageableSpaceIds(String sUserId) Get the spaces ids manageable by given user Id
String[]	getUserManageableSpaceRootIds(String sUserId) Get the spaces roots ids manageable by given user Id
String[]	getUserManageableSubSpaceIds(String sUserId, String sParentSpaceId) Get the sub space ids manageable by given user Id in given space
String[]	getUserRootSpaceIds(String sUserId) Get the root spaces ids allowed for the given user Id
UserDetail[]	getUsers(boolean bAllProfiles, String sProfile, String sClientSpaceId, String sClientComponentId) if bAllProfiles = true, return all the user details for the given space and given component if bAllProfiles = false, return the user details only for the given profile for the given space and given component
int	getUsersNumberOfDomain(String domainId) this method gets number user in domain.
UserDetail[]	getUsersOfDomain(String domainId)
List<UserDetail>	getUsersOfDomains(List<String> domainIds) Get all users (except delete ones) from specified domains.
List<UserDetail>	getUsersOfDomainsFromNewestToOldest(List<String> domainIds) Get all users (except delete ones) from specified domains.
String[]	getUserSpaceIds(String sUserId) Get the spaces ids allowed for the given user Id
List<SpaceInstLight>	getUserSpaceTreeview(String userId) Get all spaces available to a user.
String[]	getUserSubSpaceIds(String sUserId, String spaceId)
String	identify(String sKey, String sSessionId, boolean isAppInMaintenance) Get the user id for the given login password
String	identify(String sKey, String sSessionId, boolean isAppInMaintenance, boolean removeKey) Get the user id for the given login password
void	indexAllGroups()
void	indexAllUsers()
void	indexGroups(String domainId)
void	indexUsers(String domainId)
protected void	internalSynchronizeGroup(DomainDriver synchroDomain, Group latestGroup, boolean recurs)
boolean	isAnAdminTool(String toolId) Is the specified tool belongs to the administration component?
boolean	isComponentAvailable(String componentId, String userId) Is the specified component instance available among the components instances accessibles by the specified user?
boolean	isComponentManageable(String componentId, String userId)
boolean	isDomainManagerUser(String userId, String domainId)
boolean	isEmailExisting(String email) Checks if an existing user already have the given email
boolean	isGroupExist(String groupName) Tests if group exists in Silverpeas.
boolean	isObjectAvailable(String componentId, int objectId, String objectType, String userId)
boolean	isSpaceAvailable(String userId, String spaceId) This method permit to know if given space is allowed to given user.
boolean	isSpaceInstExist(String spaceId) Tests if a space with given space id exists.
void	migrateUser(UserDetail userDetail, String targetDomainId)
void	moveComponentInst(String spaceId, String componentId, String idComponentBefore, ComponentInst[] componentInsts) Move the given component in Silverpeas.
void	moveSpace(String spaceId, String fatherId)
void	reloadCache()
String	removeDomain(String domainId) Remove a domain
void	removeUserFromGroup(String sUserId, String sGroupId)
void	resetAllDBConnections(boolean isScheduled)
void	restoreComponentFromBasket(String componentId)
void	restoreSpaceFromBasket(String spaceId)
Group[]	searchGroups(Group modelGroup, boolean isAnd)
ListSlice<Group>	searchGroups(GroupsSearchCriteria searchCriteria)
String[]	searchGroupsIds(boolean isRootGroup, String componentId, String[] profileId, Group modelGroup)
UserDetail[]	searchUsers(String domainId, Map<String,String> query)
UserDetail[]	searchUsers(UserDetail modelUser, boolean isAnd)
ListSlice<UserDetail>	searchUsers(UserDetailsSearchCriteria searchCriteria)
String[]	searchUsersIds(String sGroupId, String componentId, String[] profileIds, UserDetail modelUser)
void	setComponentPlace(String componentId, String idComponentBefore, ComponentInst[] m_BrothersComponents)
void	setSpaceProfilesToComponent(ComponentInst component, SpaceInst space)
void	setSpaceProfilesToComponent(ComponentInst component, SpaceInst space, boolean startNewTransaction) Set space profile to a component.
protected void	setSpaceProfilesToSubSpace(SpaceInst subSpace, SpaceInst space, boolean persist, boolean startNewTransaction)
void	startServer()
String	synchronizeGroup(String groupId, boolean recurs)
void	synchronizeGroupByRule(String groupId, boolean scheduledMode)
String	synchronizeImportGroup(String domainId, String groupKey, String askedParentId, boolean recurs, boolean isIdKey)
String	synchronizeImportUser(String domainId, String specificId, boolean recurs) Synchronize Users and groups between cache and domain's datastore
String	synchronizeImportUserByLogin(String domainId, String userLogin, boolean recurs) Synchronize Users and groups between cache and domain's datastore
String	synchronizeRemoveGroup(String groupId)
String	synchronizeRemoveUser(String userId) Synchronize Users and groups between cache and domain's datastore.
String	synchronizeSilverpeasWithDomain(String sDomainId)
String	synchronizeSilverpeasWithDomain(String sDomainId, boolean threaded) Synchronize Users and groups between cache and domain's datastore
String	synchronizeUser(String userId, boolean recurs) Synchronize Users and groups between cache and domain's datastore
void	unblockUser(String userId) Unblock the user represented by the given identifier.
String	updateComponentInst(ComponentInst component) Update the given component in Silverpeas.
void	updateComponentOrderNum(String componentId, int orderNum)
String	updateDomain(Domain domain) Update a domain
String	updateGroup(Group group) Update the given group in Silverpeas and specific.
String	updateGroup(Group group, boolean onlyInSilverpeas) Update the given group in Silverpeas and specific
String	updateGroupProfileInst(GroupProfileInst groupProfileInstNew) Update the given space profile in Silverpeas
String	updateProfileInst(ProfileInst profileInstNew)
String	updateProfileInst(ProfileInst profileInstNew, String userId)
String	updateSpaceInst(SpaceInst spaceInstNew) Updates the space (with the given name) with the given space Updates only the node
void	updateSpaceOrderNum(String spaceId, int orderNum)
String	updateSpaceProfileInst(SpaceProfileInst newSpaceProfile, String userId)
String	updateSpaceProfileInst(SpaceProfileInst newSpaceProfile, String userId, boolean startNewTransaction)
String	updateUser(UserDetail user) Update the given user (ONLY IN SILVERPEAS)
String	updateUserFull(UserFull user) Update the given user in Silverpeas and specific domain
void	userAcceptsTermsOfService(String userId) Updates the acceptance date of a user from its id.

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_COMPONENT_ID

public static final String ADMIN_COMPONENT_ID

See Also:

Constant Field Values

SPACE_KEY_PREFIX

public static final String SPACE_KEY_PREFIX

See Also:

Constant Field Values

basketSuffix

public static final String basketSuffix

See Also:

Constant Field Values

Method Detail

reloadCache

public void reloadCache()

startServer

public void startServer()

getGeneralSpaceId

public String getGeneralSpaceId()

Get Enterprise space id.

Returns:

The general space id

createSpaceIndex

public void createSpaceIndex(int spaceId)

createSpaceIndex

public void createSpaceIndex(SpaceInstLight spaceInst)

deleteSpaceIndex

public void deleteSpaceIndex(SpaceInst spaceInst)

addSpaceInst

public String addSpaceInst(String userId,
                           SpaceInst spaceInst)
                    throws AdminException

add a space instance in database

Parameters:

userId - Id of user who add the space

spaceInst - SpaceInst object containing information about the space to be created

Returns:

the created space id

Throws:

AdminException

deleteSpaceInstById

public String deleteSpaceInstById(String userId,
                                  String spaceId,
                                  boolean definitive)
                           throws AdminException

Delete the given space The delete is apply recursively to the sub-spaces

Parameters:

userId - Id of user who deletes the space

spaceId - Id of the space to be deleted

definitive -

Returns:

the deleted space id

Throws:

AdminException

deleteSpaceInstById

public String deleteSpaceInstById(String userId,
                                  String spaceId,
                                  boolean startNewTransaction,
                                  boolean definitive)
                           throws AdminException

Delete the given space if it's not the general space The delete is apply recursively to the sub-spaces

Parameters:

userId - Id of user who deletes the space

spaceId - Id of the space to be deleted

startNewTransaction - Flag : must be true at first call to initialize transaction, then false for recurrents calls

definitive -

Returns:

the deleted space id

Throws:

AdminException

restoreSpaceFromBasket

public void restoreSpaceFromBasket(String spaceId)
                            throws AdminException

Parameters:

spaceId -

Throws:

AdminException

getSpaceInstById

public SpaceInst getSpaceInstById(String spaceId)
                           throws AdminException

Get the space instance with the given space id.

Parameters:

spaceId - client space id

Returns:

Space information as SpaceInst object.

Throws:

AdminException

getPersonalSpace

public SpaceInst getPersonalSpace(String userId)
                           throws AdminException

Parameters:

userId -

Returns:

Throws:

AdminException

getAllSubSpaceIds

public String[] getAllSubSpaceIds(String domainFatherId)
                           throws AdminException

Get all the subspaces Ids available in Silverpeas given a domainFatherId (client id format)

Parameters:

domainFatherId - Id of the father space

Returns:

an array of String containing the ids of spaces that are child of given space.

Throws:

AdminException

updateSpaceInst

public String updateSpaceInst(SpaceInst spaceInstNew)
                       throws AdminException

Updates the space (with the given name) with the given space Updates only the node

Parameters:

spaceInstNew - SpaceInst object containing new information for space to be updated

Returns:

the updated space id.

Throws:

AdminException

updateSpaceOrderNum

public void updateSpaceOrderNum(String spaceId,
                                int orderNum)
                         throws AdminException

Parameters:

spaceId -

orderNum -

Throws:

AdminException

isSpaceInstExist

public boolean isSpaceInstExist(String spaceId)
                         throws AdminException

Tests if a space with given space id exists.

Parameters:

spaceId - if of space to be tested

Returns:

true if the given space instance name is an existing space

Throws:

AdminException

getAllRootSpaceIds

public String[] getAllRootSpaceIds()
                            throws AdminException

Return all the root spaces Ids available in Silverpeas.

Returns:

all the root spaces Ids available in Silverpeas.

Throws:

AdminException

getPathToComponent

public List<SpaceInstLight> getPathToComponent(String componentId)
                                        throws AdminException

Retrieve spaces from root to component

Parameters:

componentId - the target component

Returns:

a List of SpaceInstLight

Throws:

AdminException

getPathToSpace

public List<SpaceInstLight> getPathToSpace(String spaceId,
                                           boolean includeTarget)
                                    throws AdminException

Retrieve spaces from root to space identified by spaceId

Parameters:

spaceId - the target space

includeTarget -

Returns:

a List of SpaceInstLight

Throws:

AdminException

getAllSpaceIds

public String[] getAllSpaceIds()
                        throws AdminException

Return the all the spaces Ids available in Silverpeas.

Returns:

the all the spaces Ids available in Silverpeas.

Throws:

AdminException

getRemovedSpaces

public List<SpaceInstLight> getRemovedSpaces()
                                      throws AdminException

Returns all spaces which has been removed but not definitely deleted.

Returns:

a List of SpaceInstLight

Throws:

AdminException

getRemovedComponents

public List<ComponentInstLight> getRemovedComponents()
                                              throws AdminException

Returns all components which has been removed but not definitely deleted.

Returns:

a List of ComponentInstLight

Throws:

AdminException

getSpaceNames

public String[] getSpaceNames(String[] asClientSpaceIds)
                       throws AdminException

Return the the spaces name corresponding to the given space ids

Parameters:

asClientSpaceIds -

Returns:

Throws:

AdminException

getAllSpaceTemplates

public Map<String,SpaceTemplate> getAllSpaceTemplates()

getSpaceInstFromTemplate

public SpaceInst getSpaceInstFromTemplate(String templateName)

getAllComponentsNames

public Map<String,String> getAllComponentsNames()

Return all the components name available in Silverpeas.

Returns:

all the components name available in Silverpeas

Throws:

AdminException

getAllComponents

public Map<String,WAComponent> getAllComponents()

Return all the components of silverpeas read in the xmlComponent directory.

Returns:

all the components of silverpeas read in the xmlComponent directory.

getComponentInst

public ComponentInst getComponentInst(String sClientComponentId)
                               throws AdminException

Return the component Inst corresponding to the given ID

Parameters:

sClientComponentId -

Returns:

the component Inst corresponding to the given ID

Throws:

AdminException

getComponentInstLight

public ComponentInstLight getComponentInstLight(String componentId)
                                         throws AdminException

Return the component Inst Light corresponding to the given ID

Parameters:

componentId -

Returns:

the component Inst Light corresponding to the given ID

Throws:

AdminException

getComponentParameters

public List<Parameter> getComponentParameters(String componentId)

Get the parameters for the given component.

Parameters:

componentId -

Returns:

the parameters for the given component.

getComponentParameterValue

public String getComponentParameterValue(String componentId,
                                         String parameterName)

Return the value of the parameter for the given component and the given name of parameter

Parameters:

componentId -

parameterName -

Returns:

the value of the parameter for the given component and the given name of parameter

restoreComponentFromBasket

public void restoreComponentFromBasket(String componentId)
                                throws AdminException

Throws:

AdminException

createComponentIndex

public void createComponentIndex(String componentId)

Create the index for the specified component.

Parameters:

componentId -

createComponentIndex

public void createComponentIndex(ComponentInstLight componentInst)

Create the index for the specified component.

Parameters:

componentInst -

addComponentInst

public String addComponentInst(String sUserId,
                               ComponentInst componentInst)
                        throws AdminException,
                               QuotaException

Throws:

AdminException

QuotaException

addComponentInst

public String addComponentInst(String userId,
                               ComponentInst componentInst,
                               boolean startNewTransaction)
                        throws AdminException,
                               QuotaException

Add the given component instance in Silverpeas.

Parameters:

userId -

componentInst -

startNewTransaction -

Returns:

Throws:

AdminException

QuotaException

deleteComponentInst

public String deleteComponentInst(String userId,
                                  String componentId,
                                  boolean definitive)
                           throws AdminException

Delete the specified component.

Parameters:

userId -

componentId -

definitive -

Returns:

Throws:

AdminException

updateComponentOrderNum

public void updateComponentOrderNum(String componentId,
                                    int orderNum)
                             throws AdminException

Parameters:

componentId -

orderNum -

Throws:

AdminException

updateComponentInst

public String updateComponentInst(ComponentInst component)
                           throws AdminException

Update the given component in Silverpeas.

Parameters:

component -

Returns:

Throws:

AdminException

setSpaceProfilesToSubSpace

protected void setSpaceProfilesToSubSpace(SpaceInst subSpace,
                                          SpaceInst space,
                                          boolean persist,
                                          boolean startNewTransaction)
                                   throws AdminException

Throws:

AdminException

setSpaceProfilesToComponent

public void setSpaceProfilesToComponent(ComponentInst component,
                                        SpaceInst space)
                                 throws AdminException

Throws:

AdminException

setSpaceProfilesToComponent

public void setSpaceProfilesToComponent(ComponentInst component,
                                        SpaceInst space,
                                        boolean startNewTransaction)
                                 throws AdminException

Set space profile to a component. There is persistance.

Parameters:

component - the object to set profiles

space - the object to get profiles

Throws:

AdminException

moveSpace

public void moveSpace(String spaceId,
                      String fatherId)
               throws AdminException

Throws:

AdminException

moveComponentInst

public void moveComponentInst(String spaceId,
                              String componentId,
                              String idComponentBefore,
                              ComponentInst[] componentInsts)
                       throws AdminException

Move the given component in Silverpeas.

Parameters:

spaceId -

componentId -

idComponentBefore -

componentInsts -

Throws:

AdminException

setComponentPlace

public void setComponentPlace(String componentId,
                              String idComponentBefore,
                              ComponentInst[] m_BrothersComponents)
                       throws AdminException

Throws:

AdminException

getRequestRouter

public String getRequestRouter(String sComponentName)

getAllProfilesNames

public String[] getAllProfilesNames(String sComponentName)

Get all the profiles name available for the given component.

Parameters:

sComponentName -

Returns:

Throws:

AdminException

getProfileLabelfromName

public String getProfileLabelfromName(String sComponentName,
                                      String sProfileName,
                                      String lang)

Get the profile label from its name.

Parameters:

sComponentName -

sProfileName -

Returns:

Throws:

AdminException

getProfileInst

public ProfileInst getProfileInst(String sProfileId)
                           throws AdminException

Get the profile instance corresponding to the given id

Parameters:

sProfileId -

Returns:

Throws:

AdminException

getProfilesByObject

public List<ProfileInst> getProfilesByObject(String objectId,
                                             String objectType,
                                             String componentId)
                                      throws AdminException

Throws:

AdminException

getProfilesByObjectAndUserId

public String[] getProfilesByObjectAndUserId(int objectId,
                                             String objectType,
                                             String componentId,
                                             String userId)
                                      throws AdminException

Throws:

AdminException

getProfilesByObjectTypeAndUserId

public Map<Integer,List<String>> getProfilesByObjectTypeAndUserId(String objectType,
                                                                  String componentId,
                                                                  String userId)
                                                           throws AdminException

Throws:

AdminException

isObjectAvailable

public boolean isObjectAvailable(String componentId,
                                 int objectId,
                                 String objectType,
                                 String userId)
                          throws AdminException

Throws:

AdminException

addProfileInst

public String addProfileInst(ProfileInst profileInst)
                      throws AdminException

Throws:

AdminException

addProfileInst

public String addProfileInst(ProfileInst profileInst,
                             String userId)
                      throws AdminException

Throws:

AdminException

deleteProfileInst

public String deleteProfileInst(String sProfileId,
                                String userId)
                         throws AdminException

Throws:

AdminException

updateProfileInst

public String updateProfileInst(ProfileInst profileInstNew)
                         throws AdminException

Throws:

AdminException

updateProfileInst

public String updateProfileInst(ProfileInst profileInstNew,
                                String userId)
                         throws AdminException

Throws:

AdminException

getSpaceProfileInst

public SpaceProfileInst getSpaceProfileInst(String spaceProfileId)
                                     throws AdminException

Get the space profile instance corresponding to the given ID

Parameters:

spaceProfileId -

Returns:

Throws:

AdminException

addSpaceProfileInst

public String addSpaceProfileInst(SpaceProfileInst spaceProfile,
                                  String userId)
                           throws AdminException

Throws:

AdminException

deleteSpaceProfileInst

public String deleteSpaceProfileInst(String sSpaceProfileId,
                                     String userId)
                              throws AdminException

Throws:

AdminException

updateSpaceProfileInst

public String updateSpaceProfileInst(SpaceProfileInst newSpaceProfile,
                                     String userId)
                              throws AdminException

Throws:

AdminException

updateSpaceProfileInst

public String updateSpaceProfileInst(SpaceProfileInst newSpaceProfile,
                                     String userId,
                                     boolean startNewTransaction)
                              throws AdminException

Throws:

AdminException

getGroupNames

public String[] getGroupNames(String[] groupIds)
                       throws AdminException

Get the group names corresponding to the given group ids.

Parameters:

groupIds -

Returns:

Throws:

AdminException

getGroupName

public String getGroupName(String sGroupId)
                    throws AdminException

Get the group name corresponding to the given group id.

Parameters:

sGroupId -

Returns:

Throws:

AdminException

getAllGroupIds

public String[] getAllGroupIds()
                        throws AdminException

Get the all the groups ids available in Silverpeas.

Returns:

Throws:

AdminException

isGroupExist

public boolean isGroupExist(String groupName)
                     throws AdminException

Tests if group exists in Silverpeas.

Parameters:

groupName -

Returns:

true if a group with the given name

Throws:

AdminException

getGroup

public Group getGroup(String groupId)
               throws AdminException

Get group information with the given id

Parameters:

groupId -

Returns:

Throws:

AdminException

getPathToGroup

public List<String> getPathToGroup(String groupId)
                            throws AdminException

Throws:

AdminException

getGroupByNameInDomain

public Group getGroupByNameInDomain(String groupName,
                                    String domainFatherId)
                             throws AdminException

Get group information with the given group name.

Parameters:

groupName -

domainFatherId -

Returns:

Throws:

AdminException

getGroups

public Group[] getGroups(String[] asGroupId)
                  throws AdminException

Get groups information with the given ids.

Parameters:

asGroupId -

Returns:

Throws:

AdminException

addGroup

public String addGroup(Group group)
                throws AdminException

Add the given group in Silverpeas.

Parameters:

group -

Returns:

Throws:

AdminException

addGroup

public String addGroup(Group group,
                       boolean onlyInSilverpeas)
                throws AdminException

Add the given group in Silverpeas.

Parameters:

group -

onlyInSilverpeas -

Returns:

Throws:

AdminException

deleteGroupById

public String deleteGroupById(String sGroupId)
                       throws AdminException

Delete the group with the given Id The delete is apply recursively to the sub-groups.

Parameters:

sGroupId -

Returns:

Throws:

AdminException

deleteGroupById

public String deleteGroupById(String sGroupId,
                              boolean onlyInSilverpeas)
                       throws AdminException

Delete the group with the given Id The delete is apply recursively to the sub-groups.

Parameters:

sGroupId -

onlyInSilverpeas -

Returns:

Throws:

AdminException

updateGroup

public String updateGroup(Group group)
                   throws AdminException

Update the given group in Silverpeas and specific.

Parameters:

group -

Returns:

Throws:

AdminException

updateGroup

public String updateGroup(Group group,
                          boolean onlyInSilverpeas)
                   throws AdminException

Update the given group in Silverpeas and specific

Parameters:

group -

onlyInSilverpeas -

Returns:

Throws:

AdminException

removeUserFromGroup

public void removeUserFromGroup(String sUserId,
                                String sGroupId)
                         throws AdminException

Throws:

AdminException

addUserInGroup

public void addUserInGroup(String sUserId,
                           String sGroupId)
                    throws AdminException

Throws:

AdminException

getAdminOrganization

public AdminGroupInst[] getAdminOrganization()
                                      throws AdminException

Get Silverpeas organization

Throws:

AdminException

getAllSubGroupIds

public String[] getAllSubGroupIds(String groupId)
                           throws AdminException

Gets the set of Ids denoting the direct subgroups of a given group

Parameters:

groupId - The ID of the parent group

Returns:

the Ids as an array of String.

Throws:

AdminException

getAllSubGroupIdsRecursively

public String[] getAllSubGroupIdsRecursively(String groupId)
                                      throws AdminException

Throws:

AdminException

getAllRootGroupIds

public String[] getAllRootGroupIds()
                            throws AdminException

Gets the set of Ids denoting the groups without any parent.

Returns:

the Ids as an array of String.

Throws:

AdminException

getAllRootGroups

public Group[] getAllRootGroups()
                         throws AdminException

Gets all root user groups in Silverpeas. A root group is the group of users without any other parent group.

Returns:

an array of user groups.

Throws:

AdminException - if an error occurs whil getting the root user groups.

getGroupProfileInst

public GroupProfileInst getGroupProfileInst(String groupId)
                                     throws AdminException

Get the group profile instance corresponding to the given ID

Throws:

AdminException

addGroupProfileInst

public String addGroupProfileInst(GroupProfileInst spaceProfileInst)
                           throws AdminException

Throws:

AdminException

addGroupProfileInst

public String addGroupProfileInst(GroupProfileInst groupProfileInst,
                                  boolean startNewTransaction)
                           throws AdminException

Add the space profile instance from Silverpeas

Throws:

AdminException

deleteGroupProfileInst

public String deleteGroupProfileInst(String groupId)
                              throws AdminException

Throws:

AdminException

deleteGroupProfileInst

public String deleteGroupProfileInst(String groupId,
                                     boolean startNewTransaction)
                              throws AdminException

Delete the given space profile from Silverpeas

Throws:

AdminException

updateGroupProfileInst

public String updateGroupProfileInst(GroupProfileInst groupProfileInstNew)
                              throws AdminException

Update the given space profile in Silverpeas

Throws:

AdminException

indexAllGroups

public void indexAllGroups()
                    throws AdminException

Throws:

AdminException

indexGroups

public void indexGroups(String domainId)
                 throws AdminException

Parameters:

domainId -

Throws:

AdminException

getAllUsersIds

public String[] getAllUsersIds()
                        throws AdminException

Get all the users Ids available in Silverpeas

Throws:

AdminException

getUserDetail

public UserDetail getUserDetail(String sUserId)
                         throws AdminException

Get the user detail corresponding to the given user Id

Parameters:

sUserId - the user id.

Returns:

the user detail corresponding to the given user Id

Throws:

AdminException

getUserDetails

public UserDetail[] getUserDetails(String[] userIds)

Get the user details corresponding to the given user Ids.

Parameters:

userIds -

Returns:

the user details corresponding to the given user Ids.

Throws:

AdminException

getAllUsers

public List<UserDetail> getAllUsers()
                             throws AdminException

Get all users (except delete ones) from all domains.

Returns:

the user details from all domains sort by alphabetical order

Throws:

AdminException

getAllUsersFromNewestToOldest

public List<UserDetail> getAllUsersFromNewestToOldest()
                                               throws AdminException

Get all users (except delete ones) from all domains.

Returns:

the user details from all domains sort by reverse creation order

Throws:

AdminException

isEmailExisting

public boolean isEmailExisting(String email)
                        throws AdminException

Checks if an existing user already have the given email

Parameters:

email - email to check

Returns:

true if at least one user with given email is found

Throws:

AdminException

getUserIdByLoginAndDomain

public String getUserIdByLoginAndDomain(String sLogin,
                                        String sDomainId)
                                 throws AdminException

Get the user Id corresponding to Domain/Login

Parameters:

sLogin -

sDomainId -

Returns:

Throws:

AdminException

getUserIdByAuthenticationKey

public String getUserIdByAuthenticationKey(String authenticationKey)
                                    throws Exception

Parameters:

authenticationKey - The authentication key.

Returns:

The user id corresponding to the authentication key.

Throws:

Exception

getUserFull

public UserFull getUserFull(String sUserId)
                     throws AdminException

Get the user corresponding to the given user Id (only infos in cache table)

Parameters:

sUserId -

Returns:

Throws:

AdminException

getUserFull

public UserFull getUserFull(String domainId,
                            String specificId)
                     throws Exception

Throws:

Exception

addUser

public String addUser(UserDetail userDetail)
               throws AdminException

Add the given user in Silverpeas and specific domain.

Parameters:

userDetail -

Returns:

the new user id.

Throws:

AdminException

addUser

public String addUser(UserDetail userDetail,
                      boolean addOnlyInSilverpeas)
               throws AdminException

Add the given user in Silverpeas and specific domain

Parameters:

userDetail - user to add

addOnlyInSilverpeas - true if user must not be added in distant datasource (used by synchronization tools)

Returns:

id of created user

Throws:

AdminException

migrateUser

public void migrateUser(UserDetail userDetail,
                        String targetDomainId)
                 throws AdminException

Throws:

AdminException

blockUser

public void blockUser(String userId)
               throws AdminException

Blocks the user represented by the given identifier.

Parameters:

userId -

Throws:

AdminException

unblockUser

public void unblockUser(String userId)
                 throws AdminException

Unblock the user represented by the given identifier.

Parameters:

userId -

Throws:

AdminException

deactivateUser

public void deactivateUser(String userId)
                    throws AdminException

Deactivates the user represented by the given identifier.

Parameters:

userId -

Throws:

AdminException

activateUser

public void activateUser(String userId)
                  throws AdminException

Activate the user represented by the given identifier.

Parameters:

userId -

Throws:

AdminException

userAcceptsTermsOfService

public void userAcceptsTermsOfService(String userId)
                               throws AdminException

Updates the acceptance date of a user from its id.

Parameters:

userId -

Throws:

AdminException

deleteUser

public String deleteUser(String sUserId)
                  throws AdminException

Delete the given user from silverpeas and specific domain

Throws:

AdminException

deleteUser

public String deleteUser(String sUserId,
                         boolean onlyInSilverpeas)
                  throws AdminException

Delete the given user from silverpeas and specific domain

Throws:

AdminException

updateUser

public String updateUser(UserDetail user)
                  throws AdminException

Update the given user (ONLY IN SILVERPEAS)

Throws:

AdminException

updateUserFull

public String updateUserFull(UserFull user)
                      throws AdminException

Update the given user in Silverpeas and specific domain

Throws:

AdminException

getClientSpaceId

public String getClientSpaceId(String sDriverSpaceId)

Converts driver space id to client space id

getClientSpaceIds

public String[] getClientSpaceIds(String[] asDriverSpaceIds)
                           throws Exception

Converts driver space ids to client space ids

Throws:

Exception

getNextDomainId

public String getNextDomainId()
                       throws AdminException

Create a new domain

Throws:

AdminException

addDomain

public String addDomain(Domain theDomain)
                 throws AdminException

Create a new domain

Throws:

AdminException

updateDomain

public String updateDomain(Domain domain)
                    throws AdminException

Update a domain

Throws:

AdminException

removeDomain

public String removeDomain(String domainId)
                    throws AdminException

Remove a domain

Throws:

AdminException

getAllDomains

public Domain[] getAllDomains()
                       throws AdminException

Get all domains

Throws:

AdminException

getAllDomainIdsForLogin

public List<String> getAllDomainIdsForLogin(String login)
                                     throws AdminException

Get all domain ids for the specified login.

Throws:

AdminException

getDomain

public Domain getDomain(String domainId)
                 throws AdminException

Get a domain with given id

Throws:

AdminException

getDomainActions

public long getDomainActions(String domainId)
                      throws AdminException

Get a domain with given id

Throws:

AdminException

getRootGroupsOfDomain

public Group[] getRootGroupsOfDomain(String domainId)
                              throws AdminException

Throws:

AdminException

getSynchronizedGroups

public Group[] getSynchronizedGroups()
                              throws AdminException

Throws:

AdminException

getRootGroupIdsOfDomain

public String[] getRootGroupIdsOfDomain(String domainId)
                                 throws AdminException

Throws:

AdminException

getAllUsersOfGroup

public UserDetail[] getAllUsersOfGroup(String groupId)
                                throws AdminException

Throws:

AdminException

getUsersOfDomain

public UserDetail[] getUsersOfDomain(String domainId)
                              throws AdminException

Throws:

AdminException

getUsersOfDomains

public List<UserDetail> getUsersOfDomains(List<String> domainIds)
                                   throws AdminException

Get all users (except delete ones) from specified domains.

Returns:

the user details from specified domains sort by alphabetical order

Throws:

AdminException

getUsersOfDomainsFromNewestToOldest

public List<UserDetail> getUsersOfDomainsFromNewestToOldest(List<String> domainIds)
                                                     throws AdminException

Get all users (except delete ones) from specified domains.

Returns:

the user details from specified domains sort by reverse creation order

Throws:

AdminException

getUserIdsOfDomain

public String[] getUserIdsOfDomain(String domainId)
                            throws AdminException

Throws:

AdminException

identify

public String identify(String sKey,
                       String sSessionId,
                       boolean isAppInMaintenance)
                throws AdminException

Get the user id for the given login password

Throws:

AdminException

identify

public String identify(String sKey,
                       String sSessionId,
                       boolean isAppInMaintenance,
                       boolean removeKey)
                throws AdminException

Get the user id for the given login password

Throws:

AdminException

getDirectGroupsIdsOfUser

public String[] getDirectGroupsIdsOfUser(String userId)
                                  throws AdminException

Throws:

AdminException

searchUsers

public UserDetail[] searchUsers(UserDetail modelUser,
                                boolean isAnd)
                         throws AdminException

Throws:

AdminException

searchGroups

public Group[] searchGroups(Group modelGroup,
                            boolean isAnd)
                     throws AdminException

Throws:

AdminException

getUserSpaceIds

public String[] getUserSpaceIds(String sUserId)
                         throws AdminException

Get the spaces ids allowed for the given user Id

Throws:

AdminException

getUserRootSpaceIds

public String[] getUserRootSpaceIds(String sUserId)
                             throws AdminException

Get the root spaces ids allowed for the given user Id

Throws:

AdminException

getUserSubSpaceIds

public String[] getUserSubSpaceIds(String sUserId,
                                   String spaceId)
                            throws AdminException

Throws:

AdminException

isSpaceAvailable

public boolean isSpaceAvailable(String userId,
                                String spaceId)
                         throws AdminException

This method permit to know if given space is allowed to given user.

Parameters:

userId -

spaceId -

Returns:

true if user is allowed to access to one component (at least) in given space, false otherwise.

Throws:

AdminException

getSubSpacesOfUser

public List<SpaceInstLight> getSubSpacesOfUser(String userId,
                                               String spaceId)
                                        throws AdminException

Get subspaces of a given space available to a user.

Parameters:

userId -

spaceId -

Returns:

a list of SpaceInstLight

Throws:

AdminException

getSubSpaces

public List<SpaceInstLight> getSubSpaces(String spaceId)
                                  throws AdminException

Throws:

AdminException

getAvailCompoInSpace

public List<ComponentInstLight> getAvailCompoInSpace(String userId,
                                                     String spaceId)
                                              throws AdminException

Get components of a given space (and subspaces) available to a user.

Parameters:

userId -

spaceId -

Returns:

a list of ComponentInstLight

Throws:

AdminException

getTreeView

public Map<String,SpaceAndChildren> getTreeView(String userId,
                                                String spaceId)
                                         throws AdminException

Throws:

AdminException

getUserSpaceTreeview

public List<SpaceInstLight> getUserSpaceTreeview(String userId)
                                          throws Exception

Get all spaces available to a user. N levels compliant. Infos of each space are in SpaceInstLight object.

Parameters:

userId -

Returns:

an ordered list of SpaceInstLight. Built according a depth-first algorithm.

Throws:

Exception

getAllowedSubSpaceIds

public String[] getAllowedSubSpaceIds(String userId,
                                      String spaceFatherId)
                               throws AdminException

Throws:

AdminException

getSpaceInstLightById

public SpaceInstLight getSpaceInstLightById(String sClientSpaceId)
                                     throws AdminException

Get the space instance light (only spaceid, fatherId and name) with the given space id

Parameters:

sClientSpaceId - client space id (as WAxx)

Returns:

Space information as SpaceInstLight object

Throws:

AdminException

getRootSpace

public SpaceInstLight getRootSpace(String spaceId)
                            throws AdminException

Return the higher space according to a subspace (N level compliant)

Parameters:

spaceId - the subspace id

Returns:

a SpaceInstLight object

Throws:

AdminException

getGroupManageableSpaceIds

public String[] getGroupManageableSpaceIds(String sGroupId)
                                    throws AdminException

Get the spaces ids manageable by given group Id

Throws:

AdminException

getUserManageableSpaceIds

public String[] getUserManageableSpaceIds(String sUserId)
                                   throws AdminException

Get the spaces ids manageable by given user Id

Throws:

AdminException

getUserManageableSpaceRootIds

public String[] getUserManageableSpaceRootIds(String sUserId)
                                       throws AdminException

Get the spaces roots ids manageable by given user Id

Throws:

AdminException

getUserManageableSubSpaceIds

public String[] getUserManageableSubSpaceIds(String sUserId,
                                             String sParentSpaceId)
                                      throws AdminException

Get the sub space ids manageable by given user Id in given space

Throws:

AdminException

getUserManageableGroupIds

public List<String> getUserManageableGroupIds(String sUserId)
                                       throws AdminException

Throws:

AdminException

getAvailCompoIds

public String[] getAvailCompoIds(String sClientSpaceId,
                                 String sUserId)
                          throws AdminException

Get the component ids allowed for the given user Id in the given space

Throws:

AdminException

isAnAdminTool

public boolean isAnAdminTool(String toolId)

Is the specified tool belongs to the administration component?

The administration component (or administrive 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.

isComponentAvailable

public boolean isComponentAvailable(String componentId,
                                    String userId)
                             throws AdminException

Is the specified component instance available among the components instances accessibles 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 instanciated 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.

Throws:

AdminException

isComponentManageable

public boolean isComponentManageable(String componentId,
                                     String userId)
                              throws AdminException

Throws:

AdminException

getAvailCompoIdsAtRoot

public String[] getAvailCompoIdsAtRoot(String sClientSpaceId,
                                       String sUserId)
                                throws AdminException

Get ids of components allowed to user in given space (not in subspaces)

Returns:

an array of componentId (kmelia12, hyperlink145...)

Throws:

AdminException

getAvailCompoIdsAtRoot

public List<String> getAvailCompoIdsAtRoot(String sClientSpaceId,
                                           String sUserId,
                                           String componentNameRoot)
                                    throws AdminException

Get the componentIds allowed for the given user Id in the given space and the componentNameRoot

Parameters:

sClientSpaceId -

sUserId -

componentNameRoot -

Returns:

ArrayList of componentIds

Throws:

AdminException

getAvailCompoIds

public String[] getAvailCompoIds(String userId)
                          throws AdminException

Get the component ids allowed for the given user Id.

Parameters:

userId -

Throws:

AdminException

getAvailDriverCompoIds

public String[] getAvailDriverCompoIds(String sClientSpaceId,
                                       String sUserId)
                                throws AdminException

Get the driver component ids allowed for the given user Id in the given space

Throws:

AdminException

getComponentIdsByNameAndUserId

public String[] getComponentIdsByNameAndUserId(String sUserId,
                                               String sComponentName)
                                        throws AdminException

Throws:

AdminException

getAvailComponentInstLights

public List<ComponentInstLight> getAvailComponentInstLights(String userId,
                                                            String componentName)
                                                     throws AdminException

gets the available component for a given user

Parameters:

userId - user identifier used to get component

componentName - type of component to retrieve ( for example : kmelia, forums, blog)

Returns:

a list of ComponentInstLight object

Throws:

AdminException

getRootSpacesContainingComponent

public List<SpaceInstLight> getRootSpacesContainingComponent(String userId,
                                                             String componentName)
                                                      throws AdminException

This method returns all root spaces which contains at least one allowed component of type componentName in this space or subspaces.

Parameters:

userId -

componentName - the component type (kmelia, gallery...)

Returns:

a list of root spaces

Throws:

AdminException

getSubSpacesContainingComponent

public List<SpaceInstLight> getSubSpacesContainingComponent(String spaceId,
                                                            String userId,
                                                            String componentName)
                                                     throws AdminException

This method returns all sub spaces which contains at least one allowed component of type componentName in this space or subspaces.

Parameters:

userId -

componentName - the component type (kmelia, gallery...)

Returns:

a list of root spaces

Throws:

AdminException

getCompoForUser

public CompoSpace[] getCompoForUser(String sUserId,
                                    String sComponentName)
                             throws AdminException

Get the tuples (space id, compo id) allowed for the given user and given component name

Throws:

AdminException

getCompoId

public String[] getCompoId(String sComponentName)
                    throws AdminException

Return the compo id for the given component name

Throws:

AdminException

getProfileIds

public String[] getProfileIds(String sUserId)
                       throws AdminException

Get all the profiles Id for the given user

Throws:

AdminException

getProfileIdsOfGroup

public String[] getProfileIdsOfGroup(String sGroupId)
                              throws AdminException

Get all the profiles Id for the given group

Throws:

AdminException

getCurrentProfiles

public String[] getCurrentProfiles(String sUserId,
                                   ComponentInst componentInst)

Get the profile names of the given user for the given component

getCurrentProfiles

public String[] getCurrentProfiles(String sUserId,
                                   String componentId)
                            throws AdminException

Get the profile names of the given user for the given component

Throws:

AdminException

getUsers

public UserDetail[] getUsers(boolean bAllProfiles,
                             String sProfile,
                             String sClientSpaceId,
                             String sClientComponentId)
                      throws AdminException

if bAllProfiles = true, return all the user details for the given space and given component if bAllProfiles = false, return the user details only for the given profile for the given space and given component

Throws:

AdminException

getAllSubGroups

public Group[] getAllSubGroups(String parentGroupId)
                        throws AdminException

For use in userPanel : return the direct sub-groups

Throws:

AdminException

getFiltredDirectUsers

public UserDetail[] getFiltredDirectUsers(String sGroupId,
                                          String sUserLastNameFilter)
                                   throws AdminException

For use in userPanel : return the users that are direct child of a given group

Throws:

AdminException

getAllSubUsersNumber

public int getAllSubUsersNumber(String sGroupId)
                         throws AdminException

For use in userPanel : return the total number of users recursively contained in a group

Throws:

AdminException

getUsersNumberOfDomain

public int getUsersNumberOfDomain(String domainId)
                           throws AdminException

this method gets number user in domain. If domain id is null, it returns number user of all domain

Throws:

AdminException

getAdministratorUserIds

public String[] getAdministratorUserIds(String fromUserId)
                                 throws AdminException

Get the Ids of the administrators

Throws:

AdminException

getAdministratorEmail

public String getAdministratorEmail()

Get administrator Email

Returns:

String

getDAPIGeneralAdminId

public String getDAPIGeneralAdminId()

Get the administrator email

getUserConnected

public UserLog[] getUserConnected()

Get the list of connected users

getAllSpaceIds

public String[] getAllSpaceIds(String sUserId)
                        throws Exception

Throws:

Exception

getAllRootSpaceIds

public String[] getAllRootSpaceIds(String sUserId)
                            throws Exception

Return all the root spaces Id available in webactiv

Throws:

Exception

getAllSubSpaceIds

public String[] getAllSubSpaceIds(String sSpaceId,
                                  String sUserId)
                           throws Exception

Return all the subSpaces Id available in webactiv given a space id (driver format)

Throws:

Exception

getAllComponentIds

public String[] getAllComponentIds(String sSpaceId)
                            throws Exception

Return all the components Id in the subspaces available in webactiv given a space id

Throws:

Exception

getAllComponentIdsRecur

public String[] getAllComponentIdsRecur(String sSpaceId)
                                 throws Exception

Return all the componentIds recursively in the subspaces available in webactiv given a space id

Throws:

Exception

getAllComponentIdsRecur

public String[] getAllComponentIdsRecur(String sSpaceId,
                                        String sUserId,
                                        String componentNameRoot,
                                        boolean inCurrentSpace,
                                        boolean inAllSpaces)
                                 throws Exception

Return all the components Id recursively in (Space+subspaces, or only subspaces or in Silverpeas) available in silverpeas given a userId and a componentNameRoot

Parameters:

sSpaceId -

sUserId -

componentNameRoot -

inCurrentSpace -

inAllSpaces -

Returns:

Array of componentsIds

Throws:

Exception

synchronizeGroupByRule

public void synchronizeGroupByRule(String groupId,
                                   boolean scheduledMode)
                            throws AdminException

Throws:

AdminException

synchronizeGroup

public String synchronizeGroup(String groupId,
                               boolean recurs)
                        throws Exception

Throws:

Exception

synchronizeImportGroup

public String synchronizeImportGroup(String domainId,
                                     String groupKey,
                                     String askedParentId,
                                     boolean recurs,
                                     boolean isIdKey)
                              throws Exception

Throws:

Exception

synchronizeRemoveGroup

public String synchronizeRemoveGroup(String groupId)
                              throws Exception

Throws:

Exception

internalSynchronizeGroup

protected void internalSynchronizeGroup(DomainDriver synchroDomain,
                                        Group latestGroup,
                                        boolean recurs)
                                 throws Exception

Throws:

Exception

synchronizeUser

public String synchronizeUser(String userId,
                              boolean recurs)
                       throws Exception

Synchronize Users and groups between cache and domain's datastore

Throws:

Exception

synchronizeImportUserByLogin

public String synchronizeImportUserByLogin(String domainId,
                                           String userLogin,
                                           boolean recurs)
                                    throws Exception

Synchronize Users and groups between cache and domain's datastore

Throws:

Exception

synchronizeImportUser

public String synchronizeImportUser(String domainId,
                                    String specificId,
                                    boolean recurs)
                             throws Exception

Synchronize Users and groups between cache and domain's datastore

Throws:

Exception

getSpecificPropertiesToImportUsers

public List<DomainProperty> getSpecificPropertiesToImportUsers(String domainId,
                                                               String language)
                                                        throws Exception

Throws:

Exception

searchUsers

public UserDetail[] searchUsers(String domainId,
                                Map<String,String> query)
                         throws Exception

Throws:

Exception

synchronizeRemoveUser

public String synchronizeRemoveUser(String userId)
                             throws Exception

Synchronize Users and groups between cache and domain's datastore.

Parameters:

userId -

Returns:

Throws:

Exception

synchronizeSilverpeasWithDomain

public String synchronizeSilverpeasWithDomain(String sDomainId)
                                       throws Exception

Throws:

Exception

synchronizeSilverpeasWithDomain

public String synchronizeSilverpeasWithDomain(String sDomainId,
                                              boolean threaded)
                                       throws AdminException

Synchronize Users and groups between cache and domain's datastore

Throws:

AdminException

searchUsersIds

public String[] searchUsersIds(String sGroupId,
                               String componentId,
                               String[] profileIds,
                               UserDetail modelUser)
                        throws AdminException

Throws:

AdminException

searchUsers

public ListSlice<UserDetail> searchUsers(UserDetailsSearchCriteria searchCriteria)
                                  throws AdminException

Throws:

AdminException

searchGroups

public ListSlice<Group> searchGroups(GroupsSearchCriteria searchCriteria)
                              throws AdminException

Throws:

AdminException

searchGroupsIds

public String[] searchGroupsIds(boolean isRootGroup,
                                String componentId,
                                String[] profileId,
                                Group modelGroup)
                         throws AdminException

Throws:

AdminException

resetAllDBConnections

public void resetAllDBConnections(boolean isScheduled)
                           throws AdminException

Throws:

AdminException

indexAllUsers

public void indexAllUsers()
                   throws AdminException

Throws:

AdminException

indexUsers

public void indexUsers(String domainId)
                throws AdminException

Throws:

AdminException

copyAndPasteComponent

public String copyAndPasteComponent(PasteDetail pasteDetail)
                             throws AdminException,
                                    QuotaException

Throws:

AdminException

QuotaException

copyAndPasteSpace

public String copyAndPasteSpace(PasteDetail pasteDetail)
                         throws AdminException,
                                QuotaException

Throws:

AdminException

QuotaException

assignRightsFromUserToUser

public void assignRightsFromUserToUser(RightAssignationContext.MODE operationMode,
                                       String sourceUserId,
                                       String targetUserId,
                                       boolean nodeAssignRights,
                                       String authorId)
                                throws AdminException

Throws:

AdminException

assignRightsFromUserToGroup

public void assignRightsFromUserToGroup(RightAssignationContext.MODE operationMode,
                                        String sourceUserId,
                                        String targetGroupId,
                                        boolean nodeAssignRights,
                                        String authorId)
                                 throws AdminException

Throws:

AdminException

assignRightsFromGroupToUser

public void assignRightsFromGroupToUser(RightAssignationContext.MODE operationMode,
                                        String sourceGroupId,
                                        String targetUserId,
                                        boolean nodeAssignRights,
                                        String authorId)
                                 throws AdminException

Throws:

AdminException

assignRightsFromGroupToGroup

public void assignRightsFromGroupToGroup(RightAssignationContext.MODE operationMode,
                                         String sourceGroupId,
                                         String targetGroupId,
                                         boolean nodeAssignRights,
                                         String authorId)
                                  throws AdminException

Throws:

AdminException

isDomainManagerUser

public boolean isDomainManagerUser(String userId,
                                   String domainId)

Parameters:

userId - the user identifier

domainId - the domain identifier

Returns:

true if user identified by given userId is the manager of given domain identifier