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
SCM Provider for Subversion
- Author:
- Emmanuel Venisse
-
Field Summary
Fields inherited from class org.apache.maven.scm.provider.AbstractScmProvider
logger
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadd
(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) changelog
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) checkin
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) checkout
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) 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
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract String
getRepositoryURL
(File path) Returns the scm reserved file name where the SCM stores information like '.git', '.svn'.protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
protected abstract SvnCommand
info
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) list
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) List each element (files and directories) of fileSet as they exist in the repository.makeProviderScmRepository
(String scmSpecificUrl, char delimiter) mkdir
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) Create directory/directories in the repository.abstract boolean
remoteUrlExist
(ScmProviderRepository repository, CommandParameters parameters) remove
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) status
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) tag
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) untag
(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters) Deletes a tag.update
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) 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, 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 Details
-
CURRENT_WORKING_DIRECTORY
- See Also:
-
-
Constructor Details
-
AbstractSvnScmProvider
public AbstractSvnScmProvider()
-
-
Method Details
-
getScmSpecificFilename
Returns the scm reserved file name where the SCM stores information like '.git', '.svn'.- Specified by:
getScmSpecificFilename
in interfaceScmProvider
- Overrides:
getScmSpecificFilename
in classAbstractScmProvider
- 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 - Specified by:
makeProviderScmRepository
in interfaceScmProvider
- Overrides:
makeProviderScmRepository
in classAbstractScmProvider
- Throws:
ScmRepositoryException
UnknownRepositoryStructure
-
getRepositoryURL
- Throws:
ScmException
-
validateScmUrl
Validate the scm url.- Specified by:
validateScmUrl
in interfaceScmProvider
- Overrides:
validateScmUrl
in classAbstractScmProvider
- Parameters:
scmSpecificUrl
- The SCM urldelimiter
- The delimiter used in the SCM url- Returns:
- Returns a list of messages if the validation failed
-
getScmType
-
getAddCommand
-
add
public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException TODO: why public? This should be protected, no?- Overrides:
add
in classAbstractScmProvider
- Throws:
ScmException
-
getBranchCommand
-
branch
protected BranchScmResult branch(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
branch
in classAbstractScmProvider
- Throws:
ScmException
-
getChangeLogCommand
-
changelog
public ChangeLogScmResult changelog(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
changelog
in classAbstractScmProvider
- Throws:
ScmException
-
getCheckInCommand
-
checkin
public CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
checkin
in classAbstractScmProvider
- Throws:
ScmException
-
getCheckOutCommand
-
checkout
public CheckOutScmResult checkout(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
checkout
in classAbstractScmProvider
- Throws:
ScmException
-
getDiffCommand
-
diff
public DiffScmResult diff(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
diff
in classAbstractScmProvider
- Throws:
ScmException
-
getExportCommand
-
export
protected ExportScmResult export(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
export
in classAbstractScmProvider
- Throws:
ScmException
-
getRemoveCommand
-
remove
public RemoveScmResult remove(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
remove
in classAbstractScmProvider
- Throws:
ScmException
-
getStatusCommand
-
status
public StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
status
in classAbstractScmProvider
- Throws:
ScmException
-
getTagCommand
-
tag
public TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
tag
in classAbstractScmProvider
- Throws:
ScmException
-
getUntagCommand
-
untag
public UntagScmResult untag(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException Deletes a tag.- Specified by:
untag
in interfaceScmProvider
- Overrides:
untag
in classAbstractScmProvider
- Parameters:
repository
- the source control systemfileSet
- a fileset with the relevant working directory as basedirparameters
- TODO- Returns:
- TODO
- Throws:
ScmException
- if any
-
getUpdateCommand
-
update
public UpdateScmResult update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
update
in classAbstractScmProvider
- Throws:
ScmException
-
executeCommand
protected ScmResult executeCommand(SvnCommand command, ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Throws:
ScmException
-
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 classAbstractScmProvider
- Parameters:
repository
- the source control systemfileSet
- the files to listparameters
- TODO- Returns:
- The list of files in the repository
- Throws:
NoSuchCommandScmException
- unless overriden by subclassScmException
- if any
-
getInfoCommand
-
info
public InfoScmResult info(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Specified by:
info
in interfaceScmProvider
- Overrides:
info
in classAbstractScmProvider
- Parameters:
repository
- the source control systemfileSet
- location of your local copyparameters
- 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 classAbstractScmProvider
- Throws:
ScmException
-
getBlameCommand
-
mkdir
public MkdirScmResult mkdir(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException Create directory/directories in the repository.- Overrides:
mkdir
in classAbstractScmProvider
- Parameters:
repository
- TODOfileSet
- TODOparameters
- TODO- Returns:
- TODO
- Throws:
ScmException
- if any
-
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
-