org.nuiton.scmwebeditor.api

Interface ScmProvider

public interface ScmProvider

An interface which allows to know and to use the specific features of each SCM

Method Summary

Modifier and Type	Method and Description
boolean	addressSeemsCompatible(String address) Tells whether the given address seems compatible with the SCM
String	changeBranch(String branchName, String pathToLocalRepos, String username, String password) Changes the working branch for the local repository
String	createBranch(CreateBranchDto dto) Allows to create a new branch on the repository
boolean	filesDirectlyAccessible() Tells whether the repositories' files are directly accessible by their address
ScmConnection	getConnection(String address, String pathToLocalRepos) Gives the connection to the SCM
String	getDefaultBranchName() Gives the name of the default branch if the SCM supports branches
ScmFileManager	getFileManager(ScmConnection connection) Gives the file manager for the given connection
List<String>	listBranches(String address, String username, String password) Makes a list of the repository's branches
boolean	supportsBranches() Tells whether the SCM supports branches
boolean	supportsPush() Tells whether the SCM allows to choose when the commits are pushed to the server

Method Detail

supportsBranches

boolean supportsBranches()

Tells whether the SCM supports branches

Returns:

true if the SCM supports branches

listBranches

List<String> listBranches(String address,
                          String username,
                          String password)
                   throws OperationNotSupportedException

Makes a list of the repository's branches

Parameters:

address - the repository's address

username - the username used to connect to the SCM

password - the password used to connect to the SCM

Returns:

a list of the repository's branches

Throws:

OperationNotSupportedException - if the SCM doesn't support branches

createBranch

String createBranch(CreateBranchDto dto)
             throws OperationNotSupportedException,
                    AuthenticationException,
                    RepositoryNotFoundException

Allows to create a new branch on the repository

Parameters:

dto - the DTO which contains all the parameters

Returns:

an error code or null if there was no error during the process

Throws:

OperationNotSupportedException - if the SCM doesn't support branches

AuthenticationException - if there is an authentication problem

RepositoryNotFoundException - if the repository could not be reached

changeBranch

String changeBranch(String branchName,
                    String pathToLocalRepos,
                    String username,
                    String password)
             throws OperationNotSupportedException

Changes the working branch for the local repository

Parameters:

branchName - the new working branch

pathToLocalRepos - the path to the directory where the local repositories are stored

username - the username to use to connect to the repository

password - the password to use to connect to the repository

Returns:

an error code or null if there was no error during the process

Throws:

OperationNotSupportedException - if the SCM doesn't support branches

supportsPush

boolean supportsPush()

Tells whether the SCM allows to choose when the commits are pushed to the server

Returns:

true if the SCM supports a command to push the commits to the server

filesDirectlyAccessible

boolean filesDirectlyAccessible()

Tells whether the repositories' files are directly accessible by their address

Returns:

true if the files are directly accessible

getConnection

ScmConnection getConnection(String address,
                            String pathToLocalRepos)

Gives the connection to the SCM

Parameters:

address - the repository's address

pathToLocalRepos - the folder which will be used to store one client's repositories

Returns:

the connection to the SCM

getFileManager

ScmFileManager getFileManager(ScmConnection connection)

Gives the file manager for the given connection

Parameters:

connection - the connection to the repository

Returns:

the file manager for the repository

addressSeemsCompatible

boolean addressSeemsCompatible(String address)

Tells whether the given address seems compatible with the SCM

Parameters:

address - the repository's address

Returns:

true if the repository seems to be compatible with the SCM

getDefaultBranchName

String getDefaultBranchName()
                     throws OperationNotSupportedException

Gives the name of the default branch if the SCM supports branches

Returns:

the name of the default branch to use

Throws:

OperationNotSupportedException - if the SCM doesn't support branches