com.collabnet.ce.soap60.webservices.scm

Interface IScmAppSoap

public interface IScmAppSoap

Provides SOAP services for managing the SCM system.

Change History

Version 8.0

• Added new method getExternalSystemList

Version 7.2

• Added new method setAuthorizedKeysForUser.
• Recommended to use this method in place of setAuthorizedKeys(String sessionId, String username, String authorizedKeys).

Version 7.1

• Added new method getExternalSystem: Returns information associated with an external system integrated with Teamforge.
• Added new method setExternalSystemData: Updates external system information that is integrated with Teamforge.

Version 7.0.0.1

• Added new method getCommitData2: Returns the same as getCommitData, but the File list does not contain commit message. Recommended to use this method in place of getCommitData

Version 7.0

• Added new method createRepository2: now has the repository parameters information.
• Added new method getRepositoryData2: now has the repository parameters information.
• Added new method getRepository2DataById: now has the repository parameters information.
• Added new method setRepositoryData: sets the repository data including the parameters.

Version 6.2

• Added new method getAuthorizedKeysForUser.
• Added new method getAuthorizedKeys.
• Added new method getRepositoryListForExternalSystem.
• Added new method setAuthorizedKeys.

Version 6.1.1

• getScmAdapterNames: now users with Manage SCM integration Site-wide permission are allowed to use this.
• getScmAdapterParameterNamesWithType: now users with Manage SCM integration Site-wide permission are allowed to use this.
• addExternalSystem: now users with Manage SCM integration Site-wide permission are allowed to use this.

Version 6.1

• Added new method getReplicableScmExternalSystemList.
• Added new method getReplicatedRepositoryList.
• getRepositoryData2: Renamed to getRepositoryDataById.
• createRepository2: Removed and merged into createRepository.

Version 6.0

• Added new method getCommitId.

Version 5.4

• Added new method moveRepository.
• Added new method getScmAdapterNames.
• Added new method getScmAdapterParameterNamesWithType.
• Added new method addExternalSystem.

Version 5.3

• Added new method getSCMCheckoutCommand.
• All methods taking SoapFilter arguments now support ORing filter conditions if multiple SoapFilter objects with the same name but different values are passed.

Version 5.2

• getRepositoryList: Modified in 5.2 to observe path based permission.
• getCommitList: Modified in 5.2 to observe path based permission.
• getCommitData: Modified in 5.2 to observe path based permission.
• getRepositoryData:Rendered obsolete in 5.2; getRepositoryData2() returns additional fields. Modified in 5.2 to observe path based permission.
• createRepository:Rendered obsolete in 5.2; createRepository2() supports additional field.
• getRepositoryData2: New operation added in 5.2, to support new repository field.
• createRepository2: New operation added in 5.2, to support new repository field.

Since:

