com.segue.scc.published.api.vcs

Interface SourceControlProfile

All Superinterfaces:

BrowseableProfile

All Known Subinterfaces:

VersionControlProfile

public interface SourceControlProfile
extends BrowseableProfile

SourceControlProfile is used to interact with an external source control system.
This interface specifies methods such as listing the source control system's content or getting the files from the source control system to a local directory.
SourceControlProfile is used to interact with an external source control system.

SourceControlProfile is non-versioned.

See Also:

VersionControlProfile

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_NAME The message key to localize the plugin name.

Fields inherited from interface com.segue.scc.published.api.vcs.BrowseableProfile

TYPE_FILE, TYPE_PROJECT, TYPE_RETRIEVE

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String filePath, java.io.File fileToAdd, java.lang.String comment) Adds a single file to the source control system.
void	addFiles(java.lang.String filePath, java.io.File dirToAdd, java.lang.String comment, boolean recursive) Adds multiple files to the source control system.
void	cleanupWorkingDirectory(java.lang.String path, java.io.File workdir) Some SourceControl Systems don't remove a file in the WorkingDirectory if it's removed on the server.
void	createWorkingDirectory(java.lang.String path, java.io.File workdir) Creates the local working directory and retrieves all files from the source control system within the specified path. Note: Some source control systems store information in the locally checked out projects.
void	get(java.lang.String filePath, java.lang.String targetPath, boolean recursive) Gets the latest version of a file or files in a path.
java.lang.String	getLastName(java.lang.String scpPath) Retrieves the last element of a source control system path.
java.lang.String	getName() The name of the SourceControl system.
java.lang.String	getParent(java.lang.String scpPath) Retrieves the parent directory of the given path name from the source control system.
PropertyProvider	getPropertyProvider()
SourceCodeControlInfo	getSourceCodeControlInfo()
StringResolver	getStringResolver() To provide a localized profile name, the property PLUGIN_NAME is resolved from the returned resolver.
void	removeWorkingDirectory(java.io.File workdir) Removes the locally checked out project.
void	updateRepository(java.lang.String pathToAdd, java.io.File sessionDir, boolean recursive, java.lang.String comment) Update the files locally stored in sessionDir to the source control profile.
default void	validateProfileSettings() Per default the system tries to list the content of the root folder with the provided settings.

Methods inherited from interface com.segue.scc.published.api.vcs.BrowseableProfile

addDirectory, buildPath, getRootPath, getSeparator, isValidProjectName, list

Field Detail

PLUGIN_NAME

static final java.lang.String PLUGIN_NAME

The message key to localize the plugin name.

See Also:

Constant Field Values

Method Detail

get

void get(java.lang.String filePath,
         java.lang.String targetPath,
         boolean recursive)
  throws SourceControlException

Gets the latest version of a file or files in a path.

Parameters:

filePath - file or path to get from the source control profile

targetPath - local path where the files will be stored

recursive - retrieve only the top-level folder files (false), or retrieve files recursively (true)

Throws:

SourceControlException

See Also:

createWorkingDirectory(String, java.io.File)

addFile

void addFile(java.lang.String filePath,
             java.io.File fileToAdd,
             java.lang.String comment)
      throws SourceControlException

Adds a single file to the source control system.

Parameters:

filePath - the path (project) in the source control system to which the file should be added

fileToAdd - the file to add to the source control system.

comment - a comment. A comment is only stored if the target source control system supports comments. Some source control systems require a comment, so it is mandatory to always specify a comment.

Throws:

SourceControlException

addFiles

void addFiles(java.lang.String filePath,
              java.io.File dirToAdd,
              java.lang.String comment,
              boolean recursive)
       throws SourceControlException

Adds multiple files to the source control system. If recursive is not set, only the files must be added. If recursive is set, all subdirectories and files have to be added.

Parameters:

filePath - the path (project) in the source control system to which the files should be added

dirToAdd - the local directory from which the files should be added to the source control system. All files of this directory will be added.

comment - a comment. A comment is only stored if the target source control system supports comments. Some source control systems require a comment, so it is mandatory to always specify a comment.

recursive - add only the top-level folder files (false), or add files recursively (true)

Throws:

SourceControlException

getParent

java.lang.String getParent(java.lang.String scpPath)

Retrieves the parent directory of the given path name from the source control system.

Parameters:

scpPath - the path (project) in the source control system

Returns:

parent directory of the given path (scpPath) in the source control system

getLastName

java.lang.String getLastName(java.lang.String scpPath)

Retrieves the last element of a source control system path.

Example:
getLastName("http://SVNServer/svn/regressions/trunk/doFoo/Performance/doFoo_Benchmark/doFoo_Benchmark_FileGet.csv");
Returns: doFoo_Benchmark_FileGet.csv

Parameters:

scpPath - the path (project) in the source control system for which the last element shall be retrieved

Returns:

the last element of the given path

createWorkingDirectory

void createWorkingDirectory(java.lang.String path,
                            java.io.File workdir)
                     throws SourceControlException

Creates the local working directory and retrieves all files from the source control system within the specified path.
Note: Some source control systems store information in the locally checked out projects.

Parameters:

path - the path (project) in the source control system from which the files should be retrieved

workdir - the local working directory to which the retrieved files should be stored

Throws:

SourceControlException

See Also:

removeWorkingDirectory(java.io.File)

removeWorkingDirectory

void removeWorkingDirectory(java.io.File workdir)
                     throws SourceControlException

Removes the locally checked out project. This action does not remove any files on the source control system.

Parameters:

workdir - the local working directory to delete

Throws:

SourceControlException

See Also:

createWorkingDirectory(String, java.io.File)

getPropertyProvider

PropertyProvider getPropertyProvider()

getStringResolver

StringResolver getStringResolver()

To provide a localized profile name, the property PLUGIN_NAME is resolved from the returned resolver.

Returns:

a StringResolver that is used to get UI strings for the properties from getPropertyProvider()

getName

java.lang.String getName()

The name of the SourceControl system. this name will be used to distinguish between the available source control implementations. This will also be displayed in the gui.

updateRepository

void updateRepository(java.lang.String pathToAdd,
                      java.io.File sessionDir,
                      boolean recursive,
                      java.lang.String comment)
               throws SourceControlException

Update the files locally stored in sessionDir to the source control profile. The difference to addFiles is, that some files in sessionDir already exist in the source control system.

Parameters:

pathToAdd -

sessionDir -

recursive -

comment -

Throws:

SourceControlException

getSourceCodeControlInfo

SourceCodeControlInfo getSourceCodeControlInfo()

cleanupWorkingDirectory

void cleanupWorkingDirectory(java.lang.String path,
                             java.io.File workdir)
                      throws SourceControlException

Some SourceControl Systems don't remove a file in the WorkingDirectory if it's removed on the server. This call should remove every file in the workdir, that does not exist on the server any more.

Parameters:

path -

workdir -

Throws:

SourceControlException

validateProfileSettings

default void validateProfileSettings()
                              throws SourceControlException

Per default the system tries to list the content of the root folder with the provided settings. Override this if there is a better way to validate the profile settings.

Throws:

SourceControlException - if the provided settings are not correct