org.paylogic.jenkins.advancedscm.backends

Class MercurialBackend

java.lang.Object

org.paylogic.jenkins.advancedscm.backends.MercurialBackend

All Implemented Interfaces:

AdvancedSCMManager

public class MercurialBackend
extends Object

Mercurial Implementation of AdvancedSCMManager

Field Summary

Fields

Modifier and Type	Field and Description
protected hudson.FilePath	repoPath Path to the repository folder

Constructor Summary

Constructors

Constructor and Description
MercurialBackend(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener, hudson.plugins.mercurial.MercurialSCM scm) Please do not instantiate objects of this class yourself, use SCMManagerFactory.

Method Summary

Methods

Modifier and Type	Method and Description
void	clean() Cleans workspace from artifacts.
void	closeBranch(String branch, String message, String username) Close given branch
void	commit(String message, String username) Commit current workspace.
void	createFile(String filename, String content) Create file in the repository folder
ReleaseBranch	createReleaseBranch(String branch, String releaseFilePath, String releaseFileContent, String message, String username) Create the release branch.
void	ensureReleaseBranch(String branch, String releaseFilePath, String releaseFileContent, String message, String username) Ensure the release branch exists.
String	getBranch() Get the current branch name in the workspace.
List<Branch>	getBranches(boolean all) Get Mercurial branches from command line output, and put them in a List with Branches so it's nice to work with.
List<String>	getBranchNames(boolean all) Get open Mercurial branches from command line output, and put them in a List so it's nice to work with.
ReleaseBranch	getReleaseBranch(String branch) Get release branch from given branch name.
void	mergeHeads(String message, String username) Merge possible current branch's heads.
void	mergeWorkspaceWith(String revision, String updateTo) Merge current workspace with given revision.
void	pull() Executes 'pull' command
void	pull(String remote) Pulls changes from remotes.
void	pull(String remote, String branch) Pulls from given repository url.
void	push(String... branchNames) Executes 'push' command with -b
void	stripLocal() Strip out local commits which are not pushed yet.
void	update(String revision) Updates workspace to given revision/branch.
void	updateClean(String revision) Updates workspace to given revision/branch with cleaning.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

repoPath

protected hudson.FilePath repoPath

Path to the repository folder

Constructor Detail

MercurialBackend

public MercurialBackend(hudson.model.AbstractBuild build,
                hudson.Launcher launcher,
                hudson.model.BuildListener listener,
                hudson.plugins.mercurial.MercurialSCM scm)
                 throws IOException,
                        InterruptedException

Please do not instantiate objects of this class yourself, use SCMManagerFactory.

Throws:

IOException

InterruptedException

Method Detail

getBranches

public List<Branch> getBranches(boolean all)

Description copied from interface: AdvancedSCMManager

Get Mercurial branches from command line output, and put them in a List with Branches so it's nice to work with.

Specified by:

getBranches in interface AdvancedSCMManager

Parameters:

all - : get all or only open branches

Returns:

List of Branches

getBranch

public String getBranch()
                 throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Get the current branch name in the workspace.

Returns:

String with branch name in it.

Throws:

AdvancedSCMException

update

public void update(String revision)
            throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Updates workspace to given revision/branch.

Parameters:

revision - : String with revision, hash of branchname to update to.

Throws:

AdvancedSCMException

updateClean

public void updateClean(String revision)
                 throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Updates workspace to given revision/branch with cleaning.

Parameters:

revision - : String with revision, hash of branchname to update to.

Throws:

AdvancedSCMException

stripLocal

public void stripLocal()
                throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Strip out local commits which are not pushed yet.

Throws:

AdvancedSCMException

clean

public void clean()
           throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Cleans workspace from artifacts.

Throws:

AdvancedSCMException

closeBranch

public void closeBranch(String branch,
               String message,
               String username)
                 throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Close given branch

message - : String with message to give this commit.

username - : String commit user name (with email)

Throws:

AdvancedSCMException

mergeWorkspaceWith

public void mergeWorkspaceWith(String revision,
                      String updateTo)
                        throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Merge current workspace with given revision.

Parameters:

revision - : String with revision, hash or branchname to merge with.

updateTo - : String with revision, hash or branchname to update working copy to before actual merge.

Throws:

AdvancedSCMException

mergeHeads

public void mergeHeads(String message,
              String username)
                throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Merge possible current branch's heads.

Parameters:

message - : String commit message

username - : String commit user name (with email)

Throws:

AdvancedSCMException

commit

public void commit(String message,
          String username)
            throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Commit current workspace.

Parameters:

message - : String commit message

username - : String commit user name (with email)

Throws:

AdvancedSCMException

push

public void push(String... branchNames)
          throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Executes 'push' command with -b

Throws:

AdvancedSCMException

pull

public void pull()
          throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Executes 'pull' command

Throws:

AdvancedSCMException

pull

public void pull(String remote)
          throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Pulls changes from remotes. Give it a remote to pull changes from there.

Throws:

AdvancedSCMException

pull

public void pull(String remote,
        String branch)
          throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Pulls from given repository url. Give it a remote to pull changes from there.

Throws:

AdvancedSCMException

getReleaseBranch

public ReleaseBranch getReleaseBranch(String branch)
                               throws ReleaseBranchInvalidException

Description copied from interface: AdvancedSCMManager

Get release branch from given branch name.

Parameters:

branch - : String branch name

Returns:

ReleaseBranch : release branch object

Throws:

ReleaseBranchInvalidException

createReleaseBranch

public ReleaseBranch createReleaseBranch(String branch,
                                String releaseFilePath,
                                String releaseFileContent,
                                String message,
                                String username)
                                  throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Create the release branch.

Specified by:

createReleaseBranch in interface AdvancedSCMManager

Parameters:

branch - : String branch name

releaseFileContent - : String release file content

Throws:

AdvancedSCMException

getBranchNames

public List<String> getBranchNames(boolean all)
                            throws AdvancedSCMException

Description copied from interface: AdvancedSCMManager

Get open Mercurial branches from command line output, and put them in a List so it's nice to work with.

Specified by:

getBranchNames in interface AdvancedSCMManager

Parameters:

all - : get all or only open branches

Returns:

List of String

Throws:

AdvancedSCMException

ensureReleaseBranch

public void ensureReleaseBranch(String branch,
                       String releaseFilePath,
                       String releaseFileContent,
                       String message,
                       String username)
                         throws AdvancedSCMException,
                                ReleaseBranchInvalidException

Description copied from interface: AdvancedSCMManager

Ensure the release branch exists.

Specified by:

ensureReleaseBranch in interface AdvancedSCMManager

Parameters:

branch - : String branch name

releaseFileContent - : String release file content

Throws:

AdvancedSCMException

ReleaseBranchInvalidException

createFile

public void createFile(String filename,
              String content)
                throws IOException,
                       InterruptedException

Create file in the repository folder

Parameters:

filename: - String relative path to the file from the repository root

content: - String file content (UTF-8 encoding is hard-coded)

Throws:

IOException

InterruptedException