Package org.apache.maven.scm.provider.svn

Class AbstractSvnScmProvider

java.lang.Object

org.apache.maven.scm.provider.AbstractScmProvider

org.apache.maven.scm.provider.svn.AbstractSvnScmProvider

All Implemented Interfaces:

ScmProvider

Direct Known Subclasses:

SvnExeScmProvider

public abstract class AbstractSvnScmProvider
extends AbstractScmProvider

SCM Provider for Subversion.

Author:

Emmanuel Venisse

Field Summary

Fields

Modifier and Type	Field	Description
static String	CURRENT_WORKING_DIRECTORY

Fields inherited from class org.apache.maven.scm.provider.AbstractScmProvider

logger

Constructor Summary

Constructors

Constructor	Description
AbstractSvnScmProvider()

Method Summary

Modifier and Type	Method	Description
AddScmResult	add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)	TODO: why public? This should be protected, no?
protected BlameScmResult	blame(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
protected BranchScmResult	branch(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
ChangeLogScmResult	changelog(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
CheckInScmResult	checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
CheckOutScmResult	checkout(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
DiffScmResult	diff(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
protected ScmResult	executeCommand(SvnCommand command, ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
protected ExportScmResult	export(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
protected abstract SvnCommand	getAddCommand()
protected abstract SvnCommand	getBlameCommand()
protected abstract SvnCommand	getBranchCommand()
protected abstract SvnCommand	getChangeLogCommand()
protected abstract SvnCommand	getCheckInCommand()
protected abstract SvnCommand	getCheckOutCommand()
protected abstract SvnCommand	getDiffCommand()
protected abstract SvnCommand	getExportCommand()
protected abstract SvnCommand	getInfoCommand()
protected abstract SvnCommand	getListCommand()
protected abstract SvnCommand	getMkdirCommand()
protected abstract SvnCommand	getRemoveCommand()
protected abstract String	getRepositoryURL(File path)
String	getScmSpecificFilename()	Returns the scm reserved file name where the SCM stores information like '.git', '.svn'.
String	getScmType()
protected abstract SvnCommand	getStatusCommand()
protected abstract SvnCommand	getTagCommand()
protected abstract SvnCommand	getUntagCommand()
protected abstract SvnCommand	getUpdateCommand()
InfoScmResult	info(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
ListScmResult	list(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)	List each element (files and directories) of fileSet as they exist in the repository.
ScmProviderRepository	makeProviderScmRepository(File path)	Try to create a ScmProviderRepository for this provider from the given working directory (created through a previous checkout).
ScmProviderRepository	makeProviderScmRepository(String scmSpecificUrl, char delimiter)
MkdirScmResult	mkdir(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)	Create directory/directories in the repository.
abstract boolean	remoteUrlExist(ScmProviderRepository repository, CommandParameters parameters)
RemoveScmResult	remove(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
StatusScmResult	status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
TagScmResult	tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
UntagScmResult	untag(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters)	Deletes a tag.
UpdateScmResult	update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
List<String>	validateScmUrl(String scmSpecificUrl, char delimiter)	Validate the scm url.

Methods inherited from class org.apache.maven.scm.provider.AbstractScmProvider

add, add, add, blame, blame, branch, branch, branch, changeLog, changeLog, changeLog, changeLog, changeLog, changeLog, changeLog, changeLog, changeLog, checkIn, checkIn, checkIn, checkIn, checkOut, checkOut, checkOut, checkOut, checkOut, checkOut, checkOut, diff, diff, edit, edit, export, export, export, export, export, list, list, login, mkdir, remoteInfo, remove, requiresEditMode, sanitizeTagName, status, tag, tag, tag, unedit, unedit, update, update, update, update, update, update, update, update, update, update, update, update, validateTagName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.scm.provider.ScmProvider

setInteractive

Field Detail

CURRENT_WORKING_DIRECTORY

public static final String CURRENT_WORKING_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

AbstractSvnScmProvider

public AbstractSvnScmProvider()

Method Detail

getScmSpecificFilename

public String getScmSpecificFilename()

Returns the scm reserved file name where the SCM stores information like '.git', '.svn'.

Specified by:

getScmSpecificFilename in interface ScmProvider

Overrides:

getScmSpecificFilename in class AbstractScmProvider

Returns:

the scm reserved file name

makeProviderScmRepository

public ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl,
                                                       char delimiter)
                                                throws ScmRepositoryException

Throws:

ScmRepositoryException

makeProviderScmRepository

public ScmProviderRepository makeProviderScmRepository(File path)
                                                throws ScmRepositoryException,
                                                       UnknownRepositoryStructure

Try to create a ScmProviderRepository for this provider from the given working directory (created through a previous checkout). This is only successful if the working directory is recognized by this SCM provider.

Specified by:

makeProviderScmRepository in interface ScmProvider

Overrides:

makeProviderScmRepository in class AbstractScmProvider

Parameters:

path - the checkout(working) directory

Returns:

the repository bound to this provider

Throws:

ScmRepositoryException - in case the given directory does not contain a valid working directory recognized by this provider

UnknownRepositoryStructure - in case the provider does not support this way of initializing an ScmProviderRepository

getRepositoryURL

protected abstract String getRepositoryURL(File path)
                                    throws ScmException

Throws:

ScmException

validateScmUrl

public List<String> validateScmUrl(String scmSpecificUrl,
                                   char delimiter)

Validate the scm url.

Specified by:

validateScmUrl in interface ScmProvider

Overrides:

validateScmUrl in class AbstractScmProvider

Parameters:

scmSpecificUrl - the SCM url

delimiter - the delimiter used in the SCM url

Returns:

returns a list of messages if the validation failed

getScmType

public String getScmType()

getAddCommand

protected abstract SvnCommand getAddCommand()

add

public AddScmResult add(ScmProviderRepository repository,
                        ScmFileSet fileSet,
                        CommandParameters parameters)
                 throws ScmException

TODO: why public? This should be protected, no?

Overrides:

add in class AbstractScmProvider

Throws:

ScmException

getBranchCommand

protected abstract SvnCommand getBranchCommand()

branch

protected BranchScmResult branch(ScmProviderRepository repository,
                                 ScmFileSet fileSet,
                                 CommandParameters parameters)
                          throws ScmException

Overrides:

branch in class AbstractScmProvider

Throws:

ScmException

getChangeLogCommand

protected abstract SvnCommand getChangeLogCommand()

changelog

public ChangeLogScmResult changelog(ScmProviderRepository repository,
                                    ScmFileSet fileSet,
                                    CommandParameters parameters)
                             throws ScmException

Overrides:

changelog in class AbstractScmProvider

Throws:

ScmException

getCheckInCommand

protected abstract SvnCommand getCheckInCommand()

checkin

public CheckInScmResult checkin(ScmProviderRepository repository,
                                ScmFileSet fileSet,
                                CommandParameters parameters)
                         throws ScmException

Overrides:

checkin in class AbstractScmProvider

Throws:

ScmException

getCheckOutCommand

protected abstract SvnCommand getCheckOutCommand()

checkout

public CheckOutScmResult checkout(ScmProviderRepository repository,
                                  ScmFileSet fileSet,
                                  CommandParameters parameters)
                           throws ScmException

Overrides:

checkout in class AbstractScmProvider

Throws:

ScmException

getDiffCommand

protected abstract SvnCommand getDiffCommand()

diff

public DiffScmResult diff(ScmProviderRepository repository,
                          ScmFileSet fileSet,
                          CommandParameters parameters)
                   throws ScmException

Overrides:

diff in class AbstractScmProvider

Throws:

ScmException

getExportCommand

protected abstract SvnCommand getExportCommand()

export

protected ExportScmResult export(ScmProviderRepository repository,
                                 ScmFileSet fileSet,
                                 CommandParameters parameters)
                          throws ScmException

Overrides:

export in class AbstractScmProvider

Throws:

ScmException

getRemoveCommand

protected abstract SvnCommand getRemoveCommand()

remove

public RemoveScmResult remove(ScmProviderRepository repository,
                              ScmFileSet fileSet,
                              CommandParameters parameters)
                       throws ScmException

Overrides:

remove in class AbstractScmProvider

Throws:

ScmException

getStatusCommand

protected abstract SvnCommand getStatusCommand()

status

public StatusScmResult status(ScmProviderRepository repository,
                              ScmFileSet fileSet,
                              CommandParameters parameters)
                       throws ScmException

Overrides:

status in class AbstractScmProvider

Throws:

ScmException

getTagCommand

protected abstract SvnCommand getTagCommand()

tag

public TagScmResult tag(ScmProviderRepository repository,
                        ScmFileSet fileSet,
                        CommandParameters parameters)
                 throws ScmException

Overrides:

tag in class AbstractScmProvider

Throws:

ScmException

getUntagCommand

protected abstract SvnCommand getUntagCommand()

untag

public UntagScmResult untag(ScmRepository repository,
                            ScmFileSet fileSet,
                            CommandParameters parameters)
                     throws ScmException

Deletes a tag.

Specified by:

untag in interface ScmProvider

Overrides:

untag in class AbstractScmProvider

Parameters:

repository - the source control system

fileSet - a fileset with the relevant working directory as basedir

parameters - TODO

Returns:

TODO

Throws:

ScmException - if any

getUpdateCommand

protected abstract SvnCommand getUpdateCommand()

update

public UpdateScmResult update(ScmProviderRepository repository,
                              ScmFileSet fileSet,
                              CommandParameters parameters)
                       throws ScmException

Overrides:

update in class AbstractScmProvider

Throws:

ScmException

executeCommand

protected ScmResult executeCommand(SvnCommand command,
                                   ScmProviderRepository repository,
                                   ScmFileSet fileSet,
                                   CommandParameters parameters)
                            throws ScmException

Throws:

ScmException

getListCommand

protected abstract SvnCommand getListCommand()

list

public ListScmResult list(ScmProviderRepository repository,
                          ScmFileSet fileSet,
                          CommandParameters parameters)
                   throws ScmException

List each element (files and directories) of fileSet as they exist in the repository.

Overrides:

list in class AbstractScmProvider

Parameters:

repository - the source control system

fileSet - the files to list

parameters - TODO

Returns:

the list of files in the repository

Throws:

NoSuchCommandScmException - unless overriden by subclass

ScmException - if any

getInfoCommand

protected abstract SvnCommand getInfoCommand()

info

public InfoScmResult info(ScmProviderRepository repository,
                          ScmFileSet fileSet,
                          CommandParameters parameters)
                   throws ScmException

Specified by:

info in interface ScmProvider

Overrides:

info in class AbstractScmProvider

Parameters:

repository - the source control system

fileSet - location of your local copy

parameters - some parameters (not use currently but for future use)

Returns:

if the scm implementation doesn't support "info" result will null

Throws:

ScmException - if any

blame

protected BlameScmResult blame(ScmProviderRepository repository,
                               ScmFileSet fileSet,
                               CommandParameters parameters)
                        throws ScmException

Overrides:

blame in class AbstractScmProvider

Throws:

ScmException

getBlameCommand

protected abstract SvnCommand getBlameCommand()

mkdir

public MkdirScmResult mkdir(ScmProviderRepository repository,
                            ScmFileSet fileSet,
                            CommandParameters parameters)
                     throws ScmException

Create directory/directories in the repository.

Overrides:

mkdir in class AbstractScmProvider

Parameters:

repository - TODO

fileSet - TODO

parameters - TODO

Returns:

TODO

Throws:

ScmException - if any

getMkdirCommand

protected abstract SvnCommand getMkdirCommand()

remoteUrlExist

public abstract boolean remoteUrlExist(ScmProviderRepository repository,
                                       CommandParameters parameters)
                                throws ScmException

Parameters:

repository -

parameters -

Returns:

true if remote url exists

Throws:

ScmException

Since:

1.8