org.jahia.services.templates

Class SourceControlHelper

java.lang.Object

org.jahia.services.templates.SourceControlHelper

public class SourceControlHelper
extends Object

Utility class for SCM related module operations.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
SourceControlHelper()

Method Summary

Modifier and Type	Method and Description
JCRNodeWrapper	checkoutModule(File moduleSources, String scmURI, String branchOrTag, String moduleId, String version, JCRSessionWrapper session)
File	checkoutTmpModule(String moduleId, String version, String scmURI, String branchOrTag)
boolean	checkValidSources(JahiaTemplatesPackage pack, File sources)
SourceControlFactory	getSourceControlFactory()
File	getSources(JahiaTemplatesPackage pack, JCRSessionWrapper session)
String	guessBranchOrTag(String moduleVersion, String scm, Set<String> branchOrTags)
Map<String,String>	listBranches(String scmURI)
Map<String,String>	listTags(String scmURI)
void	sendToSourceControl(String moduleId, String scmURI, String scmType, JCRSessionWrapper session)
void	setSourceControlFactory(SourceControlFactory sourceControlFactory)
void	setSourcesFolderInPackage(JahiaTemplatesPackage pack, File sources)
void	setSourcesFolderInPackageAndNode(JahiaTemplatesPackage pack, File sources, JCRNodeWrapper node)
void	setTemplatePackageRegistry(TemplatePackageRegistry registry)

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceControlHelper

public SourceControlHelper()

Method Detail

checkoutModule

public JCRNodeWrapper checkoutModule(File moduleSources,
                                     String scmURI,
                                     String branchOrTag,
                                     String moduleId,
                                     String version,
                                     JCRSessionWrapper session)
                              throws IOException,
                                     javax.jcr.RepositoryException,
                                     org.osgi.framework.BundleException

Throws:

IOException

javax.jcr.RepositoryException

org.osgi.framework.BundleException

checkoutTmpModule

public File checkoutTmpModule(String moduleId,
                              String version,
                              String scmURI,
                              String branchOrTag)
                       throws IOException,
                              org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                              org.dom4j.DocumentException,
                              javax.jcr.RepositoryException

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

org.dom4j.DocumentException

javax.jcr.RepositoryException

checkValidSources

public boolean checkValidSources(JahiaTemplatesPackage pack,
                                 File sources)

getSourceControlFactory

public SourceControlFactory getSourceControlFactory()

getSources

public File getSources(JahiaTemplatesPackage pack,
                       JCRSessionWrapper session)
                throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

sendToSourceControl

public void sendToSourceControl(String moduleId,
                                String scmURI,
                                String scmType,
                                JCRSessionWrapper session)
                         throws javax.jcr.RepositoryException,
                                IOException

Throws:

javax.jcr.RepositoryException

IOException

listTags

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

Throws:

IOException

listBranches

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

Throws:

IOException

guessBranchOrTag

public String guessBranchOrTag(String moduleVersion,
                               String scm,
                               Set<String> branchOrTags)

setSourceControlFactory

public void setSourceControlFactory(SourceControlFactory sourceControlFactory)

setSourcesFolderInPackage

public void setSourcesFolderInPackage(JahiaTemplatesPackage pack,
                                      File sources)

setSourcesFolderInPackageAndNode

public void setSourcesFolderInPackageAndNode(JahiaTemplatesPackage pack,
                                             File sources,
                                             JCRNodeWrapper node)
                                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

setTemplatePackageRegistry

public void setTemplatePackageRegistry(TemplatePackageRegistry registry)