com.microfocus.silkcentral.webservices.administration

Class AdministrationService

java.lang.Object

com.microfocus.silkcentral.webservices.administration.AdministrationService

public class AdministrationService
extends java.lang.Object

Provides basic functionality for the administration area of Silk Central.

Constructor Summary

Constructors

Constructor and Description
AdministrationService()

Method Summary

Modifier and Type	Method and Description
void	activateExecServer(java.lang.String sessionId, int execServerId, int locationId) Activates an existing execution server if it is not already active.
void	activateProjects(java.lang.String sessionId, int[] projectIds) Activates the projects with the given IDs.
boolean	addBuild(java.lang.String sessionId, java.lang.String product, java.lang.String version, java.lang.String build, java.lang.String descr, boolean isActive) Adds a new build for the given product and version.
boolean	addLocationToProject(java.lang.String sessionId, int projectId, int locationId) Adds an association from a location to a project.
boolean	addVersion(java.lang.String sessionId, java.lang.String product, java.lang.String version, java.lang.String descr, boolean isActive) Adds a new version for the given product.
int	copyProject(java.lang.String sessionId, int projectId, java.lang.String newProjectName, java.lang.String[] copyProjectProperties) Copies a project including the data selected in copyProjectProperties.
int	createExecServer(java.lang.String sessionId, ExecServer execServer) Creates a new execution sever with the given properties.
int	createLocation(java.lang.String sessionId, LocationDetails locationDetails) Creates a new location with the data provided by the location details.
int	createProject(java.lang.String sessionId, Project project) Creates a new project with the given properties.
int	createUser(java.lang.String sessionId, UserDetails userDetails) Creates a new user with the data of the given userDetails - the login has to be unique.
int	createUsergroup(java.lang.String sessionId, UserGroup userGroup) Creates a new UserGroup.
void	deactivateExecServer(java.lang.String sessionId, int execServerId) Deactivates an existing execution server if it is active.
void	deactivateProjects(java.lang.String sessionId, int[] projectIds) Deactivates the projects with the given IDs.
void	deleteExecServer(java.lang.String sessionId, int execServerId) Deletes the execution server identified by the ID.
void	deleteLocations(java.lang.String sessionId, int[] locationIds) Deletes the location identified by the locationId (only if no execution servers exist for the location).
void	deleteProjects(java.lang.String sessionId, int[] projectIds) Deletes projects with the given IDs (if the logged in user has the right to do so).
void	deleteRoleByName(java.lang.String sessionId, java.lang.String deletedRoleName) Deletes a role by the specified name.
void	deleteUserGroup(java.lang.String sessionId, int groupId) Deletes the user group identified by ID.
void	deleteUsers(java.lang.String sessionId, int[] userIdsToDelete) Deletes existing users (identified by the IDs).
int	duplicateRole(java.lang.String sessionId, int roleId, java.lang.String newRoleName, java.lang.String newRoleDesc) Duplicates a role and returns the new role ID.
Project[]	findProjects(java.lang.String sessionId, java.lang.String projectName) Returns all projects assigned to the logged in user (or all projects if the user is an administrator) with the given name (wildcards * and ? are allowed).
java.lang.String[]	getActiveVersions(java.lang.String sessionId, java.lang.String product) Returns names of active versions associated with the given product.
UserGroupMembership[]	getAllMemberships(java.lang.String sessionId) Returns all memberships.
Role[]	getAllRoles(java.lang.String sessionId) Returns all roles.
UserGroup[]	getAllUserGroups(java.lang.String sessionId) Returns all user groups.
java.lang.String[]	getBuilds(java.lang.String sessionId, java.lang.String product, java.lang.String version) Returns all build names associated with the given product and version.
java.lang.String[]	getComponents(java.lang.String sessionId, java.lang.String product) Returns all component names associated with a given project.
ExecServer	getExecServerById(java.lang.String sessionId, int execServerId) Returns the execution server identified by the given ID.
java.lang.String[]	getExecServerKeywords(java.lang.String sessionId, int execServerId) Returns the keywords set for the specified execution server (includes #-prefixed predefined keywords).
ExecServer[]	getExecServersOfLocation(java.lang.String sessionId, int locationId) Returns the execution servers of a location.
UserGroup	getGroupById(java.lang.String sessionId, int groupId) Returns a user group with the given ID.
UserGroup	getGroupByName(java.lang.String sessionId, java.lang.String groupName) Returns a user group with the given name.
LocationDetails	getLocationDetails(java.lang.String sessionId, int locationId) Returns detailed information about the location identified by the ID.
Location[]	getLocations(java.lang.String sessionId) Returns all defined locations.
Location[]	getLocationsForProject(java.lang.String sessionId, int projectId) Returns all locations associated with the given project.
UserGroupMembership[]	getMembershipsOfGroup(java.lang.String sessionId, int groupId) Returns all memberships of the user group identified by ID.
UserGroupMembership[]	getMembershipsOfUser(java.lang.String sessionId, int userId) Returns all memberships of the user identified by ID.
java.lang.String[]	getPlatforms(java.lang.String sessionId) Returns all platform names associated with the Silk Central installation.
java.lang.String	getProductNameById(java.lang.String sessionId, int productId) Returns the product name for the given product ID.
java.lang.String[]	getProducts(java.lang.String sessionId) Returns all product names for a given Silk Central installation.
Project	getProjectById(java.lang.String sessionId, int projectId) Returns the project with the given ID.
java.lang.String[]	getProjectNames(java.lang.String sessionId) Returns all project names associated with the Silk Central installation.
Project[]	getProjects(java.lang.String sessionId) Returns all projects visible to this user.
Project[]	getProjectsForUser(java.lang.String sessionId, int userId) Returns all projects that meet the filter specified criteria.
Role	getRoleById(java.lang.String sessionId, int roleId) Returns a role identified by ID.
int	getRoleIdByName(java.lang.String sessionId, java.lang.String roleName) Returns the role ID.
UserDetails	getUserDetails(java.lang.String sessionId, int userId) Returns details of a user (identified by ID).
User[]	getUsers(java.lang.String sessionId, java.lang.String login) Returns all users matching the given login name.
java.lang.String[]	getVersions(java.lang.String sessionId, java.lang.String product) Returns all version names associated with the given product.
boolean	isBuildActive(java.lang.String sessionId, java.lang.String product, java.lang.String version, java.lang.String build) Checks if a build is active.
boolean	isMixedModeAuthentication(java.lang.String sessionId, int userId) Returns the information if mixed mode authentication is active for a user.
java.lang.String	logonUser(java.lang.String username, java.lang.String plainPwd) Logs on with a given username and password.
boolean	removeLocationFromProject(java.lang.String sessionId, int projectId, int locationId) Removes an association from a location to a project.
void	setBuildActive(java.lang.String sessionId, java.lang.String product, java.lang.String version, java.lang.String build, boolean active) Activates/deactivates a build.
void	setMixedModeAuthentication(java.lang.String sessionId, int userId, boolean useMixedMode) Sets the authentication mode for a user.
void	setProxyUsernameAndPasswordForLocation(java.lang.String sessionId, int locationId, java.lang.String proxyUsername, java.lang.String proxyPassword) Sets proxy username and password for a location (identified by locationId).
void	updateExecServer(java.lang.String sessionId, ExecServer execServer) Updates the properties of an existing execution server.
void	updateExecServerKeywords(java.lang.String sessionId, int execServerId, java.lang.String[] keywords) Sets the custom keywords for an execution server.
void	updateLocation(java.lang.String sessionId, LocationDetails locationDetails) Updates an existing location (identified by the ID) with the data provided by the location details.
void	updateMembershipsOfGroup(java.lang.String sessionId, int groupId, UserGroupMembership[] memberships) Updates the memberships of a group.
void	updateMembershipsOfUser(java.lang.String sessionId, int userId, UserGroupMembership[] memberships) Updates the memberships of a user.
void	updateProject(java.lang.String sessionId, Project project) Updates an existing project with the given properties.
void	updateUser(java.lang.String sessionId, UserDetails userDetails) Updates the properties of an existing user.
void	updateUserGroup(java.lang.String sessionId, UserGroup usergroup) Updates an existing user group.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdministrationService

public AdministrationService()

Method Detail

logonUser

public java.lang.String logonUser(java.lang.String username,
                                  java.lang.String plainPwd)
                           throws WSFaultException

Logs on with a given username and password. The returned session identifier can be used in subsequent calls. The session created with the method expires when it is not used for a period of time.
Note: When accessing Silk Central through web-service calls, Micro Focus recommends using a web-service token instead of a session identifier for authenticating. You can generate a web-service token in the Silk Central UI.

Parameters:

username - the login username

plainPwd - the password of the specified username

Returns:

a unique identifier (used as a key) identifying the session created with the method

Throws:

WSFaultException - if logon fails

getProjects

public Project[] getProjects(java.lang.String sessionId)
                      throws WSFaultException

Returns all projects visible to this user.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Returns:

an array of all projects found

Throws:

WSFaultException

findProjects

public Project[] findProjects(java.lang.String sessionId,
                              java.lang.String projectName)
                       throws WSFaultException

Returns all projects assigned to the logged in user (or all projects if the user is an administrator) with the given name (wildcards * and ? are allowed).

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectName - name of the project to return (wildcards ? and * are allowed)

Returns:

an array of all projects found

Throws:

WSFaultException

getProjectsForUser

public Project[] getProjectsForUser(java.lang.String sessionId,
                                    int userId)
                             throws WSFaultException

Returns all projects that meet the filter specified criteria.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userId - the unique ID of the user to return projects for or -1 if projects for all users should be returned

Returns:

an array of projects that meet the filter criteria specified

Throws:

WSFaultException

getProjectById

public Project getProjectById(java.lang.String sessionId,
                              int projectId)
                       throws WSFaultException

Returns the project with the given ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project to return

Returns:

the project with the given ID if it exists and the logged in user has the right to retrieve it

Throws:

WSFaultException

createProject

public int createProject(java.lang.String sessionId,
                         Project project)
                  throws WSFaultException

Creates a new project with the given properties.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

project - properties of the project to create (ID will be ignored)

Returns:

the ID of the created project

Throws:

WSFaultException

updateProject

public void updateProject(java.lang.String sessionId,
                          Project project)
                   throws WSFaultException

Updates an existing project with the given properties.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

project - properties of the project to update (identified by the ID)

Throws:

WSFaultException - if the project does not exist or if the update fails or if the project is active (only inactive projects can be updated)

deleteProjects

public void deleteProjects(java.lang.String sessionId,
                           int[] projectIds)
                    throws WSFaultException

Deletes projects with the given IDs (if the logged in user has the right to do so).

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectIds - the IDs of the projects to delete

Throws:

WSFaultException

copyProject

public int copyProject(java.lang.String sessionId,
                       int projectId,
                       java.lang.String newProjectName,
                       java.lang.String[] copyProjectProperties)
                throws WSFaultException

Copies a project including the data selected in copyProjectProperties.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project to be copied.

newProjectName - specifies the name of the new project to which the existing project is copied to.

copyProjectProperties - The following values can be combined:
"SETTINGS": copies project settings, filters, attributes, custom requirement properties, change notification, and integration configuration setting information to the new project. Third-party integration configuration setting information is not copied.
"REQUIREMENTS": copies the requirements tree with all information for each requirement, for example properties, attachments, and others. Third-party requirement information is not copied. When a project has been configured for an external requirements management system, you are asked if you want to transfer the RMS settings to the copy of the project.
"REQUIREMENTS_HISTORY": copies the historical information for each requirement.
"PLANNING": copies the tests tree with all information for each test. When both Requirements tree and Tests tree are checked, in addition to the information listed above, the information related to the relationship between requirements and tests (assigned requirements and assigned tests) is also copied
"PLANNING_HISTORY": copies the historical information for each test.
"EXECUTIONS": copies the execution tree with all information for each execution plan.
"REPORTS": copies all project-related reports to the new project.
"RESULTS_LAST": copies the last run of each test.
"IM_COPY_ISSUES": copies all of the source project's existing Issue Manager issues to the new project.
"IM_COPY_ARCHIVED_ISSUES": copies all of the source project's archived Issue Manager issues to the new project

Returns:

the ID of the created project

Throws:

WSFaultException

activateProjects

public void activateProjects(java.lang.String sessionId,
                             int[] projectIds)
                      throws WSFaultException

Activates the projects with the given IDs.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectIds - the IDs of the projects to activate

Throws:

WSFaultException

deactivateProjects

public void deactivateProjects(java.lang.String sessionId,
                               int[] projectIds)
                        throws WSFaultException

Deactivates the projects with the given IDs.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectIds - the IDs of the projects to deactivate

Throws:

WSFaultException

getLocations

public Location[] getLocations(java.lang.String sessionId)
                        throws WSFaultException

Returns all defined locations.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Returns:

an array of all locations found

Throws:

WSFaultException

getLocationsForProject

public Location[] getLocationsForProject(java.lang.String sessionId,
                                         int projectId)
                                  throws WSFaultException

Returns all locations associated with the given project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project to search locations for

Returns:

an list of all locations associated with the given project

Throws:

WSFaultException

getLocationDetails

public LocationDetails getLocationDetails(java.lang.String sessionId,
                                          int locationId)
                                   throws WSFaultException

Returns detailed information about the location identified by the ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

locationId - the identifier of the location

Returns:

the location details of the given location

Throws:

WSFaultException

createLocation

public int createLocation(java.lang.String sessionId,
                          LocationDetails locationDetails)
                   throws WSFaultException

Creates a new location with the data provided by the location details.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

locationDetails - properties of the location to create (ID is ignored and set by the system)

Returns:

the location ID assigned to the new location by the system

Throws:

WSFaultException

updateLocation

public void updateLocation(java.lang.String sessionId,
                           LocationDetails locationDetails)
                    throws WSFaultException

Updates an existing location (identified by the ID) with the data provided by the location details. The property "isActive" is a read only property and is ignored when updating the location.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

locationDetails - properties of the location to create (ID identifies the location to update on the system)

Throws:

WSFaultException

setProxyUsernameAndPasswordForLocation

public void setProxyUsernameAndPasswordForLocation(java.lang.String sessionId,
                                                   int locationId,
                                                   java.lang.String proxyUsername,
                                                   java.lang.String proxyPassword)
                                            throws WSFaultException

Sets proxy username and password for a location (identified by locationId).

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

locationId - the identifier of the location

proxyUsername - new proxy username

proxyPassword - new proxy password

Throws:

WSFaultException

deleteLocations

public void deleteLocations(java.lang.String sessionId,
                            int[] locationIds)
                     throws WSFaultException

Deletes the location identified by the locationId (only if no execution servers exist for the location).

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

locationIds - the location IDs

Throws:

WSFaultException

getUsers

public User[] getUsers(java.lang.String sessionId,
                       java.lang.String login)
                throws WSFaultException

Returns all users matching the given login name.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

login - login name of user(s) to return - allows wildcards (? and *)

Returns:

an array of User matching the login pattern

Throws:

WSFaultException

deleteUsers

public void deleteUsers(java.lang.String sessionId,
                        int[] userIdsToDelete)
                 throws WSFaultException

Deletes existing users (identified by the IDs). The logged in user (sessionId) has to have the right to delete all given users and all users to delete have to exist or the deletion is aborted.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userIdsToDelete - IDs of the users to delete

Throws:

WSFaultException

getUserDetails

public UserDetails getUserDetails(java.lang.String sessionId,
                                  int userId)
                           throws WSFaultException

Returns details of a user (identified by ID).

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userId - the ID of an existing user

Returns:

the user details of the user with the given user ID

Throws:

WSFaultException

getRoleIdByName

public int getRoleIdByName(java.lang.String sessionId,
                           java.lang.String roleName)
                    throws WSFaultException

Returns the role ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

roleName - the name of the role for which ID needs to be retrieved

Returns:

the identity of the role queried

Throws:

WSFaultException

deleteRoleByName

public void deleteRoleByName(java.lang.String sessionId,
                             java.lang.String deletedRoleName)
                      throws WSFaultException

Deletes a role by the specified name.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

deletedRoleName - the name of the role being deleted

Throws:

WSFaultException

duplicateRole

public int duplicateRole(java.lang.String sessionId,
                         int roleId,
                         java.lang.String newRoleName,
                         java.lang.String newRoleDesc)
                  throws WSFaultException

Duplicates a role and returns the new role ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

roleId - the ID of the role being duplicated

newRoleName - the name of the new role being added

newRoleDesc - the description of the new role being added

Throws:

WSFaultException

createUser

public int createUser(java.lang.String sessionId,
                      UserDetails userDetails)
               throws WSFaultException

Creates a new user with the data of the given userDetails - the login has to be unique.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userDetails - object containing the user details

Throws:

WSFaultException

updateUser

public void updateUser(java.lang.String sessionId,
                       UserDetails userDetails)
                throws WSFaultException

Updates the properties of an existing user. The ID field of userDetails has to be an existing userId. Updates the properties of the existing user and stores the values to the database.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userDetails - user details - the values to set to the user identified by the userId field in the userDetails

Throws:

WSFaultException

createExecServer

public int createExecServer(java.lang.String sessionId,
                            ExecServer execServer)
                     throws WSFaultException

Creates a new execution sever with the given properties.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execServer - properties of the exec server to create (ID is ignored)

Returns:

the ID of the new execution server

Throws:

WSFaultException

getExecServerById

public ExecServer getExecServerById(java.lang.String sessionId,
                                    int execServerId)
                             throws WSFaultException

Returns the execution server identified by the given ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execServerId - the ID of the execution server to retrieve

Throws:

WSFaultException

getExecServersOfLocation

public ExecServer[] getExecServersOfLocation(java.lang.String sessionId,
                                             int locationId)
                                      throws WSFaultException

Returns the execution servers of a location.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

locationId - ID of the location

Returns:

an array of execution servers of the given location

Throws:

WSFaultException

updateExecServer

public void updateExecServer(java.lang.String sessionId,
                             ExecServer execServer)
                      throws WSFaultException

Updates the properties of an existing execution server. The ID field of the execution server has to be an existing execution server ID. The other values of execution server details are set to the execution server with the ID and stored to the database.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execServer - ExecServer - the values to set to the execution server identified by the ID field

Throws:

WSFaultException

activateExecServer

public void activateExecServer(java.lang.String sessionId,
                               int execServerId,
                               int locationId)
                        throws WSFaultException

Activates an existing execution server if it is not already active.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execServerId - ID of the execution server to activate

locationId - ID of the location of the execution server

Throws:

WSFaultException

deactivateExecServer

public void deactivateExecServer(java.lang.String sessionId,
                                 int execServerId)
                          throws WSFaultException

Deactivates an existing execution server if it is active.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execServerId - ID of the execution server to deactivate

Throws:

WSFaultException

deleteExecServer

public void deleteExecServer(java.lang.String sessionId,
                             int execServerId)
                      throws WSFaultException

Deletes the execution server identified by the ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execServerId - the ID of the execution server to delete

Throws:

WSFaultException

addLocationToProject

public boolean addLocationToProject(java.lang.String sessionId,
                                    int projectId,
                                    int locationId)
                             throws WSFaultException

Adds an association from a location to a project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project to which the location is associated

locationId - The location's ID which should be associated to the project

Returns:

true if adding the new association was successful. Otherwise or if projectId and locationId are not valid false.

Throws:

WSFaultException

removeLocationFromProject

public boolean removeLocationFromProject(java.lang.String sessionId,
                                         int projectId,
                                         int locationId)
                                  throws WSFaultException

Removes an association from a location to a project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project

locationId - the location's ID which should be removed from the project

Returns:

true if removing the association was successful. Otherwise or if projectId and locationId are not valid false.

Throws:

WSFaultException

createUsergroup

public int createUsergroup(java.lang.String sessionId,
                           UserGroup userGroup)
                    throws WSFaultException

Creates a new UserGroup.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userGroup - properties of the new user group

Returns:

the ID of the new user group

Throws:

WSFaultException

getGroupByName

public UserGroup getGroupByName(java.lang.String sessionId,
                                java.lang.String groupName)
                         throws WSFaultException

Returns a user group with the given name.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

groupName - name of the user group

Throws:

WSFaultException

getGroupById

public UserGroup getGroupById(java.lang.String sessionId,
                              int groupId)
                       throws WSFaultException

Returns a user group with the given ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

groupId - ID of the user group

Throws:

WSFaultException

getAllUserGroups

public UserGroup[] getAllUserGroups(java.lang.String sessionId)
                             throws WSFaultException

Returns all user groups.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Returns:

an array of all user groups

Throws:

WSFaultException

updateUserGroup

public void updateUserGroup(java.lang.String sessionId,
                            UserGroup usergroup)
                     throws WSFaultException

Updates an existing user group.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

usergroup - properties of the user group to update

Throws:

WSFaultException

deleteUserGroup

public void deleteUserGroup(java.lang.String sessionId,
                            int groupId)
                     throws WSFaultException

Deletes the user group identified by ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

groupId - ID of the group to delete

Throws:

WSFaultException

getMembershipsOfGroup

public UserGroupMembership[] getMembershipsOfGroup(java.lang.String sessionId,
                                                   int groupId)
                                            throws WSFaultException

Returns all memberships of the user group identified by ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

groupId - ID of the group

Returns:

all memberships of the group

Throws:

WSFaultException

getMembershipsOfUser

public UserGroupMembership[] getMembershipsOfUser(java.lang.String sessionId,
                                                  int userId)
                                           throws WSFaultException

Returns all memberships of the user identified by ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userId - ID of the user

Returns:

all memberships of the user

Throws:

WSFaultException

getAllMemberships

public UserGroupMembership[] getAllMemberships(java.lang.String sessionId)
                                        throws WSFaultException

Returns all memberships.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Returns:

all memberships

Throws:

WSFaultException

updateMembershipsOfGroup

public void updateMembershipsOfGroup(java.lang.String sessionId,
                                     int groupId,
                                     UserGroupMembership[] memberships)
                              throws WSFaultException

Updates the memberships of a group. All UserGroupMemberships have to be of the same group!

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

memberships - all memberships for the group to set. All memberships have to be of the same group. Old memberships are deleted.

Throws:

WSFaultException

updateMembershipsOfUser

public void updateMembershipsOfUser(java.lang.String sessionId,
                                    int userId,
                                    UserGroupMembership[] memberships)
                             throws WSFaultException

Updates the memberships of a user. All UserGroupMemberships have to be of the same user!

Parameters:

sessionId - the unique ID of the session created with {link logonUser(String, String)

userId -

memberships -

Throws:

WSFaultException

getAllRoles

public Role[] getAllRoles(java.lang.String sessionId)
                   throws WSFaultException

Returns all roles.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Throws:

WSFaultException

getRoleById

public Role getRoleById(java.lang.String sessionId,
                        int roleId)
                 throws WSFaultException

Returns a role identified by ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

roleId - ID of the role

Throws:

WSFaultException

getComponents

public java.lang.String[] getComponents(java.lang.String sessionId,
                                        java.lang.String product)
                                 throws WSFaultException

Returns all component names associated with a given project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

product - name of product containing components

Throws:

WSFaultException

getProducts

public java.lang.String[] getProducts(java.lang.String sessionId)
                               throws WSFaultException

Returns all product names for a given Silk Central installation.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Throws:

WSFaultException

getProductNameById

public java.lang.String getProductNameById(java.lang.String sessionId,
                                           int productId)
                                    throws WSFaultException

Returns the product name for the given product ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

productId - the product ID

Throws:

WSFaultException

getVersions

public java.lang.String[] getVersions(java.lang.String sessionId,
                                      java.lang.String product)
                               throws WSFaultException

Returns all version names associated with the given product.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

product - product name

Throws:

WSFaultException

getActiveVersions

public java.lang.String[] getActiveVersions(java.lang.String sessionId,
                                            java.lang.String product)
                                     throws WSFaultException

Returns names of active versions associated with the given product.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

product - product name

Throws:

WSFaultException

getBuilds

public java.lang.String[] getBuilds(java.lang.String sessionId,
                                    java.lang.String product,
                                    java.lang.String version)
                             throws WSFaultException

Returns all build names associated with the given product and version.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

product - product name

version - version name

Throws:

WSFaultException

getPlatforms

public java.lang.String[] getPlatforms(java.lang.String sessionId)
                                throws WSFaultException

Returns all platform names associated with the Silk Central installation.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Throws:

WSFaultException

getProjectNames

public java.lang.String[] getProjectNames(java.lang.String sessionId)
                                   throws WSFaultException

Returns all project names associated with the Silk Central installation.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Throws:

WSFaultException

addVersion

public boolean addVersion(java.lang.String sessionId,
                          java.lang.String product,
                          java.lang.String version,
                          java.lang.String descr,
                          boolean isActive)
                   throws WSFaultException

Adds a new version for the given product.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

product - name of product

version - name of version

descr - human-readable description of version to be added

isActive - true if version is active and available

Returns:

true if version was created

Throws:

WSFaultException

addBuild

public boolean addBuild(java.lang.String sessionId,
                        java.lang.String product,
                        java.lang.String version,
                        java.lang.String build,
                        java.lang.String descr,
                        boolean isActive)
                 throws WSFaultException

Adds a new build for the given product and version.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

product - name of product

version - name of version

build - name of build

descr - human-readable description of build to be added

isActive - true if build is active and available

Throws:

WSFaultException

isMixedModeAuthentication

public boolean isMixedModeAuthentication(java.lang.String sessionId,
                                         int userId)
                                  throws WSFaultException

Returns the information if mixed mode authentication is active for a user.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userId - ID of the user to retrieve the authentication mode of

Returns:

true when mixed mode is set for the user

Throws:

WSFaultException

setMixedModeAuthentication

public void setMixedModeAuthentication(java.lang.String sessionId,
                                       int userId,
                                       boolean useMixedMode)
                                throws WSFaultException

Sets the authentication mode for a user.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

userId - ID of the user to change the authentication mode of

useMixedMode - true when mixed mode shall be set for the user

Throws:

WSFaultException

isBuildActive

public boolean isBuildActive(java.lang.String sessionId,
                             java.lang.String product,
                             java.lang.String version,
                             java.lang.String build)
                      throws WSFaultException

Checks if a build is active.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

product - name of product

version - name of version

build - name of build

Throws:

WSFaultException

setBuildActive

public void setBuildActive(java.lang.String sessionId,
                           java.lang.String product,
                           java.lang.String version,
                           java.lang.String build,
                           boolean active)
                    throws WSFaultException

Activates/deactivates a build.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

product - name of product

version - name of version

build - name of build

Throws:

WSFaultException

getExecServerKeywords

public java.lang.String[] getExecServerKeywords(java.lang.String sessionId,
                                                int execServerId)
                                         throws WSFaultException

Returns the keywords set for the specified execution server (includes #-prefixed predefined keywords).

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execServerId - the ID of the execution server

Returns:

the list of execution server keywords for the specified execution server

Throws:

WSFaultException

updateExecServerKeywords

public void updateExecServerKeywords(java.lang.String sessionId,
                                     int execServerId,
                                     java.lang.String[] keywords)
                              throws WSFaultException

Sets the custom keywords for an execution server. Predefined keywords (#-prefixed) cannot be removed.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execServerId - the ID of the execution server for which the keywords are updated

keywords - the keyword strings to be updated; null or empty if all custom keywords should be removed.

Throws:

WSFaultException