org.apache.maven.scm.provider
Interface ScmProvider

All Known Implementing Classes:

AbstractScmProvider

public interface ScmProvider

Version:

$Id: ScmProvider.java 351634 2005-12-02 08:24:24Z evenisse $

Author:

Emmanuel Venisse

Field Summary

static java.lang.String

ROLE

Method Summary

AddScmResult	add(ScmRepository repository, ScmFileSet fileSet) Adds the given files to the source control system
void	addListener(ScmLogger logger)
ChangeLogScmResult	changeLog(ScmRepository repository, ScmFileSet fileSet, java.util.Date startDate, java.util.Date endDate, int numDays, java.lang.String branch) Returns the changes that have happend in the source control system in a certain period of time.
CheckInScmResult	checkIn(ScmRepository repository, ScmFileSet fileSet, java.lang.String tag, java.lang.String message) Save the changes you have done into the repository.
CheckOutScmResult	checkOut(ScmRepository repository, ScmFileSet fileSet, java.lang.String tag) Create a copy of the repository on your local machine
DiffScmResult	diff(ScmRepository repository, ScmFileSet fileSet, java.lang.String startRevision, java.lang.String endRevision)
EditScmResult	edit(ScmRepository repository, ScmFileSet fileSet) Make a file editable.
java.lang.String	getScmType()
ScmProviderRepository	makeProviderScmRepository(java.io.File path)
ScmProviderRepository	makeProviderScmRepository(java.lang.String scmSpecificUrl, char delimiter)
RemoveScmResult	remove(ScmRepository repository, ScmFileSet fileSet, java.lang.String message) Removes the given files from the source control system
boolean	requiresEditMode()
StatusScmResult	status(ScmRepository repository, ScmFileSet fileSet) Returns the status of the files in the source control system.
TagScmResult	tag(ScmRepository repository, ScmFileSet fileSet, java.lang.String tag) Tag (or label in some systems) will tag the source file with a certain tag
UnEditScmResult	unedit(ScmRepository repository, ScmFileSet fileSet) Make a file no longer editable.
UpdateScmResult	update(ScmRepository repository, ScmFileSet fileSet, java.lang.String tag) Updates the copy on the local machine with the changes in the repository
UpdateScmResult	update(ScmRepository repository, ScmFileSet fileSet, java.lang.String tag, java.util.Date lastUpdate) Updates the copy on the local machine with the changes in the repository
java.util.List	validateScmUrl(java.lang.String scmSpecificUrl, char delimiter)

Field Detail

ROLE

static final java.lang.String ROLE

Method Detail

getScmType

java.lang.String getScmType()

addListener

void addListener(ScmLogger logger)

requiresEditMode

boolean requiresEditMode()

makeProviderScmRepository

ScmProviderRepository makeProviderScmRepository(java.lang.String scmSpecificUrl,
                                                char delimiter)
                                                throws ScmRepositoryException

Throws:

ScmRepositoryException

makeProviderScmRepository

ScmProviderRepository makeProviderScmRepository(java.io.File path)
                                                throws ScmRepositoryException,
                                                       UnknownRepositoryStructure

Throws:

ScmRepositoryException

UnknownRepositoryStructure

validateScmUrl

java.util.List validateScmUrl(java.lang.String scmSpecificUrl,
                              char delimiter)

add

AddScmResult add(ScmRepository repository,
                 ScmFileSet fileSet)
                 throws ScmException

Adds the given files to the source control system

Parameters:

repository - the source control system

fileSet - the files to be added

Returns:

an AddScmResult that contains the files that have been added

Throws:

ScmException

changeLog

ChangeLogScmResult changeLog(ScmRepository repository,
                             ScmFileSet fileSet,
                             java.util.Date startDate,
                             java.util.Date endDate,
                             int numDays,
                             java.lang.String branch)
                             throws ScmException

Returns the changes that have happend in the source control system in a certain period of time. This can be adding, removing, updating, ... of files

