Package com.collabnet.ce.soap60.webservices.scm

Class ScmAppSoapStub

java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.scm.ScmAppSoapStub
All Implemented Interfaces:
IScmAppSoap
public class ScmAppSoapStub extends ClientSoapStub implements IScmAppSoap

  • Constructor Details

    • ScmAppSoapStub

      public ScmAppSoapStub(String soapServerUrl)

  • 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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      projectId - The project id.
      Returns:
      List of SCM repositories within the specified project.
      Throws:
      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 interface IScmAppSoap
      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:
      RemoteException

    • 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 interface IScmAppSoap
      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:
      RemoteException

    • getCommitData

      public CommitSoapDO getCommitData(String sessionId, String commitId) throws RemoteException
      Description copied from interface: IScmAppSoap
      Returns data associated with a specific commit.
      Specified by:
      getCommitData in interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      commitId - The commit id.
      Returns:
      Commit data.
      Throws:
      RemoteException

    • getCommitData2

      public Commit2SoapDO getCommitData2(String sessionId, String commitId) throws RemoteException
      Description copied from interface: IScmAppSoap
      Returns data associated with a specific commit.
      Specified by:
      getCommitData2 in interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      commitId - The commit id.
      Returns:
      Commit data
      Throws:
      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 interface IScmAppSoap
      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:
      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 interface IScmAppSoap
      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:
      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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      repositoryId - The id of the repository
      Returns:
      Repository Data
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      repositoryId - The id of the repository
      Returns:
      Repository Data
      Throws:
      RemoteException

    • setRepositoryData

      public void setRepositoryData(String sessionId, Repository2SoapDO repository) throws RemoteException
      Description copied from interface: IScmAppSoap
      Sets the repository data
      Specified by:
      setRepositoryData in interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      repository - The repository data
      Throws:
      RemoteException

    • getReplicaData

      public ReplicaDataSoapDO getReplicaData(String sessionId, String replicaId) throws RemoteException
      Description copied from interface: IScmAppSoap
      For a given replica server id get the replica server data.
      Specified by:
      getReplicaData in interface IScmAppSoap
      Parameters:
      sessionId - the user session
      replicaId - the replica server id
      Returns:
      the replica server data
      Throws:
      RemoteException

    • setReplicaData

      public void setReplicaData(String sessionId, ReplicaDataSoapDO replica) throws RemoteException
      Description copied from interface: IScmAppSoap
      Sets replica server data.
      Specified by:
      setReplicaData in interface IScmAppSoap
      Parameters:
      sessionId - user session id
      replica - the replica server data to be set
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      repositoryId - The id of the repository
      userName - User name.
      Returns:
      command to check out the repository
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      repositoryId - The id of the repository
      Returns:
      protocol to checkout command tuples
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      repositoryId - The id of the repository
      replicaId - The id of the replica to which checkout command should point
      Returns:
      protocol to checkout command tuples
      Throws:
      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 interface IScmAppSoap
      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:
      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 interface IScmAppSoap
      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:
      RemoteException

    • deleteRepository

      public void deleteRepository(String sessionId, String repositoryId) throws RemoteException
      Description copied from interface: IScmAppSoap
      Delete the repository with specified ID.
      Specified by:
      deleteRepository in interface IScmAppSoap
      Parameters:
      sessionId - The user's SOAP session id
      repositoryId - The id of the repository to be deleted
      Throws:
      RemoteException

    • 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 interface IScmAppSoap
      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:
      RemoteException

    • getScmAdapterNames

      public String[] getScmAdapterNames(String sessionId) throws RemoteException
      Description copied from interface: IScmAppSoap
      Returns a string array containing the known list of supported SCM adapters on the server.
      Specified by:
      getScmAdapterNames in interface IScmAppSoap
      Parameters:
      sessionId - The user's SOAP session id
      Returns:
      String[] The known SCM adapter names
      Throws:
      RemoteException

    • 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 interface IScmAppSoap
      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:
      RemoteException

    • 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 interface IScmAppSoap
      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:
      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 interface IScmAppSoap
      Parameters:
      sessionId - the user session id.
      systemId - The GUID of the external system.
      Returns:
      the external system data.
      Throws:
      RemoteException

    • getExternalSystemList

      public ExternalSystemSoapList getExternalSystemList(String sessionId) throws RemoteException
      Description copied from interface: IScmAppSoap
      Gets a list of external scm systems integrated with TeamForge.
      Specified by:
      getExternalSystemList in interface IScmAppSoap
      Parameters:
      sessionId - the user session id.
      Returns:
      the external system list.
      Throws:
      RemoteException

    • getExternalSystemList2

      public ExternalSystem2SoapList getExternalSystemList2(String sessionId) throws RemoteException
      Description copied from interface: IScmAppSoap
      Gets a list of external scm systems integrated with TeamForge.
      Specified by:
      getExternalSystemList2 in interface IScmAppSoap
      Parameters:
      sessionId - the user session id.
      Returns:
      the external system list.
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - the user session id.
      systemData - the external system data to be updated
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      revision - The Revision Number
      externalSystemId - External system id.
      repoPath - Repository path.
      Returns:
      The commit Id
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      Returns:
      List of the replicable external systems
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - User session id.
      adapterName - the adapter name or null to list replicable systems for all adapters.
      Returns:
      List of the replicable external systems.
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - the session key
      masterRepositoryId - the repository Id for which to find replicas
      Returns:
      a list of ReplicatedRepository
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - the user session id.
      externalSystemId - The GUID of the external system.
      approvedOnly - The GUID of the external system.
      Returns:
      replicas list.
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - the session key
      replicaId - the replica Id for which to find repositories
      Returns:
      a list of ReplicatedRepository
      Throws:
      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 interface IScmAppSoap
      Parameters:
      sessionId - the session key
      repositoryId - the id of the given repository
      replicaId - the id of the given replica
      Throws:
      RemoteException

    • 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 interface IScmAppSoap
      Parameters:
      sessionId - the session key
      repositoryId - the id of the given repository
      replicaId - the id of the given replica
      Throws:
      RemoteException

    • getAuthorizedKeysForUser

      public String getAuthorizedKeysForUser(String sessionId, String username) throws RemoteException
      Description copied from interface: IScmAppSoap
      Get all authorized keys for a user with a given username.
      Specified by:
      getAuthorizedKeysForUser in interface IScmAppSoap
      Parameters:
      sessionId - the session key
      username - name of the user
      Returns:
      Authorized keys, separated by '\n' character.
      Throws:
      RemoteException

    • getAuthorizedKeys

      public String getAuthorizedKeys(String sessionId) throws RemoteException
      Description copied from interface: IScmAppSoap
      Get all authorized keys for calling user.
      Specified by:
      getAuthorizedKeys in interface IScmAppSoap
      Parameters:
      sessionId - the session key
      Returns:
      Authorized keys, separated by '\n' character. Returns empty string if the user has no keys.
      Throws:
      RemoteException

    • setAuthorizedKeys

      public void setAuthorizedKeys(String sessionId, String authorizedKeys) throws RemoteException
      Description copied from interface: IScmAppSoap
      Set authorized keys for calling user. Note: overwrites previous keys, if any.
      Specified by:
      setAuthorizedKeys in interface IScmAppSoap
      Parameters:
      sessionId - the session key
      authorizedKeys - the string containing authorized keys, separated by '\n' character.
      Throws:
      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 interface IScmAppSoap
      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:
      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 interface IScmAppSoap
      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:
      RemoteException