com.eviware.soapui.plugins.vcs

Interface VcsIntegration

All Known Implementing Classes:

ReadyApiGitIntegration

public interface VcsIntegration

Defines a VCS integration facade that will be loaded from a plugin.

Method Summary

Modifier and Type	Method and Description
ActivationStatus	activateFor(WsdlProjectPro project) A callback that activates this integration component for the specified project.
ImportProjectFromVcsGui	buildRepositoryDownloadGui(com.eviware.soapui.model.workspace.Workspace workspace) Return a GUI component for selecting a repository containing a composite project.
RepositorySelectionGui	buildRepositorySelectionGui(WsdlProjectPro project) Return a GUI component for selecting the repository to associate with a project.
CommitResult	commit(Collection<VcsUpdate> updates, String commitMessage) Creates a local commit with the changes.
void	createTag(WsdlProjectPro project, String tagName) Create a tag (label) for the current state and commit the tag to the remote repository.
Set<String>	getAvailableTags(WsdlProjectPro project) Gets the names of all existing tags.
List<VcsBranch>	getBranchList(WsdlProjectPro project) Gets list of branches in the repository of the project
VcsBranch	getCurrentBranch(WsdlProjectPro project)
String	getDescription()
Collection<VcsUpdate>	getLocalRepositoryUpdates(WsdlProjectPro project) Get a list of all the local, uncommitted updates.
String	getName()
List<HistoryEntry>	getProjectHistory(WsdlProjectPro project) Gets the complete commit history of the specified project.
Collection<VcsUpdate>	getRemoteRepositoryUpdates(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.
boolean	hasRemoteRepository(File projectDirectory) Also, @see#setupRemoteRepository
boolean	hasRemoteRepository(WsdlProjectPro project) Also, @see#setupRemoteRepository
boolean	isActivatedFor(File projectDirectory)
CommitResult	pushToRemote(WsdlProjectPro project) Sends all the last local commits to the remote repository.
void	revert(Collection<VcsUpdate> updates) Reverts a local update.
boolean	setupRemoteRepository(WsdlProjectPro project, String uri, org.eclipse.jgit.transport.CredentialsProvider credentialsProvider) Call it for composite project which contains a repository
boolean	switchBranch(WsdlProjectPro project, VcsBranch branch) Switches the repository to decided branch
boolean	updateFromRemoteRepository(File projectFile, boolean overwriteLocalChanges) Apply all the changes from the remote repository

Method Detail

activateFor

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

buildRepositorySelectionGui

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

buildRepositoryDownloadGui

ImportProjectFromVcsGui buildRepositoryDownloadGui(com.eviware.soapui.model.workspace.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

getRemoteRepositoryUpdates

Collection<VcsUpdate> getRemoteRepositoryUpdates(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.)

getLocalRepositoryUpdates

Collection<VcsUpdate> getLocalRepositoryUpdates(WsdlProjectPro project)

Get a list of all the local, uncommitted updates.

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.)

Throws:

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

updateFromRemoteRepository

boolean updateFromRemoteRepository(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

commit

CommitResult commit(Collection<VcsUpdate> updates,
                    String commitMessage)

Creates a local commit with the changes.

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

Throws:

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

pushToRemote

CommitResult pushToRemote(WsdlProjectPro project)

Sends all the last local commits to the remote repository.

Parameters:

project - the project changes which are pushed

Returns:

an object encapsulating the status of the operation

Throws:

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

revert

void revert(Collection<VcsUpdate> updates)
     throws VcsIntegrationException

Reverts a local update.

Parameters:

updates - an collection of objects representing the updates to revert

Throws:

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

VcsIntegrationException - if the operation cannot be performed

getAvailableTags

Set<String> getAvailableTags(WsdlProjectPro project)
                      throws VcsIntegrationException

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.

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

Throws:

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

VcsIntegrationException - if the underlying operation fails

createTag

void createTag(WsdlProjectPro project,
               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.

Parameters:

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

tagName - the name of the tag

Throws:

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

IllegalArgumentException - if the tag name is not unique

VcsIntegrationException - if the underlying operation fails

getProjectHistory

List<HistoryEntry> getProjectHistory(WsdlProjectPro project)

Gets the complete commit history of the specified project.

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

Throws:

IllegalStateException - if local repo is in invalid state

getBranchList

List<VcsBranch> getBranchList(WsdlProjectPro project)

Gets list of branches in the repository of the project

Parameters:

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

Returns:

existing branches in the repository

Throws:

VcsIntegrationException - if the underlying operation fails

switchBranch

boolean switchBranch(WsdlProjectPro project,
                     VcsBranch branch)

Switches the repository to decided branch

Parameters:

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

Returns:

success or not

Throws:

VcsIntegrationException - if the underlying operation fails

isActivatedFor

boolean isActivatedFor(File projectDirectory)

Parameters:

projectDirectory - directory to check does it contains a repository

Returns:

true if the directory contains a repository

getName

String getName()

Returns:

a name of the integration

getDescription

String getDescription()

Returns:

a description of the integration

setupRemoteRepository

boolean setupRemoteRepository(WsdlProjectPro project,
                              String uri,
                              org.eclipse.jgit.transport.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:

hasRemoteRepository

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

hasRemoteRepository

boolean hasRemoteRepository(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

getCurrentBranch

VcsBranch getCurrentBranch(WsdlProjectPro project)

Parameters:

project - the project with repository

Returns:

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