org.jahia.tools.patches

Class Patcher

java.lang.Object

org.jahia.tools.patches.Patcher

All Implemented Interfaces:

JahiaAfterInitializationService, org.springframework.beans.factory.DisposableBean

public final class Patcher
extends Object
implements JahiaAfterInitializationService, org.springframework.beans.factory.DisposableBean

Simple patch service that monitors specified folder (by default WEB-INF/var/patches/) for scripts, executes them and renames the executed files.

Author:

Sergiy Shyrkov

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEEP
static String	README
static String	REMOVE
static Comparator<org.springframework.core.io.Resource>	RESOURCE_COMPARATOR
static String	SUFFIX_FAILED
static String	SUFFIX_INSTALLED
static String	SUFFIX_SKIPPED

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	executeScripts(Collection<org.springframework.core.io.Resource> scripts, String lifecyclePhase) Execute scripts in the specified lifecycle phase
void	executeScripts(Collection<org.springframework.core.io.Resource> scripts, String lifecyclePhase, BiConsumer<org.springframework.core.io.Resource,String> afterExecution) Execute scripts in the specified lifecycle phase, use a callback after execution
void	executeScripts(String lifecyclePhase) Execute scripts for the given lifecycle phase
static Patcher	getInstance()
org.jahia.commons.Version	getJahiaPreviousVersion()
String	getPatchesLookup()
void	initAfterAllServicesAreStarted()
void	setInterval(long interval)
void	setPatchers(List<PatchExecutor> patchers)
void	setPatchesLookup(String patchesLookup)
void	setServletContext(javax.servlet.ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Field Detail

README

public static final String README

See Also:

Constant Field Values

SUFFIX_INSTALLED

public static final String SUFFIX_INSTALLED

See Also:

Constant Field Values

SUFFIX_FAILED

public static final String SUFFIX_FAILED

See Also:

Constant Field Values

SUFFIX_SKIPPED

public static final String SUFFIX_SKIPPED

See Also:

Constant Field Values

KEEP

public static final String KEEP

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

RESOURCE_COMPARATOR

public static final Comparator<org.springframework.core.io.Resource> RESOURCE_COMPARATOR

Method Detail

getInstance

public static Patcher getInstance()

executeScripts

public void executeScripts(String lifecyclePhase)

Execute scripts for the given lifecycle phase

Parameters:

lifecyclePhase - the lifecycle phase

executeScripts

public void executeScripts(Collection<org.springframework.core.io.Resource> scripts,
                           String lifecyclePhase)

Execute scripts in the specified lifecycle phase

Parameters:

scripts - scripts

lifecyclePhase - lifecyclePhase

executeScripts

public void executeScripts(Collection<org.springframework.core.io.Resource> scripts,
                           String lifecyclePhase,
                           BiConsumer<org.springframework.core.io.Resource,String> afterExecution)

Execute scripts in the specified lifecycle phase, use a callback after execution

Parameters:

scripts - scripts

lifecyclePhase - lifecyclePhase

afterExecution - afterExecution callback

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

initAfterAllServicesAreStarted

public void initAfterAllServicesAreStarted()
                                    throws JahiaInitializationException

Specified by:

initAfterAllServicesAreStarted in interface JahiaAfterInitializationService

Throws:

JahiaInitializationException

setInterval

public void setInterval(long interval)

getPatchesLookup

public String getPatchesLookup()

setPatchesLookup

public void setPatchesLookup(String patchesLookup)

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

setPatchers

public void setPatchers(List<PatchExecutor> patchers)

getJahiaPreviousVersion

public org.jahia.commons.Version getJahiaPreviousVersion()