Class CollabNetSoap

java.lang.Object
com.collabnet.ce.soap60.webservices.WebService
com.collabnet.ce.soap60.webservices.cemain.CollabNetSoap
All Implemented Interfaces:
ICollabNetSoap

public class CollabNetSoap extends WebService implements ICollabNetSoap
The web service providing the core TeamForge functionality, such as authentication, project and membership information, etc.

Change History

Version 16.7
  • login: Modified in 16.7 to allow case-insensitive user names during login, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true;
    Also, it restricts the length of the password to be less than the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file; Users who already used a password longer than this limit have to reset their password either by using 'Forgot Password" link in the UI or by contacting TeamForge administrator.
  • createUser: Modified in 16.7 to allow license type field to have multiple license with comma separated.
    Also, it restricts the length of the password to be less than the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file.
  • getUserData: getUserData supports list of license types in response;
    Also, it is modified in 16.7 to return the user object even for case-insensitive user names, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true.
  • getUserData2: getUserData2 supports list of license types in response;
    Also, it is modified in 16.7 to return the user object even for case-insensitive user names, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true.
  • setUserData: setUserData is modified to accept list of license types
  • setUserData2: setUserData2 is modified to accept list of license types
  • getUserList2: getUserList2 is modified to accept license type filter to have multiple licenses.
  • doMandatoryPasswordChange: Modified in 16.7 to restrict the length of the password to be less than the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file; Users who already used a password longer than this limit have to reset their password either by using 'Forgot Password" link in the UI or by contacting TeamForge administrator.
  • changePassword: Modified in 16.7 to restrict the length of the password to be less than the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file.

Version 8.2
  • createProjectLinkedApp2: Added support for creation of project-level linked application with orchestrate source association.i
  • getLinkedApplicationData2 Added support for getting linked application data with visible and tooltype fields.
  • setLinkedApplicationData2 Added support for setting linked application data with visible (to hide or show linked app from menubar), tooltype fields and icon.
  • listProjectLinkedApps2: Added support for listing of project-level linked applications with the visible and tooltype fields.

