IntegrityScmProvider (Maven SCM 1.10.0 API)

java.lang.Object
- org.apache.maven.scm.provider.AbstractScmProvider
- - org.apache.maven.scm.provider.integrity.IntegrityScmProvider

All Implemented Interfaces:

ScmProvider
```
public class IntegrityScmProvider
extends AbstractScmProvider
```
MKS Integrity SCM Provider for Maven

Since:

1.6

Version:

$Id: IntegrityScmProvider.java 1.7 2011/08/22 13:06:46EDT Cletus D'Souza (dsouza) Exp $

Author:

Cletus D'Souza

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

Field Summary

Fields
Modifier and Type Field and Description

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

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

Constructor Summary

Constructors
Constructor and Description

IntegrityScmProvider()

Constructors
Constructor and Description
`IntegrityScmProvider()`

Method Summary

Methods
Modifier and Type	Method and Description
`AddScmResult`	`add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si viewnonmembers and then si add for every non-member
`protected BlameScmResult`	`blame(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si annotate
`protected BranchScmResult`	`branch(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si createdevpath
`protected ChangeLogScmResult`	`changelog(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)` Maps to si rlog --rfilter=daterange:date1-date2
`protected CheckInScmResult`	`checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to a si ci
`protected CheckOutScmResult`	`checkout(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si createsandbox and/or si resync
`protected DiffScmResult`	`diff(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si diff
`protected EditScmResult`	`edit(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si makewritable
`protected ExportScmResult`	`export(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si projectco (no sandbox is used)
`protected ScmResult`	`fileinfo(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si memberinfo
`String`	`getScmType()` Returns the name of our SCM Provider
`protected ListScmResult`	`list(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si viewproject
`protected ScmResult`	`lock(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si lock
`protected LoginScmResult`	`login(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si connect and initialization of the project with si projectinfo
`ScmProviderRepository`	`makeProviderScmRepository(String scmSpecificUrl, char delimiter)` This class is the central point of the SCM provider.
`protected MkdirScmResult`	`mkdir(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si createsubproject
`protected RemoveScmResult`	`remove(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si dropsandbox
`protected StatusScmResult`	`status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si viewsandbox with a filter of locally changed files
`protected TagScmResult`	`tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si checkpoint
`protected UnEditScmResult`	`unedit(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si revert
`protected ScmResult`	`unlock(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si unlock
`protected UpdateScmResult`	`update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters params)` Maps to si resync

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, getScmSpecificFilename, info, list, list, makeProviderScmRepository, mkdir, remoteInfo, 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
- INTEGRITY_CM_URL
```
public static final String INTEGRITY_CM_URL
```
  See Also:
  Constant Field Values

Constructor Detail
- IntegrityScmProvider
```
public IntegrityScmProvider()
```

Method Detail

getScmType
```
public String getScmType()
```
Returns the name of our SCM Provider

makeProviderScmRepository
```
public ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl,
                                              char delimiter)
                                                throws ScmRepositoryException
```
This class is the central point of the SCM provider. The Maven-SCM framework will know only this class in the provider, so this class will validate the scm url, populate the IntegrityScmProviderRepository and provide all commands that we support.

Parameters:
scmSpecificUrl - The SCM URL specific to our implementation for this plugin
delimiter - The character that separates the information above

Throws:

ScmRepositoryException

login

protected LoginScmResult login(ScmProviderRepository repository,
                   ScmFileSet fileSet,
                   CommandParameters params)
                        throws ScmException

Maps to si connect and initialization of the project with si projectinfo

Overrides:: login in class AbstractScmProvider
Throws:: ScmException

changelog

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

Maps to si rlog --rfilter=daterange:date1-date2

Overrides:: changelog in class AbstractScmProvider
Throws:: ScmException

add

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

Maps to si viewnonmembers and then si add for every non-member

Overrides:: add in class AbstractScmProvider
Throws:: ScmException

remove

protected RemoveScmResult remove(ScmProviderRepository repository,
                     ScmFileSet fileSet,
                     CommandParameters params)
                          throws ScmException

Maps to si dropsandbox

Overrides:: remove in class AbstractScmProvider
Throws:: ScmException

checkin

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

Maps to a si ci

Overrides:: checkin in class AbstractScmProvider
Throws:: ScmException

checkout

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

Maps to si createsandbox and/or si resync

Overrides:: checkout in class AbstractScmProvider
Throws:: ScmException

diff

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

Maps to si diff

Overrides:: diff in class AbstractScmProvider
Throws:: ScmException

edit

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

Maps to si makewritable

Overrides:: edit in class AbstractScmProvider
Throws:: ScmException

status

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

Maps to si viewsandbox with a filter of locally changed files

Overrides:: status in class AbstractScmProvider
Throws:: ScmException

tag

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

Maps to si checkpoint

Overrides:: tag in class AbstractScmProvider
Throws:: ScmException

unedit

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

Maps to si revert

Overrides:: unedit in class AbstractScmProvider
Throws:: ScmException

update

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

Maps to si resync

Overrides:: update in class AbstractScmProvider
Throws:: ScmException

blame

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

Maps to si annotate

Overrides:: blame in class AbstractScmProvider
Throws:: ScmException

list
```
protected ListScmResult list(ScmProviderRepository repository,
                 ScmFileSet fileSet,
                 CommandParameters params)
                      throws ScmException
```
Maps to si viewproject

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

export

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

Maps to si projectco (no sandbox is used)

Overrides:: export in class AbstractScmProvider
Throws:: ScmException

branch

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

Maps to si createdevpath

Overrides:: branch in class AbstractScmProvider
Throws:: ScmException

mkdir

protected MkdirScmResult mkdir(ScmProviderRepository repository,
                   ScmFileSet fileSet,
                   CommandParameters params)
                        throws ScmException

Maps to si createsubproject

Overrides:: mkdir in class AbstractScmProvider
Returns:
Throws:: ScmException

fileinfo

protected ScmResult fileinfo(ScmProviderRepository repository,
                 ScmFileSet fileSet,
                 CommandParameters params)
                      throws ScmException

Maps to si memberinfo

Throws:: ScmException

lock

protected ScmResult lock(ScmProviderRepository repository,
             ScmFileSet fileSet,
             CommandParameters params)
                  throws ScmException

Maps to si lock

Throws:: ScmException

unlock

protected ScmResult unlock(ScmProviderRepository repository,
               ScmFileSet fileSet,
               CommandParameters params)
                    throws ScmException

Maps to si unlock

Throws:: ScmException

Class IntegrityScmProvider

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

INTEGRITY_CM_URL

Constructor Detail

IntegrityScmProvider