Package org.craftercms.deployer.impl.events

Class FileBasedDeploymentEventsStore

java.lang.Object

org.craftercms.deployer.impl.events.FileBasedDeploymentEventsStore

All Implemented Interfaces:

DeploymentEventsStore<Properties,Path>, org.springframework.beans.factory.InitializingBean

public class FileBasedDeploymentEventsStore
extends Object
implements DeploymentEventsStore<Properties,Path>, org.springframework.beans.factory.InitializingBean

Implementation of DeploymentEventsStore that uses a file to store the events.

Since:

3.1.8

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	filePattern	The pattern used to generate the name of the files
protected String	folderPath	The folder where all files are stored locally

Constructor Summary

Constructors

Constructor	Description
FileBasedDeploymentEventsStore(String folderPath, String filePattern)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected Path	getPath(Target target)
Path	getSource(Target target)	Provides access to the underlaying storage object
Properties	loadDeploymentEvents(Target target)	Loads the deployment events for the given target.
void	saveDeploymentEvents(Target target, Properties deploymentEvents)	Saves the deployment events for the given target.

Methods inherited from class java.lang.Object

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

Field Details

folderPath

protected String folderPath

The folder where all files are stored locally

filePattern

protected String filePattern

The pattern used to generate the name of the files

Constructor Details

FileBasedDeploymentEventsStore

public FileBasedDeploymentEventsStore(String folderPath,
 String filePattern)

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getPath

protected Path getPath(Target target)

loadDeploymentEvents

public Properties loadDeploymentEvents(Target target)
                                throws DeployerException

Description copied from interface: DeploymentEventsStore

Loads the deployment events for the given target.

Specified by:

loadDeploymentEvents in interface DeploymentEventsStore<Properties,Path>

Parameters:

target - the target

Returns:

the existing deployment events

Throws:

DeployerException - if there is any error loading the deployment events

saveDeploymentEvents

public void saveDeploymentEvents(Target target,
 Properties deploymentEvents)
                          throws DeployerException

Description copied from interface: DeploymentEventsStore

Saves the deployment events for the given target.

Specified by:

saveDeploymentEvents in interface DeploymentEventsStore<Properties,Path>

Parameters:

target - the target

deploymentEvents - the new deployment events

Throws:

DeployerException - if there is any error saving the deployment events

getSource

public Path getSource(Target target)

Description copied from interface: DeploymentEventsStore

Provides access to the underlaying storage object

Specified by:

getSource in interface DeploymentEventsStore<Properties,Path>

Parameters:

target - the target

Returns:

the storage object