4.1

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addExternalSystem(java.lang.String sessionId, java.lang.String adapterType, java.lang.String title, java.lang.String description, SoapNamedValues adapterTypeParameters) Adds an external system of the given adapter type with its title, description and respective list of parameters.
RepositorySoapDO	createRepository(java.lang.String sessionId, java.lang.String projectId, java.lang.String externalSystemId, java.lang.String repositoryDirectory, java.lang.String title, java.lang.String description, boolean idRequiredOnCommit, boolean hideMonitoringDetails, java.lang.String comment) Creates a new repository in the given SCM server
Repository2SoapDO	createRepository2(java.lang.String sessionId, java.lang.String projectId, java.lang.String externalSystemId, java.lang.String repositoryDirectory, java.lang.String title, java.lang.String description, boolean idRequiredOnCommit, boolean hideMonitoringDetails, java.lang.String comment, RepositoryParameter2SoapDO[] params) Creates a new repository in the given SCM server
void	deleteRepository(java.lang.String sessionId, java.lang.String repositoryId) Delete the repository with specified ID.
java.lang.String	getAuthorizedKeys(java.lang.String sessionId) Get all authorized keys for calling user.
java.lang.String	getAuthorizedKeysForUser(java.lang.String sessionId, java.lang.String username) Get all authorized keys for a user with a given username.
CommitSoapDO	getCommitData(java.lang.String sessionId, java.lang.String commitId) Deprecated. from 7.0.0.1 in favour of getCommitData2() that returns Commit2SoapDO, similar to CommitSoapDO except that the scmfile list does not contain the commit message for each file.
Commit2SoapDO	getCommitData2(java.lang.String sessionId, java.lang.String commitId) Returns data associated with a specific commit.
java.lang.String	getCommitId(java.lang.String sessionId, java.lang.String revision, java.lang.String externalSystemId, java.lang.String repoPath) Returns a commit Id corresponding to an commit version.
CommitSoapList	getCommitList(java.lang.String sessionId, java.lang.String repositoryId, SoapFilter[] filters) Lists the commits on a given repository.
ExternalSystemSoapDO	getExternalSystem(java.lang.String sessionId, java.lang.String systemId) Returns information associated with an external system integrated with TeamForge.
ExternalSystemSoapList	getExternalSystemList(java.lang.String sessionId) Gets a list of external scm systems integrated with TeamForge.
ReplicableScmExternalSystemSoapList	getReplicableScmExternalSystemList(java.lang.String sessionId) Lists the replicable external systems.
ReplicatedRepositorySoapList	getReplicatedRepositoryList(java.lang.String sessionId, java.lang.String masterRepositoryId) Lists replicated repositories of the specified SCM master
Repository2SoapDO	getRepository2Data(java.lang.String sessionId, java.lang.String externalSystemId, java.lang.String repositoryDirectory) Returns data associated with a specific repository.
Repository2SoapDO	getRepository2DataById(java.lang.String sessionId, java.lang.String repositoryId) Returns data associated with a specific repository Note that a user has permission to view the repository data if the user belongs to a role that has either full view permission or any path-based permission on this repository.
RepositorySoapDO	getRepositoryData(java.lang.String sessionId, java.lang.String externalSystemId, java.lang.String repositoryDirectory) Returns data associated with a specific repository.
RepositorySoapDO	getRepositoryDataById(java.lang.String sessionId, java.lang.String repositoryId) Returns data associated with a specific repository Note that a user has permission to view the repository data if the user belongs to a role that has either full view permission or any path-based permission on this repository.
RepositorySoapList	getRepositoryList(java.lang.String sessionId, java.lang.String projectId) Lists the repositories within a given project that the current user has been granted view permission through roles and path based permission.
RepositorySoapList	getRepositoryListForExternalSystem(java.lang.String sessionId, java.lang.String externalSystemId, java.lang.String userName) Lists the repositories on a given external system (SCM Adapter) for which the specified user has been granted view permission.
java.lang.String[]	getScmAdapterNames(java.lang.String sessionId) Returns a string array containing the known list of supported SCM adapters on the server.
SoapNamedValues	getScmAdapterParameterNamesWithType(java.lang.String sessionId, java.lang.String adapterName) Returns the SCM adapter parameter names with their corresponding type.
java.lang.String	getSCMCheckoutCommand(java.lang.String sessionId, java.lang.String repositoryId, java.lang.String userName) Returns the command needed to check out a specific repository.
RepositorySoapDO	moveRepository(java.lang.String sessionId, java.lang.String repositoryId, java.lang.String projectId) Moves the repository from its current project to the one specified.
void	setAuthorizedKeys(java.lang.String sessionId, java.lang.String authorizedKeys) Set authorized keys for calling user.
void	setAuthorizedKeys(java.lang.String sessionId, java.lang.String username, java.lang.String authorizedKeys) Deprecated. from 7.2.0.0 in favour of setAuthorizedKeysForUser() which does the same.
void	setAuthorizedKeysForUser(java.lang.String sessionId, java.lang.String username, java.lang.String authorizedKeys) Set authorized keys for given user.
void	setExternalSystemData(java.lang.String sessionId, ExternalSystemSoapDO systemData) Updates information associated with an external system integrated with TeamForge.
void	setRepositoryData(java.lang.String sessionId, Repository2SoapDO repository) Sets the repository data

Method Detail

getRepositoryList

RepositorySoapList getRepositoryList(java.lang.String sessionId,
                                   java.lang.String projectId)
                                     throws java.rmi.RemoteException

