JazzScmProvider (Maven SCM 1.10.0 API)

java.lang.Object
- org.apache.maven.scm.provider.AbstractScmProvider
- - org.apache.maven.scm.provider.jazz.JazzScmProvider

All Implemented Interfaces:

ScmProvider
```
public class JazzScmProvider
extends AbstractScmProvider
```
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

Author:

Chris Graham

Plexus component:
role:
"org.apache.maven.scm.provider.ScmProvider"
role-hint:
"jazz"

Field Summary

Fields
Modifier and Type Field and Description

static String JAZZ_URL_FORMAT
- Fields inherited from interface org.apache.maven.scm.provider.ScmProvider
  ROLE

Fields
Modifier and Type	Field and Description
`static String`	`JAZZ_URL_FORMAT`

Constructor Summary

Constructors
Constructor and Description

JazzScmProvider()

Constructors
Constructor and Description
`JazzScmProvider()`

Method Summary

Methods
Modifier and Type	Method and Description
`AddScmResult`	`add(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)`
`String`	`getScmSpecificFilename()` Returns the scm reserved file name where the SCM stores information like 'CVS', '.svn'.
`String`	`getScmType()`
`protected ListScmResult`	`list(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)` List each element (files and directories) of fileSet as they exist in the repository.
`ScmProviderRepository`	`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, update, update, update, update, update, update, update, update, update, update, update, update, validateScmUrl, validateTagName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- JAZZ_URL_FORMAT
```
public static final String JAZZ_URL_FORMAT
```
  See Also:
  Constant Field Values

Constructor Detail
- JazzScmProvider
```
public JazzScmProvider()
```

Method Detail

getScmType
```
public String 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 class AbstractScmProvider
Throws:: ScmException

branch

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

Overrides:: branch in class AbstractScmProvider
Throws:: ScmException

blame

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

Overrides:: blame in class AbstractScmProvider
Throws:: ScmException

changelog

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

Overrides:: changelog in class AbstractScmProvider
Throws:: ScmException

checkin

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

Overrides:: checkin in class AbstractScmProvider
Throws:: ScmException

checkout

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

Overrides:: checkout in class AbstractScmProvider
Throws:: ScmException

diff

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

Overrides:: diff in class AbstractScmProvider
Throws:: ScmException

edit

protected EditScmResult edit(ScmProviderRepository repository,
                 ScmFileSet fileSet,
                 CommandParameters parameters)
                      throws ScmException

Overrides:: edit in class AbstractScmProvider
Throws:: ScmException

export

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

Overrides:: export in class AbstractScmProvider
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 class AbstractScmProvider

Parameters:
repository - the source control system
fileSet - the files to list

Returns:
The list of files in the repository

Throws:

NoSuchCommandScmException - unless overriden by subclass

ScmException - if any

status

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

Overrides:: status in class AbstractScmProvider
Throws:: ScmException

tag

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

Overrides:: tag in class AbstractScmProvider
Throws:: ScmException

update

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

Overrides:: update in class AbstractScmProvider
Throws:: ScmException

unedit

protected UnEditScmResult unedit(ScmProviderRepository repository,
                     ScmFileSet fileSet,
                     CommandParameters parameters)
                          throws ScmException

Overrides:: unedit in class AbstractScmProvider
Throws:: ScmException

getScmSpecificFilename
```
public String getScmSpecificFilename()
```
Returns the scm reserved file name where the SCM stores information like 'CVS', '.svn'.

Specified by:

getScmSpecificFilename in interface ScmProvider

Overrides:

getScmSpecificFilename in class AbstractScmProvider

Returns:
the scm reserved file name

Class JazzScmProvider

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

JAZZ_URL_FORMAT

Constructor Detail

JazzScmProvider

Method Detail

getScmType

makeProviderScmRepository

add

branch

blame

changelog

checkin

checkout

diff

edit

export

list

status

tag

update

unedit

getScmSpecificFilename