org.jahia.services.templates

Class SourceControlFactory

java.lang.Object

org.jahia.services.templates.SourceControlFactory

public class SourceControlFactory
extends Object

Source control management central factory class responsible for checking out a remote SCM repository content and instantiating SourceControlManagement helpers for SCM operations on module's sources.

Constructor Summary

Constructors

Constructor and Description
SourceControlFactory()

Method Summary

Modifier and Type	Method and Description
SourceControlManagement	checkoutRepository(File workingDir, String scmURI, String branchOrTag, boolean initRepository) Performs checkout of the remote SCM content into the provided working directory.
List<String>	getIgnoredFiles()
Map<String,String>	getSourceControlExecutables() Returns a registry of executables (paths to the SCM executables) by SCM type.
SourceControlManagement	getSourceControlManagement(File workingDir) Returns an instance of the SourceControlManagement helper for the specified working directory.
Set<String>	getSupportedSourceControls() Returns a set of supported SCM types.
Map<String,String>	listBranches(String scmURI) List all available branches on distant repository
Map<String,String>	listTags(String scmURI) List all available tags on distant repository
void	setIgnoredFiles(List<String> ignoredFiles)
void	setSourceControlExecutables(Map<String,String> sourceControlExecutables) Sets the executables for various SCM providers.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceControlFactory

public SourceControlFactory()

Method Detail

getIgnoredFiles

public List<String> getIgnoredFiles()

setIgnoredFiles

public void setIgnoredFiles(List<String> ignoredFiles)

checkoutRepository

public SourceControlManagement checkoutRepository(File workingDir,
                                                  String scmURI,
                                                  String branchOrTag,
                                                  boolean initRepository)
                                           throws IOException

Performs checkout of the remote SCM content into the provided working directory.

Parameters:

workingDir - working directory to perform checkout into

scmURI - the remote SCM repository URL

branchOrTag - the name of the remote branch or tag if any

Returns:

an instance of the SourceControlManagement helper for the checked out content

Throws:

IOException - in case of communication errors

listTags

public Map<String,String> listTags(String scmURI)
                            throws IOException

List all available tags on distant repository

Parameters:

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

Returns:

a map tag/uri

Throws:

IOException

listBranches

public Map<String,String> listBranches(String scmURI)
                                throws IOException

List all available branches on distant repository

Parameters:

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

Returns:

a map tag/uri

Throws:

IOException

getSourceControlExecutables

public Map<String,String> getSourceControlExecutables()

Returns a registry of executables (paths to the SCM executables) by SCM type.

Returns:

a registry of executables (paths to the SCM executables) by SCM type

getSourceControlManagement

public SourceControlManagement getSourceControlManagement(File workingDir)
                                                   throws IOException

Returns an instance of the SourceControlManagement helper for the specified working directory.

Parameters:

workingDir - the working directory to get SCM helper for

Returns:

an instance of the SourceControlManagement helper for the specified working directory

Throws:

IOException - in case of I/O errors

getSupportedSourceControls

public Set<String> getSupportedSourceControls()

Returns a set of supported SCM types.

Returns:

a set of supported SCM types

setSourceControlExecutables

public void setSourceControlExecutables(Map<String,String> sourceControlExecutables)

Sets the executables for various SCM providers.

Parameters:

sourceControlExecutables - a map with paths to SCM executables by SCM type