org.craftercms.deployer.api.events

Interface DeploymentEventsStore<T,S>

Type Parameters:

T - The type to hold the events

S - The type to store the events

All Known Implementing Classes:

FileBasedDeploymentEventsStore

public interface DeploymentEventsStore<T,S>

Stores the deployment events for a target.

Since:

3.1.8

Author:

joseross

Method Summary

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

Method Detail

loadDeploymentEvents

T loadDeploymentEvents(Target target)
                throws DeployerException

Loads the deployment events for the given target.

Parameters:

target - the target

Returns:

the existing deployment events

Throws:

DeployerException - if there is any error loading the deployment events

saveDeploymentEvents

void saveDeploymentEvents(Target target,
                          T deploymentEvents)
                   throws DeployerException

Saves the deployment events for the given target.

Parameters:

target - the target

deploymentEvents - the new deployment events

Throws:

DeployerException - if there is any error saving the deployment events

getSource

S getSource(Target target)

Provides access to the underlaying storage object

Parameters:

target - the target

Returns:

the storage object