Lists the repositories within a given project that the current user has been granted view permission through roles and path based permission. Note that if a user belongs to a role that has set up path based permission on a repository, that repository will appear in this list.

Parameters:

sessionId - User session id.

projectId - The project id.

Returns:

List of SCM repositories within the specified project.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

getRepositoryListForExternalSystem

RepositorySoapList getRepositoryListForExternalSystem(java.lang.String sessionId,
                                                    java.lang.String externalSystemId,
                                                    java.lang.String userName)
                                                      throws java.rmi.RemoteException

Lists the repositories on a given external system (SCM Adapter) for which the specified user has been granted view permission.

Parameters:

sessionId - User session id. Must be site admin.

externalSystemId - The external system (SCM adapter) id.

userName - Name of the user.

Returns:

List of repositories on a given external system (SCM Adapter) for which the current user has been granted view permission.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified external system id is not valid

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when any of the parameters is null/empty

java.rmi.RemoteException

Since:

6.2

getCommitList

CommitSoapList getCommitList(java.lang.String sessionId,
                           java.lang.String repositoryId,
                           SoapFilter[] filters)
                             throws java.rmi.RemoteException

Lists the commits on a given repository. Note that if a user belongs to a role that has set up path based permission on a repository, that user can view all the commits for the repository, even for commits to paths for which the user does not have view permission (though file details will be filtered appropriately when getCommitDetails() is called).

Change History

Version 4.3

• Added additional parameter filters. The valid filter names are: createdAfter, createdBefore, createdBy.
• The list is always paired down to include no more than 5000 results.

Parameters:

sessionId - User session id.

repositoryId - The repository id.

filters - Array of filters to apply (null to return unfiltered list).

Returns:

List of SCM commits on the specified repository.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidFilterFault - If the filters are not valid.

java.rmi.RemoteException

Since:

4.1

getCommitData

CommitSoapDO getCommitData(java.lang.String sessionId,
                         java.lang.String commitId)
                           throws java.rmi.RemoteException

Deprecated. from 7.0.0.1 in favour of getCommitData2() that returns Commit2SoapDO, similar to CommitSoapDO except that the scmfile list does not contain the commit message for each file.

Returns data associated with a specific commit. Only files that are visible through roles or path based permission are included in the commit data. Recommended to use getCommitData2() in place of getCommitData()

Parameters:

sessionId - User session id.

commitId - The commit id.

Returns:

Commit data.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified commit id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

getCommitData2

Commit2SoapDO getCommitData2(java.lang.String sessionId,
                           java.lang.String commitId)
                             throws java.rmi.RemoteException

Returns data associated with a specific commit. Only files that are visible through roles or path based permission are included in the commit data. Commit Message is not appended to each file. Recommended to use this method in place of getCommitData()

Parameters:

sessionId - User session id.

commitId - The commit id.

Returns:

Commit data

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified commit id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

7.0.0.1

getRepositoryData

RepositorySoapDO getRepositoryData(java.lang.String sessionId,
                                 java.lang.String externalSystemId,
                                 java.lang.String repositoryDirectory)
                                   throws java.rmi.RemoteException

Returns data associated with a specific repository. Note that a user has permission to view the repository data if the user belongs to a role that has either full view permission or any path-based permission on this repository.

Parameters:

sessionId - User session id.

externalSystemId - The id of the external system that the repository is located on

repositoryDirectory - The directory on the external system that the repository is located in

Returns:

Repository Data

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2SP1

getRepository2Data

Repository2SoapDO getRepository2Data(java.lang.String sessionId,
                                   java.lang.String externalSystemId,
                                   java.lang.String repositoryDirectory)
                                     throws java.rmi.RemoteException

Returns data associated with a specific repository. Note that a user has permission to view the repository data if the user belongs to a role that has either full view permission or any path-based permission on this repository.

Parameters:

sessionId - User session id.

externalSystemId - The id of the external system that the repository is located on

repositoryDirectory - The directory on the external system that the repository is located in

Returns:

Repository Data

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

7.0

getRepositoryDataById

RepositorySoapDO getRepositoryDataById(java.lang.String sessionId,
                                     java.lang.String repositoryId)
                                       throws java.rmi.RemoteException

