Class AbstractCvsScmProvider
java.lang.Object
org.apache.maven.scm.provider.AbstractScmProvider
org.apache.maven.scm.provider.cvslib.AbstractCvsScmProvider
- All Implemented Interfaces:
ScmProvider
- Direct Known Subclasses:
CvsExeScmProvider
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
The current ScmUrlParserResult -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
ext transport methodstatic final String
local transport methodstatic final String
lserver transport methodstatic final String
pserver transport methodstatic final String
sspi transport methodFields inherited from interface org.apache.maven.scm.provider.ScmProvider
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadd
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected BlameScmResult
blame
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) 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) private ScmResult
executeCommand
(Command command, ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected ExportScmResult
export
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) private static ScmFileSet
fixUpScmFileSetAbsoluteFilePath
(ScmFileSet currentFileSet) CVS provider requires that all files in ScmFileSet must be relative to basedir This function ensures and converts all absolute paths to relative pathsprivate static File
getAbsoluteFilePath
(File fileOrDir) protected abstract Command
protected abstract Command
protected abstract Command
protected abstract Command
protected abstract Command
protected abstract Command
protected abstract Command
protected abstract Command
protected abstract Command
protected abstract Command
protected abstract Command
static String
getRelativePath
(File basedir, File f) protected abstract Command
Returns the scm reserved file name where the SCM stores information like 'CVS', '.svn'.protected abstract Command
protected abstract Command
protected abstract Command
protected ListScmResult
list
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) List each element (files and directories) of fileSet as they exist in the repository.login
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) makeProviderScmRepository
(String scmSpecificUrl, char delimiter) protected MkdirScmResult
mkdir
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) Create directory/directories in the repository.parseScmUrl
(String scmSpecificUrl, char delimiter) remove
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) sanitizeTagName
(String arg0) Given a tag name, make it suitable for this SCM provider.status
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) tag
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected TagScmResult
tag
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters, ScmTagParameters scmParameters) update
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) validateScmUrl
(String scmSpecificUrl, char delimiter) Validate the scm url.boolean
validateTagName
(String arg0) Check if this tag is valid for this SCM provider.Methods inherited from class org.apache.maven.scm.provider.AbstractScmProvider
add, add, add, addListener, 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, getLogger, info, list, list, mkdir, remoteInfo, remove, requiresEditMode, status, tag, tag, tag, unedit, unedit, untag, update, update, update, update, update, update, update, update, update, update, update, update
-
Field Details
-
TRANSPORT_EXT
ext transport method- See Also:
-
TRANSPORT_LOCAL
local transport method- See Also:
-
TRANSPORT_LSERVER
lserver transport method- See Also:
-
TRANSPORT_PSERVER
pserver transport method- See Also:
-
TRANSPORT_SSPI
sspi transport method- See Also:
-
-
Constructor Details
-
AbstractCvsScmProvider
public AbstractCvsScmProvider()
-
-
Method Details
-
getScmSpecificFilename
Returns the scm reserved file name where the SCM stores information like 'CVS', '.svn'.- Specified by:
getScmSpecificFilename
in interfaceScmProvider
- Overrides:
getScmSpecificFilename
in classAbstractScmProvider
- Returns:
- the scm reserved file name
-
sanitizeTagName
Given a tag name, make it suitable for this SCM provider. For example, CVS converts "." into "_"- Specified by:
sanitizeTagName
in interfaceScmProvider
- Overrides:
sanitizeTagName
in classAbstractScmProvider
- Parameters:
arg0
- input tag name- Returns:
- sanitized tag name
-
validateTagName
Check if this tag is valid for this SCM provider.- Specified by:
validateTagName
in interfaceScmProvider
- Overrides:
validateTagName
in classAbstractScmProvider
- Parameters:
arg0
- tag name to check- Returns:
- true if tag is valid
-
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
-
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
-
add
public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
add
in classAbstractScmProvider
- Throws:
ScmException
-
branch
public BranchScmResult branch(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
branch
in classAbstractScmProvider
- Throws:
ScmException
-
blame
protected BlameScmResult blame(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
blame
in classAbstractScmProvider
- Throws:
ScmException
-
changelog
public ChangeLogScmResult changelog(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
changelog
in classAbstractScmProvider
- Throws:
ScmException
-
checkin
public CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
checkin
in classAbstractScmProvider
- Throws:
ScmException
-
checkout
public CheckOutScmResult checkout(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
checkout
in classAbstractScmProvider
- Throws:
ScmException
-
diff
public DiffScmResult diff(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
diff
in classAbstractScmProvider
- Throws:
ScmException
-
export
protected ExportScmResult export(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
export
in classAbstractScmProvider
- Throws:
ScmException
-
login
public LoginScmResult login(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
login
in classAbstractScmProvider
- Throws:
ScmException
-
remove
public RemoveScmResult remove(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
remove
in classAbstractScmProvider
- Throws:
ScmException
-
status
public StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
status
in classAbstractScmProvider
- Throws:
ScmException
-
tag
public TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
tag
in classAbstractScmProvider
- Throws:
ScmException
-
tag
protected TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters, ScmTagParameters scmParameters) throws ScmException - Throws:
ScmException
-
update
public UpdateScmResult update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
update
in classAbstractScmProvider
- Throws:
ScmException
-
list
protected 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 list- Returns:
- The list of files in the repository
- Throws:
NoSuchCommandScmException
- unless overriden by subclassScmException
- if any
-
mkdir
protected MkdirScmResult mkdir(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException Create directory/directories in the repository.- Overrides:
mkdir
in classAbstractScmProvider
- Returns:
- Throws:
ScmException
-
getRelativePath
- Parameters:
basedir
- not nullf
- not null- Returns:
- the relative path
- Throws:
ScmException
- if anyIOException
- if any
-
parseScmUrl
protected AbstractCvsScmProvider.ScmUrlParserResult parseScmUrl(String scmSpecificUrl, char delimiter) -
getAddCommand
-
getBranchCommand
-
getBlameCommand
-
getChangeLogCommand
-
getCheckInCommand
-
getCheckOutCommand
-
getDiffCommand
-
getExportCommand
-
getListCommand
-
getLoginCommand
-
getRemoveCommand
-
getStatusCommand
-
getTagCommand
-
getUpdateCommand
-
getMkdirCommand
-
executeCommand
private ScmResult executeCommand(Command command, ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Throws:
ScmException
-
fixUpScmFileSetAbsoluteFilePath
private static ScmFileSet fixUpScmFileSetAbsoluteFilePath(ScmFileSet currentFileSet) throws ScmException CVS provider requires that all files in ScmFileSet must be relative to basedir This function ensures and converts all absolute paths to relative paths- Parameters:
currentFileSet
-- Returns:
- Throws:
ScmException
-
getAbsoluteFilePath
- Throws:
IOException
-