org.jahia.services.templates

Class SvnSourceControlManagement

java.lang.Object

org.jahia.services.templates.SourceControlManagement

org.jahia.services.templates.SvnSourceControlManagement

public class SvnSourceControlManagement
extends SourceControlManagement

SVN based source control management service.

Nested Class Summary

Nested classes/interfaces inherited from class org.jahia.services.templates.SourceControlManagement

SourceControlManagement.ExecutionResult, SourceControlManagement.Status

Field Summary

Fields inherited from class org.jahia.services.templates.SourceControlManagement

executable, rootFolder

Constructor Summary

Constructors

Constructor and Description
SvnSourceControlManagement(String executable) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
void	add(List<File> files) Adds the specified files to be included into the next commit.
boolean	commit(String message) Performs a commit into the SCM.
protected Map<String,SourceControlManagement.Status>	createStatusMap()
Map<String,String>	getBranchInfos(String uri) List all available branches on distant repository
protected void	getFromSCM(File workingDirectory, String uri, String branchOrTag)
Map<String,String>	getTagInfos(String uri) List all available tags on distant repository
String	getURI() Returns an SCM URI.
protected void	initWithWorkingDirectory(File workingDirectory)
void	markConflictAsResolved(File file) Mark SCM conflict as resolved for the specified resource.
void	move(File src, File dst) Moves the specified resource to a new location.
void	remove(File file) Deletes the specified item from the working copy or repository.
protected void	sendToSCM(File workingDirectory, String uri)
String	update() Performs SCM update.

Methods inherited from class org.jahia.services.templates.SourceControlManagement

add, checkCommit, checkExecutionResult, executeCommand, getRootFolder, getStatus, getStatusMap, invalidateStatusCache, readLines

Methods inherited from class java.lang.Object

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

Constructor Detail

SvnSourceControlManagement

public SvnSourceControlManagement(String executable)

Initializes an instance of this class.

Parameters:

executable - the SVN executable

Method Detail

add

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

Description copied from class: SourceControlManagement

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

Specified by:

add in class SourceControlManagement

Parameters:

files - the list of files to be considered as modified

Throws:

IOException - in case of an SCM related error

commit

public boolean commit(String message)
               throws IOException

Description copied from class: SourceControlManagement

Performs a commit into the SCM.

Specified by:

commit in class SourceControlManagement

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 Map<String,SourceControlManagement.Status> createStatusMap()
                                                              throws IOException

Specified by:

createStatusMap in class SourceControlManagement

Throws:

IOException

getURI

public String getURI()
              throws IOException

Description copied from class: SourceControlManagement

Returns an SCM URI.

Specified by:

getURI in class SourceControlManagement

Returns:

an SCM URI

Throws:

IOException - in case of an SCM related error

getFromSCM

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

Specified by:

getFromSCM in class SourceControlManagement

Throws:

IOException

sendToSCM

protected void sendToSCM(File workingDirectory,
                         String uri)
                  throws IOException

Specified by:

sendToSCM in class SourceControlManagement

Throws:

IOException

initWithWorkingDirectory

protected void initWithWorkingDirectory(File workingDirectory)
                                 throws IOException

Specified by:

initWithWorkingDirectory in class SourceControlManagement

Throws:

IOException

markConflictAsResolved

public void markConflictAsResolved(File file)
                            throws IOException

Description copied from class: SourceControlManagement

Mark SCM conflict as resolved for the specified resource.

Specified by:

markConflictAsResolved in class SourceControlManagement

Parameters:

file - the resource to make as resolved

Throws:

IOException - in case of SCM errors

move

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

Description copied from class: SourceControlManagement

Moves the specified resource to a new location.

Specified by:

move in class SourceControlManagement

Parameters:

src - the source

dst - the destination

Throws:

IOException - in case of SCM errors

remove

public void remove(File file)
            throws IOException

Description copied from class: SourceControlManagement

Deletes the specified item from the working copy or repository.

Specified by:

remove in class SourceControlManagement

Parameters:

file - the resource to be removed

Throws:

IOException - in case of SCM errors

update

public String update()
              throws IOException

Description copied from class: SourceControlManagement

Performs SCM update.

Specified by:

update in class SourceControlManagement

Returns:

the output of the SCM update command if available

Throws:

IOException - in case of SCM errors

getTagInfos

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

Description copied from class: SourceControlManagement

List all available tags on distant repository

Specified by:

getTagInfos in class SourceControlManagement

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 Map<String,String> getBranchInfos(String uri)
                                  throws IOException

Description copied from class: SourceControlManagement

List all available branches on distant repository

Specified by:

getBranchInfos in class SourceControlManagement

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