Parameters:

repository - the source control system

fileSet - the files to know the changes about. Implementations can also give the changes from the ScmFileSet.getBasedir() downwards.

startDate - the start date of the period

endDate - the end date of the period

numDays -

branch -

Returns:

Throws:

ScmException

checkIn

CheckInScmResult checkIn(ScmRepository repository,
                         ScmFileSet fileSet,
                         java.lang.String tag,
                         java.lang.String message)
                         throws ScmException

Save the changes you have done into the repository. This will create a new version of the file or directory in the repository.

Parameters:

repository - the source control system

fileSet - the files to check in (sometimes called commit)

tag -

message - a string that is a comment on the changes that where done

Returns:

Throws:

ScmException

checkOut

CheckOutScmResult checkOut(ScmRepository repository,
                           ScmFileSet fileSet,
                           java.lang.String tag)
                           throws ScmException

Create a copy of the repository on your local machine

Parameters:

repository - the source control system

fileSet - the files are copied to the ScmFileSet.getBasedir() location

tag - get the version defined by the tag

Returns:

Throws:

ScmException

diff

DiffScmResult diff(ScmRepository repository,
                   ScmFileSet fileSet,
                   java.lang.String startRevision,
                   java.lang.String endRevision)
                   throws ScmException

Throws:

ScmException

remove

RemoveScmResult remove(ScmRepository repository,
                       ScmFileSet fileSet,
                       java.lang.String message)
                       throws ScmException

Removes the given files from the source control system

Parameters:

repository - the source control system

fileSet - the files to be removed

message -

Returns:

Throws:

ScmException

status

StatusScmResult status(ScmRepository repository,
                       ScmFileSet fileSet)
                       throws ScmException

Returns the status of the files in the source control system. The state of each file can be one of the ScmFileStatus flags.

Parameters:

repository - the source control system

fileSet - the files to know the status about. Implementations can also give the changes from the ScmFileSet.getBasedir() downwards.

Returns:

Throws:

ScmException

tag

TagScmResult tag(ScmRepository repository,
                 ScmFileSet fileSet,
                 java.lang.String tag)
                 throws ScmException

Tag (or label in some systems) will tag the source file with a certain tag

Parameters:

repository - the source control system

fileSet - the files to tag. Implementations can also give the changes from the ScmFileSet.getBasedir() downwards.

tag - the tag to apply to the files

Returns:

Throws:

ScmException

update

UpdateScmResult update(ScmRepository repository,
                       ScmFileSet fileSet,
                       java.lang.String tag)
                       throws ScmException

Updates the copy on the local machine with the changes in the repository

Parameters:

repository - the source control system

fileSet - location of your local copy

tag - use the version defined by the tag

Returns:

Throws:

ScmException

update

UpdateScmResult update(ScmRepository repository,
                       ScmFileSet fileSet,
                       java.lang.String tag,
                       java.util.Date lastUpdate)
                       throws ScmException

Updates the copy on the local machine with the changes in the repository

Parameters:

repository - the source control system

fileSet - location of your local copy

tag - use the version defined by the tag

lastUpdate -

Returns:

Throws:

ScmException

edit

EditScmResult edit(ScmRepository repository,
                   ScmFileSet fileSet)
                   throws ScmException

Make a file editable. This is used in source control systems where you look at read-only files and you need to make them not read-only anymore before you can edit them. This can also mean that no other user in the system can make the file not read-only anymore.

Parameters:

repository - the source control system

fileSet - the files to make editable

Returns:

Throws:

ScmException

unedit

UnEditScmResult unedit(ScmRepository repository,
                       ScmFileSet fileSet)
                       throws ScmException

Make a file no longer editable. This is the conterpart of edit(org.apache.maven.scm.repository.ScmRepository, org.apache.maven.scm.ScmFileSet). It makes the file read-only again.

Parameters:

repository - the source control system

fileSet - the files to make uneditable

Returns:

Throws:

ScmException