Returns data associated with a specific repository Note that a user has permission to view the repository data if the user belongs to a role that has either full view permission or any path-based permission on this repository.

Parameters:

sessionId - User session id.

repositoryId - The id of the repository

Returns:

Repository Data

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2SP1 (renamed from getRepositoryData2 in 6.1)

getRepository2DataById

Repository2SoapDO getRepository2DataById(java.lang.String sessionId,
                                       java.lang.String repositoryId)
                                         throws java.rmi.RemoteException

Returns data associated with a specific repository Note that a user has permission to view the repository data if the user belongs to a role that has either full view permission or any path-based permission on this repository.

Parameters:

sessionId - User session id.

repositoryId - The id of the repository

Returns:

Repository Data

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

7.0

setRepositoryData

void setRepositoryData(java.lang.String sessionId,
                     Repository2SoapDO repository)
                       throws java.rmi.RemoteException

Sets the repository data

Parameters:

sessionId - User session id.

repository - The repository data

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

7.0

getSCMCheckoutCommand

java.lang.String getSCMCheckoutCommand(java.lang.String sessionId,
                                     java.lang.String repositoryId,
                                     java.lang.String userName)
                                       throws java.rmi.RemoteException

Returns the command needed to check out a specific repository. Note that a user has permission to view the checkout command if the user belongs to a role that has either full view permission or any path-based permission on this repository.

Parameters:

sessionId - User session id.

repositoryId - The id of the repository

userName - User name.

Returns:

command to check out the repository

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

5.3

createRepository

RepositorySoapDO createRepository(java.lang.String sessionId,
                                java.lang.String projectId,
                                java.lang.String externalSystemId,
                                java.lang.String repositoryDirectory,
                                java.lang.String title,
                                java.lang.String description,
                                boolean idRequiredOnCommit,
                                boolean hideMonitoringDetails,
                                java.lang.String comment)
                                  throws java.rmi.RemoteException

Creates a new repository in the given SCM server

Parameters:

sessionId - User session id.

projectId - The project that will host the new repository

externalSystemId - The id of the external system on which the new repository will be created

repositoryDirectory - The directory on the external system for the new repository

title - The name of the new repository

description - The description for the new repository

idRequiredOnCommit - Whether an artifact ID is required for commits to this repository

hideMonitoringDetails - Controls whether monitoring messages for commit include full details

comment - The comment for documenting the creation of the repository

Returns:

Repository Data

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2SP1

createRepository2

Repository2SoapDO createRepository2(java.lang.String sessionId,
                                  java.lang.String projectId,
                                  java.lang.String externalSystemId,
                                  java.lang.String repositoryDirectory,
                                  java.lang.String title,
                                  java.lang.String description,
                                  boolean idRequiredOnCommit,
                                  boolean hideMonitoringDetails,
                                  java.lang.String comment,
                                  RepositoryParameter2SoapDO[] params)
                                    throws java.rmi.RemoteException

Creates a new repository in the given SCM server

Parameters:

sessionId - User session id.

projectId - The project that will host the new repository

externalSystemId - The id of the external system on which the new repository will be created

repositoryDirectory - The directory on the external system for the new repository

title - The name of the new repository

description - The description for the new repository

idRequiredOnCommit - Whether an artifact ID is required for commits to this repository

hideMonitoringDetails - Controls whether monitoring messages for commit include full details

comment - The comment for documenting the creation of the repository

params - The repository parameter

Returns:

Repository Data

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

7.0

deleteRepository

void deleteRepository(java.lang.String sessionId,
                    java.lang.String repositoryId)
                      throws java.rmi.RemoteException

Delete the repository with specified ID.

Parameters:

sessionId - The user's SOAP session id

repositoryId - The id of the repository to be deleted

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - If the user's session is invalid

com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user doesn't have proper permissions to delete the repository

com.collabnet.ce.soap60.fault.SystemFault - All other faults

com.collabnet.ce.soap60.fault.NoSuchObjectFault - If repository id doesn't exist

java.rmi.RemoteException

Since:

8.0

moveRepository

RepositorySoapDO moveRepository(java.lang.String sessionId,
                              java.lang.String repositoryId,
                              java.lang.String projectId)
                                throws java.rmi.RemoteException

