Class JazzScmProvider
java.lang.Object
org.apache.maven.scm.provider.AbstractScmProvider
org.apache.maven.scm.provider.jazz.JazzScmProvider
- All Implemented Interfaces:
ScmProvider
The maven scm provider for Jazz.
This provider is a wrapper for the command line tool, "scm.sh" or "scm.exe" is that is
part of the Jazz SCM Server.
This provider does not use a native API to communicate with the Jazz SCM server.
The scm tool itself is documented at:
V2.0.0 - http://publib.boulder.ibm.com/infocenter/rtc/v2r0m0/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html
V3.0 - http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html
V3.0.1 -
http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0m1/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html
-
Field Summary
FieldsFields 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) protected BranchScmResult
branch
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected ChangeLogScmResult
changelog
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected CheckInScmResult
checkin
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected CheckOutScmResult
checkout
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected DiffScmResult
diff
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected EditScmResult
edit
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected ExportScmResult
export
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) Returns the scm reserved file name where the SCM stores information like 'CVS', '.svn'.protected ListScmResult
list
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) List each element (files and directories) of fileSet as they exist in the repository.makeProviderScmRepository
(String scmUrl, char delimiter) This method parses the scm URL and returns a SCM provider repository.protected StatusScmResult
status
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected TagScmResult
tag
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected UnEditScmResult
unedit
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) protected UpdateScmResult
update
(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) 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, export, export, export, export, export, getLogger, info, list, list, login, makeProviderScmRepository, mkdir, mkdir, remoteInfo, remove, remove, requiresEditMode, sanitizeTagName, status, tag, tag, tag, unedit, untag, update, update, update, update, update, update, update, update, update, update, update, update, validateScmUrl, validateTagName
-
Field Details
-
JAZZ_URL_FORMAT
- See Also:
-
-
Constructor Details
-
JazzScmProvider
public JazzScmProvider()
-
-
Method Details
-
getScmType
-
makeProviderScmRepository
public ScmProviderRepository makeProviderScmRepository(String scmUrl, char delimiter) throws ScmRepositoryException This method parses the scm URL and returns a SCM provider repository. At this point, the scmUrl is the part after scm:provider_name: in your SCM URL. The basic url parsing approach is to be as loose as possible. If you specify as per the docs you'll get what you expect. If you do something else the result is undefined. Don't use "/" "\" or "@" as the delimiter. Parse the scmUrl, which will be of the form: [username[;password]@]http[s]://server_name[:port]/contextRoot:repositoryWorkspace eg: Deb;Deb@https://rtc:9444/jazz:BogusRepositoryWorkspace- Throws:
ScmRepositoryException
-
add
public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
add
in classAbstractScmProvider
- Throws:
ScmException
-
branch
protected 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
protected ChangeLogScmResult changelog(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
changelog
in classAbstractScmProvider
- Throws:
ScmException
-
checkin
protected CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
checkin
in classAbstractScmProvider
- Throws:
ScmException
-
checkout
protected CheckOutScmResult checkout(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
checkout
in classAbstractScmProvider
- Throws:
ScmException
-
diff
protected DiffScmResult diff(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
diff
in classAbstractScmProvider
- Throws:
ScmException
-
edit
protected EditScmResult edit(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
edit
in classAbstractScmProvider
- Throws:
ScmException
-
export
protected ExportScmResult export(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
export
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 listparameters
-- Returns:
- The list of files in the repository
- Throws:
ScmException
- if any
-
status
protected StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
status
in classAbstractScmProvider
- Throws:
ScmException
-
tag
protected TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
tag
in classAbstractScmProvider
- Throws:
ScmException
-
update
protected UpdateScmResult update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
update
in classAbstractScmProvider
- Throws:
ScmException
-
unedit
protected UnEditScmResult unedit(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException - Overrides:
unedit
in classAbstractScmProvider
- Throws:
ScmException
-
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
-