org.jahia.services.templates

Class SourceControlManagement

java.lang.Object

org.jahia.services.templates.SourceControlManagement

Direct Known Subclasses:

GitSourceControlManagement, SvnSourceControlManagement

public abstract class SourceControlManagement
extends Object

Base service class for SCM related operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SourceControlManagement.ExecutionResult Represents the result of an external command execution.
static class	SourceControlManagement.Status The source control status of a resource.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	executable
protected File	rootFolder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SourceControlManagement(String executable)

Method Summary

Modifier and Type	Method and Description
void	add(File file) Adds the specified file to be included into the next commit.
abstract void	add(List<File> files) Adds the specified files to be included into the next commit.
boolean	checkCommit() Check if a commit is required
protected void	checkExecutionResult(SourceControlManagement.ExecutionResult result)
abstract boolean	commit(String message) Performs a commit into the SCM.
protected abstract Map<String,SourceControlManagement.Status>	createStatusMap()
protected SourceControlManagement.ExecutionResult	executeCommand(String command, String[] arguments)
abstract Map<String,String>	getBranchInfos(String uri) List all available branches on distant repository
protected abstract void	getFromSCM(File workingDirectory, String uri, String branchOrTag)
File	getRootFolder() Returns the root folder of the module.
SourceControlManagement.Status	getStatus(String path) Returns the SCM status of the specified resource.
protected Map<String,SourceControlManagement.Status>	getStatusMap()
abstract Map<String,String>	getTagInfos(String uri) List all available tags on distant repository
abstract String	getURI() Returns an SCM URI.
protected abstract void	initWithWorkingDirectory(File workingDirectory)
void	invalidateStatusCache() Invalidates the SCM status cache and forces for the next check the SCM interaction.
abstract void	markConflictAsResolved(File file) Mark SCM conflict as resolved for the specified resource.
abstract void	move(File src, File dst) Moves the specified resource to a new location.
protected static List<String>	readLines(String source)
abstract void	remove(File file) Deletes the specified item from the working copy or repository.
protected abstract void	sendToSCM(File workingDirectory, String url)
abstract String	update() Performs SCM update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

executable

protected String executable

rootFolder

protected File rootFolder

Constructor Detail

SourceControlManagement

protected SourceControlManagement(String executable)

Method Detail

readLines

protected static List<String> readLines(String source)
                                 throws IOException

Throws:

IOException

add

public final void add(File file)
               throws IOException

Adds the specified file to be included into the next commit.

Parameters:

file - a file to be considered as modified

Throws:

IOException - in case of an SCM related error

add

public abstract void add(List<File> files)
                  throws IOException

Adds the specified files to be included into the next commit.

Parameters:

files - the list of files to be considered as modified

Throws:

IOException - in case of an SCM related error

checkExecutionResult

protected void checkExecutionResult(SourceControlManagement.ExecutionResult result)
                             throws IOException

Throws:

IOException

checkCommit

public boolean checkCommit()
                    throws IOException

Check if a commit is required

Returns:

true if commit is required, false if no change

Throws:

IOException - if merge conflict is still there

commit

public abstract boolean commit(String message)
                        throws IOException

Performs a commit into the SCM.

Parameters:

message - the commit message

Returns:

true if the commit was effectively executed; false otherwise

Throws:

IOException - in case of a commit process error

createStatusMap

protected abstract Map<String,SourceControlManagement.Status> createStatusMap()
                                                                       throws IOException

Throws:

IOException

executeCommand

protected SourceControlManagement.ExecutionResult executeCommand(String command,
                                                                 String[] arguments)
                                                          throws IOException

Throws:

IOException

getRootFolder

public File getRootFolder()

Returns the root folder of the module.

Returns:

the root folder of the module

getStatus

public SourceControlManagement.Status getStatus(String path)
                                         throws IOException

Returns the SCM status of the specified resource.

Parameters:

path - the resource to check the SCM status for

Returns:

the SCM status of the specified resource

Throws:

IOException - in case of SCM errors

getStatusMap

protected final Map<String,SourceControlManagement.Status> getStatusMap()
                                                                 throws IOException

Throws:

IOException

getURI

public abstract String getURI()
                       throws IOException

Returns an SCM URI.

Returns:

an SCM URI

Throws:

IOException - in case of an SCM related error

getFromSCM

protected abstract void getFromSCM(File workingDirectory,
                                   String uri,
                                   String branchOrTag)
                            throws IOException

Throws:

IOException

sendToSCM

protected abstract void sendToSCM(File workingDirectory,
                                  String url)
                           throws IOException

Throws:

IOException

initWithWorkingDirectory

protected abstract void initWithWorkingDirectory(File workingDirectory)
                                          throws IOException

Throws:

IOException

invalidateStatusCache

public void invalidateStatusCache()

Invalidates the SCM status cache and forces for the next check the SCM interaction.

markConflictAsResolved

public abstract void markConflictAsResolved(File file)
                                     throws IOException

Mark SCM conflict as resolved for the specified resource.

Parameters:

file - the resource to make as resolved

Throws:

IOException - in case of SCM errors

move

public abstract void move(File src,
                          File dst)
                   throws IOException

Moves the specified resource to a new location.

Parameters:

src - the source

dst - the destination

Throws:

IOException - in case of SCM errors

remove

public abstract void remove(File file)
                     throws IOException

Deletes the specified item from the working copy or repository.

Parameters:

file - the resource to be removed

Throws:

IOException - in case of SCM errors

update

public abstract String update()
                       throws IOException

Performs SCM update.

Returns:

the output of the SCM update command if available

Throws:

IOException - in case of SCM errors

getTagInfos

public abstract Map<String,String> getTagInfos(String uri)
                                        throws IOException

List all available tags on distant repository

Parameters:

uri - the remote SCM repository URI (of the trunk for SVN)

Returns:

a map tag/uri

Throws:

IOException - in case of tag info retrieval errors

getBranchInfos

public abstract Map<String,String> getBranchInfos(String uri)
                                           throws IOException

List all available branches on distant repository

Parameters:

uri - the remote SCM repository URI (of the trunk for SVN)

Returns:

a map tag/uri

Throws:

IOException - in case of branch info retrieval errors