com.collabnet.ce.soap60.webservices.scm
Interface IScmAppSoap

public interface IScmAppSoap

Provides SOAP services for managing the SCM system.

Change History

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

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
CommitSoapDO	getCommitData(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.
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
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.
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.

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

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

Returns data associated with a specific commit. Only files that are visible through roles or path based permission are included in the commit data.

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

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

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)

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

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

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