Moves the repository from its current project to the one specified.

Parameters:

sessionId - The user's SOAP session id

repositoryId - The id of the repository to move

projectId - The id of the project to move the repository to

Returns:

RepositorySoapDO The repository object post-move

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - If the user's session is invalid

com.collabnet.ce.soap60.fault.NoSuchObjectFault - If either the repository id or project id doesn't exist

com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - If the destination project is the same as the current project

com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user doesn't have proper permissions on either the repository or the project

com.collabnet.ce.soap60.fault.SystemFault - All other faults

java.rmi.RemoteException

Since:

5.4

getScmAdapterNames

java.lang.String[] getScmAdapterNames(java.lang.String sessionId)
                                      throws java.rmi.RemoteException

Returns a string array containing the known list of supported SCM adapters on the server.

Parameters:

sessionId - The user's SOAP session id

Returns:

String[] The known SCM adapter names

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - If the session is invalid

com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user is not a site administrator

com.collabnet.ce.soap60.fault.SystemFault - If anything else goes wrong

java.rmi.RemoteException

Since:

5.4

getScmAdapterParameterNamesWithType

SoapNamedValues getScmAdapterParameterNamesWithType(java.lang.String sessionId,
                                                  java.lang.String adapterName)
                                                    throws java.rmi.RemoteException

Returns the SCM adapter parameter names with their corresponding type.

Parameters:

sessionId - The user's SOAP session id

adapterName - The SCM adapter's name

Returns:

SoapNamedValues The named values with type for the SCM adapter parameters

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - If the session is invalid

com.collabnet.ce.soap60.fault.NoSuchObjectFault - If the adapter name is not available

com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user is not a site administrator

com.collabnet.ce.soap60.fault.SystemFault - If anything else goes wrong

java.rmi.RemoteException

Since:

5.4

addExternalSystem

java.lang.String addExternalSystem(java.lang.String sessionId,
                                 java.lang.String adapterType,
                                 java.lang.String title,
                                 java.lang.String description,
                                 SoapNamedValues adapterTypeParameters)
                                   throws java.rmi.RemoteException

Adds an external system of the given adapter type with its title, description and respective list of parameters.

Pre-condition: the adapter type and adapter type parameters must be the ones expected as documented.

Parameters:

sessionId - is the user session id.

adapterType - is be the adapter type created, which is one value of the call "getScmAdapterNames()".

title - is the title of the external system.

description - is the description of the external system.

adapterTypeParameters - is the list of parameters of names and associated values for the given adapter type. The list of the needed parameters and their expected associated data type is retrieved by calling "getScmAdapterParameterNamesWithType(adapterType)".

Returns:

The GUID of the newly added external system.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - If the adapter does not exist internally.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - When the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - When wrong parameters are provided or an unexpected system error occurs.

java.rmi.RemoteException

Since:

5.4

getExternalSystem

ExternalSystemSoapDO getExternalSystem(java.lang.String sessionId,
                                     java.lang.String systemId)
                                       throws java.rmi.RemoteException

Returns information associated with an external system integrated with TeamForge.

Parameters:

sessionId - the user session id.

systemId - The GUID of the external system.

Returns:

the external system data.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - If the external system does not exist internally.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - When the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - When wrong parameters are provided or an unexpected system error occurs.

java.rmi.RemoteException

Since:

7.1

getExternalSystemList

ExternalSystemSoapList getExternalSystemList(java.lang.String sessionId)
                                             throws java.rmi.RemoteException

Gets a list of external scm systems integrated with TeamForge.

Parameters:

sessionId - the user session id.

Returns:

the external system list.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - When the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - When wrong parameters are provided or an unexpected system error occurs.

java.rmi.RemoteException

Since:

8.0

setExternalSystemData

void setExternalSystemData(java.lang.String sessionId,
                         ExternalSystemSoapDO systemData)
                           throws java.rmi.RemoteException

Updates information associated with an external system integrated with TeamForge.

Parameters:

sessionId - the user session id.

systemData - the external system data to be updated

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - If the external system does not exist internally.

com.collabnet.ce.soap60.fault.SystemFault - When wrong parameters are provided or an unexpected system error occurs.

