Class ScmAppSoapStub
java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.scm.ScmAppSoapStub
- All Implemented Interfaces:
IScmAppSoap
-
Field Summary
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddExternalSystem
(String sessionId, String adapterType, String title, String description, SoapNamedValues adapterTypeParameters) Adds an external system of the given adapter type with its title, description and respective list of parameters.createRepository
(String sessionId, String projectId, String externalSystemId, String repositoryDirectory, String title, String description, boolean idRequiredOnCommit, boolean hideMonitoringDetails, String comment) Creates a new repository in the given SCM server.createRepository2
(String sessionId, String projectId, String externalSystemId, String repositoryDirectory, String title, String description, boolean idRequiredOnCommit, boolean hideMonitoringDetails, String comment, RepositoryParameter2SoapDO[] params) Creates a new repository in the given SCM server.void
deleteRepository
(String sessionId, String repositoryId) Delete the repository with specified ID.getAuthorizedKeys
(String sessionId) Get all authorized keys for calling user.getAuthorizedKeysForUser
(String sessionId, String username) Get all authorized keys for a user with a given username.getCommitData
(String sessionId, String commitId) Returns data associated with a specific commit.getCommitData2
(String sessionId, String commitId) Returns data associated with a specific commit.getCommitId
(String sessionId, String revision, String externalSystemId, String repoPath) Returns a commit Id corresponding to an commit version.getCommitList
(String sessionId, String repositoryId, SoapFilter[] filters) Lists the commits on a given repository.getExternalSystem
(String sessionId, String systemId) Returns information associated with an external system integrated with TeamForge.getExternalSystemList
(String sessionId) Gets a list of external scm systems integrated with TeamForge.getExternalSystemList2
(String sessionId) Gets a list of external scm systems integrated with TeamForge.getReplicableScmExternalSystemList
(String sessionId) Lists the replicable external systems.getReplicableScmExternalSystemList2
(String sessionId, String adapterName) Lists the replicable external systems for all adapter types or for a given adapter type.getReplicaData
(String sessionId, String replicaId) For a given replica server id get the replica server data.getReplicaListForExternalSystem
(String sessionId, String externalSystemId, boolean approvedOnly) Returns list of replicas for given external system id.getReplicaRepositoryList
(String sessionId, String replicaId) Lists repositories of the specified replica.getReplicatedRepositoryList
(String sessionId, String masterRepositoryId) Lists replicated repositories of the specified SCM master.getRepository2Data
(String sessionId, String externalSystemId, String repositoryDirectory) Returns data associated with a specific repository.getRepository2DataById
(String sessionId, String repositoryId) Returns data associated with a specific repositorygetRepositoryData
(String sessionId, String externalSystemId, String repositoryDirectory) Returns data associated with a specific repository.getRepositoryDataById
(String sessionId, String repositoryId) Returns data associated with a specific repositorygetRepositoryList
(String sessionId, String projectId) Lists the repositories within a given projectgetRepositoryListForExternalSystem
(String sessionId, String externalSystemId, String userName) Lists the repositories on a given external systemString[]
getScmAdapterNames
(String sessionId) Returns a string array containing the known list of supported SCM adapters on the server.getScmAdapterParameterNamesWithType
(String sessionId, String adapterName) Returns the SCM adapter parameter names with their corresponding type.getSCMCheckoutCommand
(String sessionId, String repositoryId, String userName) Returns the command needed to check out a specific repository.getSCMCheckoutCommands
(String sessionId, String repositoryId) Returns the list of commands that might be used to check out a specific repository.getSCMCheckoutCommandsForReplica
(String sessionId, String repositoryId, String replicaId) Returns the list of commands that might be used to check out a repository's replica.moveRepository
(String sessionId, String repositoryId, String projectId) Moves the repository from its current project to the one specified.void
removeRepositoryFromReplica
(String sessionId, String repositoryId, String replicaId) Remove process of replicating of a given repository on a given replica.void
replicateRepository
(String sessionId, String repositoryId, String replicaId) Initiates the process of replicating of a given repository on a given replica.void
setAuthorizedKeys
(String sessionId, String authorizedKeys) Set authorized keys for calling user.void
setAuthorizedKeys
(String sessionId, String username, String authorizedKeys) Set authorized keys for given user.void
setAuthorizedKeysForUser
(String sessionId, String username, String authorizedKeys) Set authorized keys for given user.void
setExternalSystemData
(String sessionId, ExternalSystemSoapDO systemData) Updates information associated with an external system integrated with TeamForge.void
setReplicaData
(String sessionId, ReplicaDataSoapDO replica) Sets replica server data.void
setRepositoryData
(String sessionId, Repository2SoapDO repository) Sets the repository dataMethods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
Constructor Details
-
ScmAppSoapStub
-
-
Method Details
-
getRepositoryList
public RepositorySoapList getRepositoryList(String sessionId, String projectId) throws RemoteException Description copied from interface:IScmAppSoap
Lists the repositories within a given project- Specified by:
getRepositoryList
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.projectId
- The project id.- Returns:
- List of SCM repositories within the specified project.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified project id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getRepositoryListForExternalSystem
public RepositorySoapList getRepositoryListForExternalSystem(String sessionId, String externalSystemId, String userName) throws RemoteException Description copied from interface:IScmAppSoap
Lists the repositories on a given external system- Specified by:
getRepositoryListForExternalSystem
in interfaceIScmAppSoap
- 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
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified external system id is not validPermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.IllegalArgumentFault
- when any of the parameters is null/emptyRemoteException
-
getCommitList
public CommitSoapList getCommitList(String sessionId, String repositoryId, SoapFilter[] filters) throws RemoteException Description copied from interface:IScmAppSoap
Lists the commits on a given repository.- Specified by:
getCommitList
in interfaceIScmAppSoap
- 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:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.InvalidFilterFault
- If the filters are not valid.RemoteException
-
getCommitData
Description copied from interface:IScmAppSoap
Returns data associated with a specific commit.- Specified by:
getCommitData
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.commitId
- The commit id.- Returns:
- Commit data.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified commit id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getCommitData2
Description copied from interface:IScmAppSoap
Returns data associated with a specific commit.- Specified by:
getCommitData2
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.commitId
- The commit id.- Returns:
- Commit data
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified commit id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getRepositoryData
public RepositorySoapDO getRepositoryData(String sessionId, String externalSystemId, String repositoryDirectory) throws RemoteException Description copied from interface:IScmAppSoap
Returns data associated with a specific repository.- Specified by:
getRepositoryData
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.externalSystemId
- The id of the external system that the repository is located onrepositoryDirectory
- The directory on the external system that the repository is located in- Returns:
- Repository Data
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getRepository2Data
public Repository2SoapDO getRepository2Data(String sessionId, String externalSystemId, String repositoryDirectory) throws RemoteException Description copied from interface:IScmAppSoap
Returns data associated with a specific repository.- Specified by:
getRepository2Data
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.externalSystemId
- The id of the external system that the repository is located onrepositoryDirectory
- The directory on the external system that the repository is located in- Returns:
- Repository Data
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getRepositoryDataById
public RepositorySoapDO getRepositoryDataById(String sessionId, String repositoryId) throws RemoteException Description copied from interface:IScmAppSoap
Returns data associated with a specific repository- Specified by:
getRepositoryDataById
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.repositoryId
- The id of the repository- Returns:
- Repository Data
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getRepository2DataById
public Repository2SoapDO getRepository2DataById(String sessionId, String repositoryId) throws RemoteException Description copied from interface:IScmAppSoap
Returns data associated with a specific repository- Specified by:
getRepository2DataById
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.repositoryId
- The id of the repository- Returns:
- Repository Data
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
setRepositoryData
public void setRepositoryData(String sessionId, Repository2SoapDO repository) throws RemoteException Description copied from interface:IScmAppSoap
Sets the repository data- Specified by:
setRepositoryData
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.repository
- The repository data- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getReplicaData
Description copied from interface:IScmAppSoap
For a given replica server id get the replica server data.- Specified by:
getReplicaData
in interfaceIScmAppSoap
- Parameters:
sessionId
- the user sessionreplicaId
- the replica server id- Returns:
- the replica server data
- Throws:
InvalidSessionFault
PermissionDeniedFault
SystemFault
NoSuchObjectFault
RemoteException
-
setReplicaData
Description copied from interface:IScmAppSoap
Sets replica server data.- Specified by:
setReplicaData
in interfaceIScmAppSoap
- Parameters:
sessionId
- user session idreplica
- the replica server data to be set- Throws:
InvalidSessionFault
PermissionDeniedFault
SystemFault
NoSuchObjectFault
VersionMismatchFault
RemoteException
-
getSCMCheckoutCommand
public String getSCMCheckoutCommand(String sessionId, String repositoryId, String userName) throws RemoteException Description copied from interface:IScmAppSoap
Returns the command needed to check out a specific repository.- Specified by:
getSCMCheckoutCommand
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.repositoryId
- The id of the repositoryuserName
- User name.- Returns:
- command to check out the repository
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getSCMCheckoutCommands
public CheckoutCommandSoapList getSCMCheckoutCommands(String sessionId, String repositoryId) throws RemoteException Description copied from interface:IScmAppSoap
Returns the list of commands that might be used to check out a specific repository.- Specified by:
getSCMCheckoutCommands
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.repositoryId
- The id of the repository- Returns:
- protocol to checkout command tuples
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getSCMCheckoutCommandsForReplica
public CheckoutCommandSoapList getSCMCheckoutCommandsForReplica(String sessionId, String repositoryId, String replicaId) throws RemoteException Description copied from interface:IScmAppSoap
Returns the list of commands that might be used to check out a repository's replica.- Specified by:
getSCMCheckoutCommandsForReplica
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.repositoryId
- The id of the repositoryreplicaId
- The id of the replica to which checkout command should point- Returns:
- protocol to checkout command tuples
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
createRepository
public RepositorySoapDO createRepository(String sessionId, String projectId, String externalSystemId, String repositoryDirectory, String title, String description, boolean idRequiredOnCommit, boolean hideMonitoringDetails, String comment) throws RemoteException Description copied from interface:IScmAppSoap
Creates a new repository in the given SCM server.- Specified by:
createRepository
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.projectId
- The project that will host the new repositoryexternalSystemId
- The id of the external system on which the new repository will be createdrepositoryDirectory
- The directory on the external system for the new repositorytitle
- The name of the new repositorydescription
- The description for the new repositoryidRequiredOnCommit
- Whether an artifact ID is required for commits to this repositoryhideMonitoringDetails
- Controls whether monitoring messages for commit include full detailscomment
- The comment for documenting the creation of the repository- Returns:
- Repository Data
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
createRepository2
public Repository2SoapDO createRepository2(String sessionId, String projectId, String externalSystemId, String repositoryDirectory, String title, String description, boolean idRequiredOnCommit, boolean hideMonitoringDetails, String comment, RepositoryParameter2SoapDO[] params) throws RemoteException Description copied from interface:IScmAppSoap
Creates a new repository in the given SCM server.- Specified by:
createRepository2
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.projectId
- The project that will host the new repositoryexternalSystemId
- The id of the external system on which the new repository will be createdrepositoryDirectory
- The directory on the external system for the new repositorytitle
- The name of the new repositorydescription
- The description for the new repositoryidRequiredOnCommit
- Whether an artifact ID is required for commits to this repositoryhideMonitoringDetails
- Controls whether monitoring messages for commit include full detailscomment
- The comment for documenting the creation of the repositoryparams
- The repository parameter- Returns:
- Repository Data
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
deleteRepository
Description copied from interface:IScmAppSoap
Delete the repository with specified ID.- Specified by:
deleteRepository
in interfaceIScmAppSoap
- Parameters:
sessionId
- The user's SOAP session idrepositoryId
- The id of the repository to be deleted- Throws:
InvalidSessionFault
- If the user's session is invalidPermissionDeniedFault
- If the user doesn't have proper permissions to delete the repositorySystemFault
- All other faultsNoSuchObjectFault
- If repository id doesn't existRemoteException
-
moveRepository
public RepositorySoapDO moveRepository(String sessionId, String repositoryId, String projectId) throws RemoteException Description copied from interface:IScmAppSoap
Moves the repository from its current project to the one specified.- Specified by:
moveRepository
in interfaceIScmAppSoap
- Parameters:
sessionId
- The user's SOAP session idrepositoryId
- The id of the repository to moveprojectId
- The id of the project to move the repository to- Returns:
- RepositorySoapDO The repository object post-move
- Throws:
InvalidSessionFault
- If the user's session is invalidNoSuchObjectFault
- If either the repository id or project id doesn't existObjectAlreadyExistsFault
- If the destination project is the same as the current projectPermissionDeniedFault
- If the user doesn't have proper permissions on either the repository or the projectSystemFault
- All other faultsRemoteException
-
getScmAdapterNames
Description copied from interface:IScmAppSoap
Returns a string array containing the known list of supported SCM adapters on the server.- Specified by:
getScmAdapterNames
in interfaceIScmAppSoap
- Parameters:
sessionId
- The user's SOAP session id- Returns:
- String[] The known SCM adapter names
- Throws:
InvalidSessionFault
- If the session is invalidPermissionDeniedFault
- If the user is not a site administratorSystemFault
- If anything else goes wrongRemoteException
-
getScmAdapterParameterNamesWithType
public SoapNamedValues getScmAdapterParameterNamesWithType(String sessionId, String adapterName) throws RemoteException Description copied from interface:IScmAppSoap
Returns the SCM adapter parameter names with their corresponding type.- Specified by:
getScmAdapterParameterNamesWithType
in interfaceIScmAppSoap
- Parameters:
sessionId
- The user's SOAP session idadapterName
- The SCM adapter's name- Returns:
- SoapNamedValues The named values with type for the SCM adapter parameters
- Throws:
InvalidSessionFault
- If the session is invalidNoSuchObjectFault
- If the adapter name is not availablePermissionDeniedFault
- If the user is not a site administratorSystemFault
- If anything else goes wrongRemoteException
-
addExternalSystem
public String addExternalSystem(String sessionId, String adapterType, String title, String description, SoapNamedValues adapterTypeParameters) throws RemoteException Description copied from interface:IScmAppSoap
Adds an external system of the given adapter type with its title, description and respective list of parameters.- Specified by:
addExternalSystem
in interfaceIScmAppSoap
- 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.- Returns:
- The GUID of the newly added external system.
- Throws:
InvalidSessionFault
- When the specified session id is invalid.NoSuchObjectFault
- If the adapter does not exist internally.PermissionDeniedFault
- When the user has insufficient privileges.SystemFault
- When wrong parameters are provided or an unexpected system error occurs.RemoteException
-
getExternalSystem
public ExternalSystemSoapDO getExternalSystem(String sessionId, String systemId) throws RemoteException Description copied from interface:IScmAppSoap
Returns information associated with an external system integrated with TeamForge.- Specified by:
getExternalSystem
in interfaceIScmAppSoap
- Parameters:
sessionId
- the user session id.systemId
- The GUID of the external system.- Returns:
- the external system data.
- Throws:
InvalidSessionFault
- When the specified session id is invalid.NoSuchObjectFault
- If the external system does not exist internally.PermissionDeniedFault
- When the user has insufficient privileges.SystemFault
- When wrong parameters are provided or an unexpected system error occurs.RemoteException
-
getExternalSystemList
Description copied from interface:IScmAppSoap
Gets a list of external scm systems integrated with TeamForge.- Specified by:
getExternalSystemList
in interfaceIScmAppSoap
- Parameters:
sessionId
- the user session id.- Returns:
- the external system list.
- Throws:
InvalidSessionFault
- When the specified session id is invalid.PermissionDeniedFault
- When the user has insufficient privileges.SystemFault
- When wrong parameters are provided or an unexpected system error occurs.RemoteException
-
getExternalSystemList2
Description copied from interface:IScmAppSoap
Gets a list of external scm systems integrated with TeamForge.- Specified by:
getExternalSystemList2
in interfaceIScmAppSoap
- Parameters:
sessionId
- the user session id.- Returns:
- the external system list.
- Throws:
InvalidSessionFault
- When the specified session id is invalid.PermissionDeniedFault
- When the user has insufficient privileges.SystemFault
- When wrong parameters are provided or an unexpected system error occurs.RemoteException
-
setExternalSystemData
public void setExternalSystemData(String sessionId, ExternalSystemSoapDO systemData) throws RemoteException Description copied from interface:IScmAppSoap
Updates information associated with an external system integrated with TeamForge.- Specified by:
setExternalSystemData
in interfaceIScmAppSoap
- Parameters:
sessionId
- the user session id.systemData
- the external system data to be updated- Throws:
NoSuchObjectFault
- If the external system does not exist internally.SystemFault
- When wrong parameters are provided or an unexpected system error occurs.InvalidSessionFault
- When the specified session id is invalid.PermissionDeniedFault
- When the user has insufficient privileges.InvalidOperationFault
- When an attempt is made to set different adapterName or adapterCatrogory.RemoteException
-
getCommitId
public String getCommitId(String sessionId, String revision, String externalSystemId, String repoPath) throws RemoteException Description copied from interface:IScmAppSoap
Returns a commit Id corresponding to an commit version.- Specified by:
getCommitId
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.revision
- The Revision NumberexternalSystemId
- External system id.repoPath
- Repository path.- Returns:
- The commit Id
- Throws:
InvalidSessionFault
- when the session is invalid (expired / time out)PermissionDeniedFault
- when the user does not have read access.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified repository id is invalid.RemoteException
-
getReplicableScmExternalSystemList
public ReplicableScmExternalSystemSoapList getReplicableScmExternalSystemList(String sessionId) throws RemoteException Description copied from interface:IScmAppSoap
Lists the replicable external systems. That is, the list of SvnEdge external systems that supports replication.- Specified by:
getReplicableScmExternalSystemList
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.- Returns:
- List of the replicable external systems
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
getReplicableScmExternalSystemList2
public ReplicableScmExternalSystemSoapList getReplicableScmExternalSystemList2(String sessionId, String adapterName) throws RemoteException Description copied from interface:IScmAppSoap
Lists the replicable external systems for all adapter types or for a given adapter type.- Specified by:
getReplicableScmExternalSystemList2
in interfaceIScmAppSoap
- Parameters:
sessionId
- User session id.adapterName
- the adapter name ornull
to list replicable systems for all adapters.- Returns:
- List of the replicable external systems.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
getReplicatedRepositoryList
public ReplicatedRepositorySoapList getReplicatedRepositoryList(String sessionId, String masterRepositoryId) throws RemoteException Description copied from interface:IScmAppSoap
Lists replicated repositories of the specified SCM master.- Specified by:
getReplicatedRepositoryList
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session keymasterRepositoryId
- the repository Id for which to find replicas- Returns:
- a list of ReplicatedRepository
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified master repository id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getReplicaListForExternalSystem
public ReplicaServerSoapList getReplicaListForExternalSystem(String sessionId, String externalSystemId, boolean approvedOnly) throws RemoteException Description copied from interface:IScmAppSoap
Returns list of replicas for given external system id.- Specified by:
getReplicaListForExternalSystem
in interfaceIScmAppSoap
- Parameters:
sessionId
- the user session id.externalSystemId
- The GUID of the external system.approvedOnly
- The GUID of the external system.- Returns:
- replicas list.
- Throws:
IllegalArgumentFault
- When wrong parameters are provided.InvalidSessionFault
- When the specified session id is invalid.RemoteException
-
getReplicaRepositoryList
public ReplicaRepositorySoapList getReplicaRepositoryList(String sessionId, String replicaId) throws RemoteException Description copied from interface:IScmAppSoap
Lists repositories of the specified replica.- Specified by:
getReplicaRepositoryList
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session keyreplicaId
- the replica Id for which to find repositories- Returns:
- a list of ReplicatedRepository
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified replica id is invalid.RemoteException
-
replicateRepository
public void replicateRepository(String sessionId, String repositoryId, String replicaId) throws RemoteException Description copied from interface:IScmAppSoap
Initiates the process of replicating of a given repository on a given replica.- Specified by:
replicateRepository
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session keyrepositoryId
- the id of the given repositoryreplicaId
- the id of the given replica- Throws:
IllegalArgumentFault
- when the repositoryId or replicaId are null or emptyInvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified master repository or replica are not validSystemFault
- if replica command creation failsPermissionDeniedFault
- if the user has no permissionRemoteException
-
removeRepositoryFromReplica
public void removeRepositoryFromReplica(String sessionId, String repositoryId, String replicaId) throws RemoteException Description copied from interface:IScmAppSoap
Remove process of replicating of a given repository on a given replica.- Specified by:
removeRepositoryFromReplica
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session keyrepositoryId
- the id of the given repositoryreplicaId
- the id of the given replica- Throws:
IllegalArgumentFault
- when the repositoryId or replicaId are null or emptyInvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified master repository or replica are not validSystemFault
- if replica command creation failsPermissionDeniedFault
- if the user has no permissionRemoteException
-
getAuthorizedKeysForUser
Description copied from interface:IScmAppSoap
Get all authorized keys for a user with a given username.- Specified by:
getAuthorizedKeysForUser
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session keyusername
- name of the user- Returns:
- Authorized keys, separated by '\n' character.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges (the sessionId is not of a site admin).SystemFault
- when an unexpected system error occurs.RemoteException
-
getAuthorizedKeys
Description copied from interface:IScmAppSoap
Get all authorized keys for calling user.- Specified by:
getAuthorizedKeys
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session key- Returns:
- Authorized keys, separated by '\n' character. Returns empty string if the user has no keys.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
setAuthorizedKeys
Description copied from interface:IScmAppSoap
Set authorized keys for calling user. Note: overwrites previous keys, if any.- Specified by:
setAuthorizedKeys
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session keyauthorizedKeys
- the string containing authorized keys, separated by '\n' character.- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
setAuthorizedKeysForUser
public void setAuthorizedKeysForUser(String sessionId, String username, String authorizedKeys) throws RemoteException Description copied from interface:IScmAppSoap
Set authorized keys for given user.- Specified by:
setAuthorizedKeysForUser
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session keyusername
- username for whom the authorized keys to be setauthorizedKeys
- the string containing authorized keys, separated by '\n' character.- Throws:
RemoteException
- when username is invalid
-
setAuthorizedKeys
public void setAuthorizedKeys(String sessionId, String username, String authorizedKeys) throws RemoteException Description copied from interface:IScmAppSoap
Set authorized keys for given user.- Specified by:
setAuthorizedKeys
in interfaceIScmAppSoap
- Parameters:
sessionId
- the session keyusername
- username for whom the authorized keys to be setauthorizedKeys
- the string containing authorized keys, separated by '\n' character.- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system error occurs.PermissionDeniedFault
- when the user has insufficient privileges.NoSuchObjectFault
- when the specified username is invalid.RemoteException
-