Method Detail

• public ActivationStatus activateFor(WsdlProjectPro project)

  A callback that activates this integration component for the specified project. Called when a project associated with this particular VCS is opened.

  Parameters:

  project - the project that has been opened

  Returns:

  an object representing the status

• public ImportProjectFromVcsGui buildRepositoryDownloadGui(Workspace workspace)

  Return a GUI component for selecting a repository containing a composite project. The GUI is responsible for processing user input and handling the download (which should be possible to cancel while in progress).

  Parameters:

  workspace - the workspace that the project will be added to after the download

  Returns:

  a Component that can be added to a dialog and handles all aspect of the repository download

• public RepositorySelectionGui buildRepositorySelectionGui(WsdlProjectPro project)

  Return a GUI component for selecting the repository to associate with a project.

  Parameters:

  project - the project with which the repository is to be associated

  Returns:

  a Component that can be added to a dialog and initializes everything needed to work with a remote repository

• public CommitResult commit(java.util.Collection<VcsUpdate> updates, java.lang.String commitMessage)

  Creates a local commit with the changes.

  throws:

  IllegalStateException if local repo is in invalid state or local updates exist

  Parameters:

  updates - a collection of objects representing the local updates

  commitMessage - user's commit message explaining the changes

  Returns:

  an object encapsulating the status of the operation

• public void createTag(WsdlProjectPro project, java.lang.String tagName)

  Create a tag (label) for the current state and commit the tag to the remote repository. There must be no local updates when this operation is performed, and the tag name must be unique.

  throws:

  IllegalStateException if local repo is in invalid state or local updates exist

  throws:

  IllegalArgumentException if the tag name is not unique

  throws:

  VcsIntegrationException if the underlying operation fails

  Parameters:

  project - the project for which to check (which will often contain a reference to a repository)

  tagName - the name of the tag

• public java.util.Set<java.lang.String> getAvailableTags(WsdlProjectPro project)

  Gets the names of all existing tags. If it is possible to have them sorted by creation date, the set shall be a SortedSet with the oldest tag being the first.

  throws:

  IllegalStateException if local repo is in invalid state or local updates exist

  throws:

  VcsIntegrationException if the underlying operation fails

  Parameters:

  project - the project for which to check (which will often contain a reference to a repository)

  Returns:

  a set with the names of all existing tags, which may or may not be sorted

• public java.util.List<VcsBranch> getBranchList(WsdlProjectPro project)

  Gets list of branches in the repository of the project

  throws:

  VcsIntegrationException if the underlying operation fails

  Parameters:

  project - the project for which to check (which will often contain a reference to a repository)

  Returns:

  existing branches in the repository

• public VcsBranch getCurrentBranch(WsdlProjectPro project)

  Parameters:

  project - the project with repository

  Returns:

  a full name of the current branch of the repository of the project

• public java.lang.String getDescription()

  Returns:

  a description of the integration

• public java.util.Collection<VcsUpdate> getLocalRepositoryUpdates(WsdlProjectPro project)

  Get a list of all the local, uncommitted updates.

  throws:

  IllegalStateException if local repo is in invalid state or local updates exist

  Parameters:

  project - the project for which to check (which will contain a reference to a repository)

  Returns:

  A collection of objects encapsulating local VCS changes (added, updated, deleted files etc.)

• public java.lang.String getName()

  Returns:

  a name of the integration

• public java.util.List<HistoryEntry> getProjectHistory(WsdlProjectPro project)

  Gets the complete commit history of the specified project.

  throws:

  IllegalStateException if local repo is in invalid state

  Parameters:

  project - the project for which to check (which will often contain a reference to a repository)

  Returns:

  an ordered list (newest first) of changes associated with the file in the remote repository

• public java.util.Collection<VcsUpdate> getRemoteRepositoryUpdates(java.io.File projectFile)

  Get a list of all the updates in the remote repository, along with info about whether there's a conflict with local changes.

  Parameters:

  projectFile - file (where project is saved) for the project for which to check (which will contain a reference to a repository)

  Returns:

  A collection of objects encapsulating remote VCS changes (added, updated, deleted files etc.)

• public boolean hasRemoteRepository(WsdlProjectPro project)

  Also, @see#setupRemoteRepository

  Parameters:

  project - to check

  Returns:

  true, if the project contains a repository and the repository connected to the remote repository

• public boolean hasRemoteRepository(java.io.File projectDirectory)

  Also, @see#setupRemoteRepository

  Parameters:

  projectDirectory - to check

  Returns:

  true, if the project contains a repository and the repository connected to the remote repository

• public boolean isActivatedFor(java.io.File projectDirectory)

  Parameters:

  projectDirectory - directory to check does it contains a repository

  Returns:

  true if the directory contains a repository

• public CommitResult pushToRemote(WsdlProjectPro project)

  Sends all the last local commits to the remote repository.

  throws:

  IllegalStateException if local repo is in invalid state or local updates exist

  Parameters:

  project - the project changes which are pushed

  Returns:

  an object encapsulating the status of the operation

• public void revert(java.util.Collection<VcsUpdate> updates)

  Reverts a local update.

  throws:

  IllegalStateException if local repo is in invalid state or local updates exist

  throws:

  VcsIntegrationException if the operation cannot be performed

  Parameters:

  updates - an collection of objects representing the updates to revert

• public boolean setupRemoteRepository(WsdlProjectPro project, java.lang.String uri, CredentialsProvider credentialsProvider)

  Call it for composite project which contains a repository

  Parameters:

  project - a composite project with a repository

  uri - of the remote repository

  credentialsProvider - contains a credentials for the remote repository to save it for future

  Returns:

• public boolean switchBranch(WsdlProjectPro project, VcsBranch branch)

  Switches the repository to decided branch

  throws:

  VcsIntegrationException if the underlying operation fails

  Parameters:

  project - the project for which to check (which will often contain a reference to a repository)

  Returns:

  success or not

• public boolean updateFromRemoteRepository(java.io.File projectFile, boolean overwriteLocalChanges)

  Apply all the changes from the remote repository

  Parameters:

  projectFile - the file where project saved

  overwriteLocalChanges - whether the update should overwrite all conflicting local changes

  Returns:

  true if project has been updated