Version 8.0
  • getUserList: Modified to fetch the list of users information with organization, alternate emails, locale and time zone details.
  • getUserList2: Added new operation to fetch the list of users information with id, organization, alternate emails, locale and time zone details.
  • setUserData2: Added new operation to update the user information with validations.
  • getProjectGroupsForProject1: Added new operation to get the project groups in which the project belongs and checks for user view permission
  • createProjectLinkedApp: Added support for creation of project-level linked application.i
  • listSiteWideLinkedApps: Added support for listing of site-wide linked applications.
  • listProjectLinkedApps: Added support for listing of project-level linked applications.
  • getLinkedApplicationData Added support for getting linked application data.
  • setLinkedApplicationData Added support for setting linked application data and icon.
  • deleteLinkedApp Added support for deleting linked application.
  • getOneTimeToken: Added support to get one time token for active user session
  • getUserList: Updated permission check for non-super user can see only non-super-users in the user list and super user can see all users in the user list .
  • getUserList2: Updated permission check for non-super user can see only non-super-users in the user list and super user can see all users in the user list .
  • Version 7.2
    • createProject: Modified to add Orchestrate application to the project if it is integrated and enabled in the site.
    • createProjectFromTemplate: Modified to add Orchestrate application to the project if it is integrated and enabled in the site.
    • unLockProject: Modified to add Orchestrate application to the project if it is integrated and enabled in the site.
    • Version 7.1
      • isSoapRedirectPostOnlyMode: New operation added to verify the SoapRedirect Post-Only mode.
      • Version 7.0
        • createAssociation: Added support for createAssociation to accept Pluggable App Object Id as targetId
        • deleteAssociation: Modified deleteAssociation to accept Pluggable App Object Id as targetId
        • getAssociationList: Modified getAssociationList to accept Pluggable App Object Id as objectId
        • createSiteLinkedApp: Added support for creation of site-wide linked application and return the created linked application Id
        • getUserData2: New operation added to fetch additional information on user.
        • getProjectListForUser: Modified to allow users to get their own list of projects in Hosted Mode.
        • createAssociationWithTitles: New operation added to save object title(if supplied for Pluggable objects) during create association.
        • changeIAObjectTitle: New operation added to update object title(for Pluggable objects) for existing associations.

        Version 6.2
        • hasGeneralPermission: Modified to return false instead of throwing PermissionDeniedFault, when the calling user does not have project view permission.
        • hasPermission: Modified to return false instead of throwing PermissionDeniedFault, when the calling user does not have project view permission.
        • hasPermission2: New operation added in 6.2; Same as hasPermission, except that it does not accept 'username' parameter and checks whether the calling user has permission.

        Version 6.1.1
        • hasSitewideRolePermission: New operation added in 6.1.1 to check site-wide role permission.

        Version 6.1
        • getProjectList: New parameter, fetchHierarchyPath, added.
        • getProjectListWithHierarchy: Removed, use getProjectList instead.
        • getUserProjectList: Removed, use getProjectListForUser instead.
        • getUserProjectListWithHierarchy: Removed, use getProjectListForUser instead.
        • getProjectListForUser: Two new parameters, fetchHierarchyPath and includeGroupMembership, added.
        • getProjectListForUserWithHierarchy: Removed, use getProjectListForUser instead.
        • getProjectsForUser: Removed, use getProjectListForUser instead.
        • getProjectsForUserWithHierarchy: Removed, use getProjectListForUser instead.
        • findProjects2: Removed and merged into findProjects.
        • getProjectData2: Removed and merged into getProjectData.
        • listProjectAdmins2: Removed and merged into listProjectAdmins.
        • getGroupList, getGroupList2: Merged and renamed to getUserGroupList.
        • getUserGroupList: Renamed to getUserGroupListForUser.
        • getProjectGroupList: Renamed to getUserGroupListForProject
        • createGroup: Renamed to createUserGroup
        • getGroupData: Renamed to getUserGroupData
        • setGroupData: Renamed to setUserGroupData
        • deleteGroup: Renamed to deleteUserGroup
        • addGroupMember: Renamed to addUserGroupMember
        • removeGroupMember: Renamed to removeUserGroupMember
        • getActiveGroupMembers, getActiveGroupMembers2: Merged and renamed to getUserGroupMembers.
        • createUser2, createUserWithOrganization: Removed and merged into createUser.
        • getUserData2: Removed and merged into getUserData.
        • setUserData2: Removed and merged into setUserData.
        • findUsers2: Removed and merged into findUsers.
        • getUserList2: Removed and merged into getUserList.
        • listAttachments2: Removed and merged into listAttachments.
        • deleteProject2: Removed and merged into deleteProject.
        • getAuditHistoryList2: Removed and merged into getAuditHistoryList.
        • getBroadCastMessage:New operation added in 6.1 to get broadcast message.
        • getUserSessionBySoapId: Get user session id from a soap session.
        • invalidateResourceBundleCache: Removed
        • invalidateEmailTemplate: Removed
        • hasPermission: New parameter 'username' added.
        Version 6.0.1
        • createProjectGroup: New operation added in 6.0.1 to create a project group.
        • listProjectGroups: New operation added in 6.0.1 to get the list of project groups.
        • getProjectGroupData: New operation added in 6.0.1.
        • addProjectsToProjectGroup: New operation added in 6.0.1.
        • removeProjectsFromProjectGroup: New operation added in 6.0.1.
        • getMemberProjectsForProjectGroup: New operation added in 6.0.1.
        • getProjectGroupMemberList: New operation added in 6.0.1 to get the list of users who are member of a project group.
        • addProjectGroupMember:New Operation added in 6.0.1 to add user to project group.
        • removeProjectGroupMember:New Operation added in 6.0.1.
        • getProjectGroupsForProject:New Operation added in 6.0.1 to get the project groups in which the project belongs
        • setProjectGroupData:New Operation added in 6.0.1 to set(edit) the project group's title and description
        • addProjectGroupAdmins:New Operation added in 6.0.1 to add admin users to the project group
        • removeProjectGroupAdmins:New Operation added in 6.0.1 to remove the admins from a project group
        • deleteProjectGroup:New Operation added in 6.0.1 to delete a project group
        • listUsersWithPermissionOnObject:New Operation added in 6.0.1 to get a list of users who have the given permission on the given object
        Version 6.0
        • getProjectData2: New operation added in 6.0
        • getSubprojectList: New operation added in 6.0
        • setParentProject: New operation added in 6.0
        • hasGeneralPermission: New operation added in 6.0
        • deleteProject2(String sessionId, String projectId, boolean noNotification, boolean forceDeleteEvenIfChildFound): New operation added in 6.0
        • getProjectListWithHierarchy(String sessionId, boolean fetchHierarchyPath): New operation added in 6.0 to allow fetching hierarchy path of each project returned.
        • getUserProjectListWithHierarchy(String sessionId, boolean fetchHierarchyPath): New operation added in 6.0 to allow fetching hierarchy path of each project returned.
        • getProjectListForUserWithHierarchy(String sessionId, String userId, boolean fetchHierarchyPath): New operation added in 6.0 to allow fetching hierarchy path of each project returned.
        • getProjectsForUserWithHierarchy(String sessionId, String userId, boolean fetchHierarchyPath): New operation added in 6.0 to allow fetching hierarchy path of each project returned.
        • findProjects2(String sessionId, String queryString, boolean fetchHierarchyPath): New operation added in 6.0 to allow fetching hierarchy path of each project returned.
        • getProjectHierarchyPaths: New operation added in 6.0
        • getUserData: New operation added in 6.0 to fetch the user information given a user session
        • getUserByEmail: New operation added in 6.0 to fetch the user information given a user email
        • getUserByName: New operation added in 6.0 to fetch the user information given a user's full name
        • createUserWithOrganization: New operation added in 6.0 to create new user with organization
        • lockProject: New operation added in 6.0 to lock a project
        • unLockProject: New operation added in 6.0 to unlock a project
        • getCurrentTime: New operation added in 6.0 to get current server time in milliseconds
        • listGroupsWithGeneralPermission: New operation added in 6.0 to get a list of user groups with a given operation in a project
        • canReceiveOwnUpdates: New operation added in 6.0 to check if user can receive emails for own updates
        • doMandatoryPasswordChange: New operation added in 6.0 to change the password if and only if the password was set by an admin.
        • changePassword: New operation added in 6.0 to change the password.
        Version 5.4
        • listProjectAdmins2: Added in 5.4 to return new User2SoapList objects.
        • getActiveGroupMembers2: Added in 5.4 to return new User2SoapList objects.
        • findUsers2: Added in 5.4 to return new User2SoapList objects.
        • getUserList2: Added in 5.4 to return new User2SoapList objects.
        • createUser2: Added in 5.4 to create new User2SoapDO objects.
        • getUserData2: Added in 5.4 to get new User2SoapDO objects.
        • setUserData2: Added in 5.4 to set new User2SoapDO objects.
        • getSessionId: Get current user session id from an one time token.
        • getJSessionId: Get current user web session id from an one time token.
        • getWebAndSoapSessionId: Get web and soap session id.
        • getJSessionBySoapId: Get web session id from a soap session.
        • getProjectByPath: Get project data for a given project path.
        • getUserEffectiveMode: Introduced in 5.4 to get effective mode for the current user.
        • listUsersWithGeneralPermission: Get a list of users with permission on an object.
        • hasGeneralPermission: Check if a user has a given permission on a given object.
        • getCurrentUserData: Get user data for a given session id.
        Version 5.3
        • createOrReplaceProjectTemplate: New operation added in 5.3
        • getAuditHistoryList2: Introduced in 5.3 to retrieve changes of fields introduced in 5.3
        • listAttachments2: Introduced in 5.3 to retrieve additional information about attachments

        Version 5.2
        • getUserGroupList: Modified in 5.2 to allow non site admins to call method on own self

        Version 5.1
        • getGroupList2: New operation added in 5.1

        Version 5.0
        • invalidateResourceBundleCache: New operation added in 5.0
        • invalidateEmailTemplate: New operation added in 5.0
        • listProjectAdmins: New operation added in 5.0
        • createAssociation: Modified in 5.0 to allow associations to DocumentReview
Since:
4.1