com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - When the user has insufficient privileges.

com.collabnet.ce.soap60.fault.InvalidOperationFault - When an attempt is made to set different adapterName or adapterCatrogory.

java.rmi.RemoteException

Since:

7.1

getCommitId

java.lang.String getCommitId(java.lang.String sessionId,
                           java.lang.String revision,
                           java.lang.String externalSystemId,
                           java.lang.String repoPath)
                             throws java.rmi.RemoteException

Returns a commit Id corresponding to an commit version.

Parameters:

sessionId - User session id.

revision - The Revision Number

externalSystemId - External system id.

repoPath - Repository path.

Returns:

The commit Id

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the session is invalid (expired / time out)

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user does not have read access.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified repository id is invalid.

java.rmi.RemoteException

Since:

6.0

getReplicableScmExternalSystemList

ReplicableScmExternalSystemSoapList getReplicableScmExternalSystemList(java.lang.String sessionId)
                                                                       throws java.rmi.RemoteException

Lists the replicable external systems. That is, the list of SvnEdge external systems that supports replication.

Parameters:

sessionId - User session id.

Returns:

List of the replicable external systems.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

6.1

getReplicatedRepositoryList

ReplicatedRepositorySoapList getReplicatedRepositoryList(java.lang.String sessionId,
                                                       java.lang.String masterRepositoryId)
                                                         throws java.rmi.RemoteException

Lists replicated repositories of the specified SCM master

Parameters:

sessionId - the session key

masterRepositoryId - the repository Id for which to find replicas

Returns:

a list of ReplicatedRepository

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified master repository id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

6.1

getAuthorizedKeysForUser

java.lang.String getAuthorizedKeysForUser(java.lang.String sessionId,
                                        java.lang.String username)
                                          throws java.rmi.RemoteException

Get all authorized keys for a user with a given username.

Parameters:

sessionId - the session key

username - name of the user

Returns:

Authorized keys, separated by '\n' character. Returns empty string if the user has no keys or cannot be found.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges (the sessionId is not of a site admin).

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

6.2

getAuthorizedKeys

java.lang.String getAuthorizedKeys(java.lang.String sessionId)
                                   throws java.rmi.RemoteException

Get all authorized keys for calling user.

Parameters:

sessionId - the session key

Returns:

Authorized keys, separated by '\n' character. Returns empty string if the user has no keys.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

6.2

setAuthorizedKeys

void setAuthorizedKeys(java.lang.String sessionId,
                     java.lang.String authorizedKeys)
                       throws java.rmi.RemoteException

Set authorized keys for calling user. Note: overwrites previous keys, if any.

Parameters:

sessionId - the session key

authorizedKeys - the string containing authorized keys, separated by '\n' character.

Throws:

com.collabnet.ctf.common.exceptions.InvalidUsernameException - when username is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

6.2

setAuthorizedKeysForUser

void setAuthorizedKeysForUser(java.lang.String sessionId,
                            java.lang.String username,
                            java.lang.String authorizedKeys)
                              throws java.rmi.RemoteException

Set authorized keys for given user. Note: overwrites previous keys, if any. Recommended to use this method in place of setAuthorizedKeys(String sessionId, String username, String authorizedKeys).

Parameters:

sessionId - the session key

username - username for whom the authorized keys to be set

authorizedKeys - the string containing authorized keys, separated by '\n' character.

Throws:

java.rmi.RemoteException - when username is invalid

Since:

7.2

setAuthorizedKeys

void setAuthorizedKeys(java.lang.String sessionId,
                     java.lang.String username,
                     java.lang.String authorizedKeys)
                       throws java.rmi.RemoteException

Deprecated. from 7.2.0.0 in favour of setAuthorizedKeysForUser() which does the same.

Set authorized keys for given user. Note: overwrites previous keys, if any. Recommended to use setAuthorizedKeysForUser() in place of this.

Parameters:

sessionId - the session key

username - username for whom the authorized keys to be set

authorizedKeys - the string containing authorized keys, separated by '\n' character.

Throws:

com.collabnet.ctf.common.exceptions.InvalidUsernameException - when username is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified username is invalid.

java.rmi.RemoteException

Since:

6.2