Package org.craftercms.deployer.api
Interface DeploymentProcessor
-
- All Superinterfaces:
InitializableByConfigBean
- All Known Implementing Classes:
AbstractDeploymentProcessor
,AbstractMainDeploymentProcessor
,AbstractPostDeploymentProcessor
,AbstractRemoteGitRepoAwareProcessor
,AbstractS3Processor
,AbstractSearchIndexingProcessor
,CloudFrontInvalidationProcessor
,CommandLineProcessor
,DelayProcessor
,ElasticsearchIndexingProcessor
,FileBasedDeploymentEventProcessor
,FileOutputProcessor
,FindAndReplaceProcessor
,GitDiffProcessor
,GitPullProcessor
,GitPushProcessor
,GitUpdateCommitIdProcessor
,HttpMethodCallProcessor
,MailNotificationProcessor
,S3DeploymentEventsProcessor
,S3SyncProcessor
,ScriptProcessor
public interface DeploymentProcessor extends InitializableByConfigBean
Represents a single deployment processor.- Author:
- avasquez
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
destroy()
Destroys the processor, closing and releasing any used resources.void
execute(Deployment deployment)
Executes the processorboolean
isPostDeployment()
Returns true if this processor runs after the deployment has finalized.boolean
supportsMode(Deployment.Mode mode)
Indicates if the processor should be included in the given deployment mode-
Methods inherited from interface org.craftercms.deployer.utils.beans.InitializableByConfigBean
init
-
-
-
-
Method Detail
-
isPostDeployment
boolean isPostDeployment()
Returns true if this processor runs after the deployment has finalized.
-
destroy
void destroy() throws DeployerException
Destroys the processor, closing and releasing any used resources.- Throws:
DeployerException
- if an error occurs
-
execute
void execute(Deployment deployment)
Executes the processor- Parameters:
deployment
- the current deployment info
-
supportsMode
boolean supportsMode(Deployment.Mode mode)
Indicates if the processor should be included in the given deployment mode- Parameters:
mode
- the deployment mode to check- Returns:
- true if the processor should be included
-
-