flexagon.fd.core.plugin

Class AbstractPartialDeployPluginProvider

java.lang.Object

flexagon.fd.core.plugin.AbstractPluginProvider

flexagon.fd.core.plugin.AbstractPartialDeployPluginProvider

All Implemented Interfaces:

PluginProvider

public abstract class AbstractPartialDeployPluginProvider
extends AbstractPluginProvider

Base class for partial deployment plugins.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MARKER
protected java.util.List<java.lang.String>	mFailedArtifacts
protected java.util.Map<java.lang.String,java.lang.String>	mFailedMessages

Constructor Summary

Constructors

Constructor and Description
AbstractPartialDeployPluginProvider()

Method Summary

Modifier and Type	Method and Description
protected void	_afterBuild()
protected void	_afterDeploy(PluginObjectResults pPluginObjectResults)
protected void	_beforeBuild()
protected void	_beforeDeploy(PluginObjectResults pPluginObjectResults)
PluginResult	execute() Must be implemented by the concrete subclass to perform the execution of the plugin operation.
protected abstract DeployStatusEnum	executeFile(PackageObject pPackageObject, java.io.File pFile) Subclass can implement processing of each individual package object.
protected void	extractArtifactZip()
protected void	generateArtifactZipFile(java.util.List<PackageObject> pPackageObjects) Subclass can implement how to create artifact zip file.
protected boolean	getStopOnError() Subclass can implement if they want to stop on error or not.
protected boolean	isBuild()
protected boolean	isDeploy()
protected void	markEnd()
protected void	markStart(java.lang.String pObjectPath)
protected boolean	shouldAttemptDeploy(PackageObject pPo)

Methods inherited from class flexagon.fd.core.plugin.AbstractPluginProvider

abortOnRequest, abortOnRequest, cleanup, getBooleanCurrentInstancePropertyValue, getBooleanCurrentInstancePropertyValueOrDefault, getBooleanInput, getBooleanInputOrDefault, getBooleanInstancePropertyValue, getBooleanInstancePropertyValueOrDefault, getBooleanProjectPropertyValue, getBooleanProjectPropertyValueOrDefault, getDoubleCurrentInstancePropertyValue, getDoubleCurrentInstancePropertyValueOrDefault, getDoubleInput, getDoubleInputOrDefault, getDoubleInstancePropertyValue, getDoubleInstancePropertyValueOrDefault, getDoubleProjectPropertyValue, getDoubleProjectPropertyValueOrDefault, getIntegerCurrentInstancePropertyValue, getIntegerCurrentInstancePropertyValueOrDefault, getIntegerInput, getIntegerInputOrDefault, getIntegerInstancePropertyValue, getIntegerInstancePropertyValueOrDefault, getIntegerProjectPropertyValue, getIntegerProjectPropertyValueOrDefault, getLongCurrentInstancePropertyValue, getLongCurrentInstancePropertyValueOrDefault, getLongInput, getLongInputOrDefault, getLongInstancePropertyValue, getLongInstancePropertyValueOrDefault, getLongProjectPropertyValue, getLongProjectPropertyValueOrDefault, getStringCurrentInstancePropertyValue, getStringCurrentInstancePropertyValueOrDefault, getStringInput, getStringInputOrDefault, getStringInstancePropertyValue, getStringInstancePropertyValueOrDefault, getStringProjectPropertyValue, getStringProjectPropertyValueOrDefault, getWorkflowExecutionContext, isExecutionAborting, setOutput, setWorkflowExecutionContext, validate, validateContext, validateContext, validateRequiredInputs, validateRequiredPropertiesForCurrentInstance, validateRequiredPropertiesForInstance

Methods inherited from class java.lang.Object

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

Field Detail

mFailedArtifacts

protected final java.util.List<java.lang.String> mFailedArtifacts

mFailedMessages

protected final java.util.Map<java.lang.String,java.lang.String> mFailedMessages

MARKER

public static final java.lang.String MARKER

See Also:

Constant Field Values

Constructor Detail

AbstractPartialDeployPluginProvider

public AbstractPartialDeployPluginProvider()

Method Detail

isBuild

protected boolean isBuild()

isDeploy

protected boolean isDeploy()

execute

public PluginResult execute()
                     throws FlexCheckedException

Description copied from class: AbstractPluginProvider

Must be implemented by the concrete subclass to perform the execution of the plugin operation.

Specified by:

execute in interface PluginProvider

Specified by:

execute in class AbstractPluginProvider

Returns:

the result of the plugin operation execution

Throws:

FlexCheckedException - if the plugin operation fails

_afterBuild

protected void _afterBuild()
                    throws FlexCheckedException

Throws:

FlexCheckedException

_beforeBuild

protected void _beforeBuild()
                     throws FlexCheckedException

Throws:

FlexCheckedException

_afterDeploy

protected void _afterDeploy(PluginObjectResults pPluginObjectResults)
                     throws FlexCheckedException

Throws:

FlexCheckedException

_beforeDeploy

protected void _beforeDeploy(PluginObjectResults pPluginObjectResults)
                      throws FlexCheckedException

Throws:

FlexCheckedException

shouldAttemptDeploy

protected boolean shouldAttemptDeploy(PackageObject pPo)

extractArtifactZip

protected void extractArtifactZip()
                           throws FlexCheckedException

Throws:

FlexCheckedException

markStart

protected void markStart(java.lang.String pObjectPath)

markEnd

protected void markEnd()

executeFile

protected abstract DeployStatusEnum executeFile(PackageObject pPackageObject,
                                                java.io.File pFile)
                                         throws FlexCheckedException

Subclass can implement processing of each individual package object. If exception is thrown then file is considered Failed. Otherwise, use returned status unless null.

Parameters:

pPackageObject -

pFile -

Returns:

Status of the package object. If null will decide based on if an exception was thrown or not.

Throws:

FlexCheckedException

generateArtifactZipFile

protected void generateArtifactZipFile(java.util.List<PackageObject> pPackageObjects)
                                throws FlexCheckedException

Subclass can implement how to create artifact zip file.

Parameters:

pPackageObjects -

Throws:

FlexCheckedException

getStopOnError

protected boolean getStopOnError()

Subclass can implement if they want to stop on error or not. If exception is thrown and this is true execution will stop. If false remaining files will continue to be executed. Always true if not overridden.

Returns:

Whether to stop on error or not.