flexagon.fd.core.plugin

Class AbstractPluginProvider

java.lang.Object

flexagon.fd.core.plugin.AbstractPluginProvider

All Implemented Interfaces:

PluginProvider

Direct Known Subclasses:

AbstractPartialDeployPluginProvider

public abstract class AbstractPluginProvider
extends java.lang.Object
implements PluginProvider

Abstract PluginProvider base class which provides a number of convenience methods for plugin operation implementations. Although plugin operation implementations may implement PluginProvider interface directly, it is strongly encouraged that they extend this base class instead if other inheritance is not required.

This class provides the following base implementation:

• Empty implementation for cleanup(), which can be overridden if necessary
• Methods for WorkflowExecutionContext validation (e.g. required inputs/properties)
• Methods for extracting properties/inputs from WorkflowExecutionContext by type
• Methods for extracting properties/inputs from WorkflowExecutionContext by type, and returning defaults if not found

Constructor Summary

Constructors

Constructor and Description
AbstractPluginProvider() INTERNAL USE ONLY

Method Summary

Modifier and Type	Method and Description
protected void	abortOnRequest() Aborts the current execution if an abort signal was received.
protected void	abortOnRequest(java.lang.String pMessage) Aborts the current execution if an abort signal was received.
void	cleanup() Can be overridden by the concrete subclass to perform an necessary cleanup of resources (e.g.
abstract PluginResult	execute() Must be implemented by the concrete subclass to perform the execution of the plugin operation.
protected java.lang.Boolean	getBooleanCurrentInstancePropertyValue(java.lang.String pKey) Returns the value of a environment instance property as a Boolean for the given property name within the current instance.
protected java.lang.Boolean	getBooleanCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Boolean pDefault) Returns the value of a environment instance property as a Boolean for the given property name within the current instance.
protected java.lang.Boolean	getBooleanInput(java.lang.String pInputName) Returns the value of the given input as a Boolean.
protected java.lang.Boolean	getBooleanInputOrDefault(java.lang.String pInputName, java.lang.Boolean pDefault) Returns the value of the given input as a Boolean.
protected java.lang.Boolean	getBooleanInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) Returns the value of a environment instance property as a Boolean for the given instance code and property name.
protected java.lang.Boolean	getBooleanInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Boolean pDefault) Returns the value of a environment instance property as a Boolean for the given instance code and property name.
protected java.lang.Boolean	getBooleanProjectPropertyValue(java.lang.String pKey) Returns the value of a project property as a Boolean for the given name.
protected java.lang.Boolean	getBooleanProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Boolean pDefault) Returns the value of a project property as a Boolean for the given name.
protected java.lang.Double	getDoubleCurrentInstancePropertyValue(java.lang.String pKey) Returns the value of a environment instance property as a Double for the given property name within the current instance.
protected java.lang.Double	getDoubleCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Double pDefault) Returns the value of a environment instance property as a Double for the given property name within the current instance.
protected java.lang.Double	getDoubleInput(java.lang.String pInputName) Returns the value of the given input as a Double.
protected java.lang.Double	getDoubleInputOrDefault(java.lang.String pInputName, java.lang.Double pDefault) Returns the value of the given input as a Double.
protected java.lang.Double	getDoubleInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) Returns the value of a environment instance property as a Double for the given instance code and property name.
protected java.lang.Double	getDoubleInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Double pDefault) Returns the value of a environment instance property as a Double for the given instance code and property name.
protected java.lang.Double	getDoubleProjectPropertyValue(java.lang.String pKey) Returns the value of a project property as a Double for the given name.
protected java.lang.Double	getDoubleProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Double pDefault) Returns the value of a project property as a Double for the given name.
protected java.lang.Integer	getIntegerCurrentInstancePropertyValue(java.lang.String pKey) Returns the value of a environment instance property as an Integer for the given property name within the current instance.
protected java.lang.Integer	getIntegerCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Integer pDefault) Returns the value of a environment instance property as an Integer for the given property name within the current instance.
protected java.lang.Integer	getIntegerInput(java.lang.String pInputName) Returns the value of the given input as an Integer.
protected java.lang.Integer	getIntegerInputOrDefault(java.lang.String pInputName, java.lang.Integer pDefault) Returns the value of the given input as an Integer.
protected java.lang.Integer	getIntegerInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) Returns the value of a environment instance property as an Integer for the given instance code and property name.
protected java.lang.Integer	getIntegerInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Integer pDefault) Returns the value of a environment instance property as an Integer for the given instance code and property name.
protected java.lang.Integer	getIntegerProjectPropertyValue(java.lang.String pKey) Returns the value of a project property as an Integer for the given name.
protected java.lang.Integer	getIntegerProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Integer pDefault) Returns the value of a project property as an Integer for the given name.
protected java.lang.Long	getLongCurrentInstancePropertyValue(java.lang.String pKey) Returns the value of a environment instance property as a Long for the given property name within the current instance.
protected java.lang.Long	getLongCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Long pDefault) Returns the value of a environment instance property as a Long for the given property name within the current instance.
protected java.lang.Long	getLongInput(java.lang.String pInputName) Returns the value of the given input as a Long.
protected java.lang.Long	getLongInputOrDefault(java.lang.String pInputName, java.lang.Long pDefault) Returns the value of the given input as a Long.
protected java.lang.Long	getLongInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) Returns the value of a environment instance property as a Long for the given instance code and property name.
protected java.lang.Long	getLongInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Long pDefault) Returns the value of a environment instance property as a Long for the given instance code and property name.
protected java.lang.Long	getLongProjectPropertyValue(java.lang.String pKey) Returns the value of a project property as a Long for the given name.
protected java.lang.Long	getLongProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Long pDefault) Returns the value of a project property as a Long for the given name.
protected java.lang.String	getStringCurrentInstancePropertyValue(java.lang.String pKey) Returns the value of a environment instance property as an String for the given property name within the current instance.
protected java.lang.String	getStringCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.String pDefault) Returns the value of a environment instance property as an String for the given property name within the current instance.
protected java.lang.String	getStringInput(java.lang.String pInputName) Returns the value of the given input as a String.
protected java.lang.String	getStringInputOrDefault(java.lang.String pInputName, java.lang.String pDefault) Returns the value of the given input as a String.
protected java.lang.String	getStringInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) Returns the value of a environment instance property as an Object for the given instance code and property name.
protected java.lang.String	getStringInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.String pDefault) Returns the value of a environment instance property as a String for the given instance code and property name.
protected java.lang.String	getStringProjectPropertyValue(java.lang.String pKey) Returns the value of a project property as a String for the given name.
protected java.lang.String	getStringProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.String pDefault) Returns the value of a project property as a String for the given name.
WorkflowExecutionContext	getWorkflowExecutionContext() Returns the WorkflowExecutionContext for the current plugin operation execution.
protected boolean	isExecutionAborting() Returns whether an abort signal was received for the current plugin execution.
protected void	setOutput(java.lang.String pName, java.lang.Object pValue, PropertyValue.PropertyTypeEnum pDataType) Sets an output into WorkflowExecutionContext, which will be returned within a PluginResult from the execute() method.
void	setWorkflowExecutionContext(WorkflowExecutionContext pExecutionContext) FOR INTERNAL USE AND TEST SETUP ONLY
abstract void	validate() Must be implemented by the concrete subclass to perform any validation (prior to execution).
protected void	validateContext(java.util.Collection<java.lang.String> pRequiredProperties, java.util.Collection<java.lang.String> pRequiredInputs) Validates that the given properties and inputs have non-null values within the WorkflowExecution context for the current execution instance.
protected void	validateContext(java.util.Collection<java.lang.String> pRequiredProperties, java.util.Collection<java.lang.String> pRequiredInputs, java.lang.String pValidateInstance) Validates that the given properties and inputs have non-null values within the WorkflowExecution context for the given execution instance.
protected void	validateRequiredInputs(java.util.Collection<java.lang.String> pRequiredInputs) Validates that the given inputs have non-null values within the WorkflowExecution context for the current execution instance.
protected void	validateRequiredPropertiesForCurrentInstance(java.util.Collection<java.lang.String> pRequiredProperties) Validates that the given properties have non-null values within the WorkflowExecution context for the current execution instance.
protected void	validateRequiredPropertiesForInstance(java.util.Collection<java.lang.String> pRequiredProperties, java.lang.String pValidateInstance) Validates that the given properties have non-null values within the WorkflowExecution context for the given execution instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPluginProvider

public AbstractPluginProvider()

INTERNAL USE ONLY

Method Detail

setWorkflowExecutionContext

public void setWorkflowExecutionContext(WorkflowExecutionContext pExecutionContext)

FOR INTERNAL USE AND TEST SETUP ONLY

Specified by:

setWorkflowExecutionContext in interface PluginProvider

Parameters:

pExecutionContext - the workflow execution context

getWorkflowExecutionContext

public WorkflowExecutionContext getWorkflowExecutionContext()

Returns the WorkflowExecutionContext for the current plugin operation execution.

Returns:

the execution context object

execute

public abstract PluginResult execute()
                              throws FlexCheckedException

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

Specified by:

execute in interface PluginProvider

Returns:

the result of the plugin operation execution

Throws:

FlexCheckedException - if the plugin operation fails

validate

public abstract void validate()
                       throws FlexCheckedException

Must be implemented by the concrete subclass to perform any validation (prior to execution).

Specified by:

validate in interface PluginProvider

Throws:

FlexCheckedException - if the WorkflowExecutionContext provides configuration which is not valid for this plugin operation execution

cleanup

public void cleanup()

Can be overridden by the concrete subclass to perform an necessary cleanup of resources (e.g. closing/deleting files, closing connections, etc.). The default implementation does nothing.

Specified by:

cleanup in interface PluginProvider

validateContext

protected void validateContext(java.util.Collection<java.lang.String> pRequiredProperties,
                               java.util.Collection<java.lang.String> pRequiredInputs)
                        throws FlexCheckedException

Validates that the given properties and inputs have non-null values within the WorkflowExecution context for the current execution instance.

Parameters:

pRequiredProperties - a collection of required properties

pRequiredInputs - a collection of required inputs

Throws:

FlexCheckedException - if any or all of the properties/inputs are invalid

validateContext

protected void validateContext(java.util.Collection<java.lang.String> pRequiredProperties,
                               java.util.Collection<java.lang.String> pRequiredInputs,
                               java.lang.String pValidateInstance)
                        throws FlexCheckedException

Validates that the given properties and inputs have non-null values within the WorkflowExecution context for the given execution instance.

Parameters:

pRequiredProperties - a collection of required properties

pRequiredInputs - a collection of required inputs

pValidateInstance - the instance used to locate properties

Throws:

FlexCheckedException - if any or all of the properties/inputs are invalid

validateRequiredInputs

protected void validateRequiredInputs(java.util.Collection<java.lang.String> pRequiredInputs)
                               throws FlexCheckedException

Validates that the given inputs have non-null values within the WorkflowExecution context for the current execution instance.

Parameters:

pRequiredInputs - a collection of required inputs

Throws:

FlexCheckedException - if any or all of the inputs are invalid

validateRequiredPropertiesForInstance

protected void validateRequiredPropertiesForInstance(java.util.Collection<java.lang.String> pRequiredProperties,
                                                     java.lang.String pValidateInstance)
                                              throws FlexCheckedException

Validates that the given properties have non-null values within the WorkflowExecution context for the given execution instance.

Parameters:

pRequiredProperties - a collection of required properties

pValidateInstance - the instance used to locate properties

Throws:

FlexCheckedException - if any or all of the properties are invalid

validateRequiredPropertiesForCurrentInstance

protected void validateRequiredPropertiesForCurrentInstance(java.util.Collection<java.lang.String> pRequiredProperties)
                                                     throws FlexCheckedException

Validates that the given properties have non-null values within the WorkflowExecution context for the current execution instance.

Parameters:

pRequiredProperties - a collection of required properties

Throws:

FlexCheckedException - if any or all of the properties are invalid

setOutput

protected void setOutput(java.lang.String pName,
                         java.lang.Object pValue,
                         PropertyValue.PropertyTypeEnum pDataType)

Sets an output into WorkflowExecutionContext, which will be returned within a PluginResult from the execute() method.

Parameters:

pName - the name of the output to set

pValue - the value of the output (must be of type pDataType)

pDataType - the data type of the property

getBooleanInput

protected java.lang.Boolean getBooleanInput(java.lang.String pInputName)

Returns the value of the given input as a Boolean. Returns Boolean.FALSE if value for pInputName is null or cannot be resolved to a boolean value.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the Boolean value of the input

getBooleanInputOrDefault

protected java.lang.Boolean getBooleanInputOrDefault(java.lang.String pInputName,
                                                     java.lang.Boolean pDefault)

Returns the value of the given input as a Boolean. Returns pDefault if input is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the Boolean value of the input

getDoubleInput

protected java.lang.Double getDoubleInput(java.lang.String pInputName)

Returns the value of the given input as a Double. Returns null if pInputName is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the Double value of the input

getDoubleInputOrDefault

protected java.lang.Double getDoubleInputOrDefault(java.lang.String pInputName,
                                                   java.lang.Double pDefault)

Returns the value of the given input as a Double. Returns pDefault if input is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the Double value of the input

getStringInput

protected java.lang.String getStringInput(java.lang.String pInputName)

Returns the value of the given input as a String. Returns null if pInputName is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the String value of the input

getStringInputOrDefault

protected java.lang.String getStringInputOrDefault(java.lang.String pInputName,
                                                   java.lang.String pDefault)

Returns the value of the given input as a String. Returns pDefault if input is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the String value of the input

getIntegerInput

protected java.lang.Integer getIntegerInput(java.lang.String pInputName)

Returns the value of the given input as an Integer. Returns null if pInputName is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the Integer value of the input

getIntegerInputOrDefault

protected java.lang.Integer getIntegerInputOrDefault(java.lang.String pInputName,
                                                     java.lang.Integer pDefault)

Returns the value of the given input as an Integer. Returns pDefault if input is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the Integer value of the input

getLongInput

protected java.lang.Long getLongInput(java.lang.String pInputName)

Returns the value of the given input as a Long. Returns null if pInputName is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the Long value of the input

getLongInputOrDefault

protected java.lang.Long getLongInputOrDefault(java.lang.String pInputName,
                                               java.lang.Long pDefault)

Returns the value of the given input as a Long. Returns pDefault if input is not found.

Parameters:

pInputName - the name of the input to retrieve

Returns:

the Long value of the input

getStringProjectPropertyValue

protected java.lang.String getStringProjectPropertyValue(java.lang.String pKey)

Returns the value of a project property as a String for the given name. Returns null if pKey is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as a String

getStringProjectPropertyValueOrDefault

protected java.lang.String getStringProjectPropertyValueOrDefault(java.lang.String pKey,
                                                                  java.lang.String pDefault)

Returns the value of a project property as a String for the given name. Returns pDefault if property is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as a String

getStringInstancePropertyValue

protected java.lang.String getStringInstancePropertyValue(java.lang.String pInstanceCode,
                                                          java.lang.String pKey)

Returns the value of a environment instance property as an Object for the given instance code and property name. Returns null if pKey is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as an Object

getStringInstancePropertyValueOrDefault

protected java.lang.String getStringInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                                   java.lang.String pKey,
                                                                   java.lang.String pDefault)

Returns the value of a environment instance property as a String for the given instance code and property name. Returns pDefault if property is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as an String

getStringCurrentInstancePropertyValue

protected java.lang.String getStringCurrentInstancePropertyValue(java.lang.String pKey)

Returns the value of a environment instance property as an String for the given property name within the current instance. Returns null if pKey is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a String

getStringCurrentInstancePropertyValueOrDefault

protected java.lang.String getStringCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                          java.lang.String pDefault)

Returns the value of a environment instance property as an String for the given property name within the current instance. Returns pDefault if property is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as an String

getDoubleProjectPropertyValue

protected java.lang.Double getDoubleProjectPropertyValue(java.lang.String pKey)

Returns the value of a project property as a Double for the given name. Returns null if pKey is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as a Double

getDoubleProjectPropertyValueOrDefault

protected java.lang.Double getDoubleProjectPropertyValueOrDefault(java.lang.String pKey,
                                                                  java.lang.Double pDefault)

Returns the value of a project property as a Double for the given name. Returns pDefault if property is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as a Double

getDoubleInstancePropertyValue

protected java.lang.Double getDoubleInstancePropertyValue(java.lang.String pInstanceCode,
                                                          java.lang.String pKey)

Returns the value of a environment instance property as a Double for the given instance code and property name. Returns null if pKey is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Double

getDoubleInstancePropertyValueOrDefault

protected java.lang.Double getDoubleInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                                   java.lang.String pKey,
                                                                   java.lang.Double pDefault)

Returns the value of a environment instance property as a Double for the given instance code and property name. Returns pDefault if property is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Double

getDoubleCurrentInstancePropertyValue

protected java.lang.Double getDoubleCurrentInstancePropertyValue(java.lang.String pKey)

Returns the value of a environment instance property as a Double for the given property name within the current instance. Returns null if pKey is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Double

getDoubleCurrentInstancePropertyValueOrDefault

protected java.lang.Double getDoubleCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                          java.lang.Double pDefault)

Returns the value of a environment instance property as a Double for the given property name within the current instance. Returns pDefault if property is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Double

getIntegerProjectPropertyValue

protected java.lang.Integer getIntegerProjectPropertyValue(java.lang.String pKey)

Returns the value of a project property as an Integer for the given name. Returns null if pKey is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as an Integer

getIntegerProjectPropertyValueOrDefault

protected java.lang.Integer getIntegerProjectPropertyValueOrDefault(java.lang.String pKey,
                                                                    java.lang.Integer pDefault)

Returns the value of a project property as an Integer for the given name. Returns pDefault if property is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as an Integer

getIntegerInstancePropertyValue

protected java.lang.Integer getIntegerInstancePropertyValue(java.lang.String pInstanceCode,
                                                            java.lang.String pKey)

Returns the value of a environment instance property as an Integer for the given instance code and property name. Returns null if pKey is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as an Integer

getIntegerInstancePropertyValueOrDefault

protected java.lang.Integer getIntegerInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                                     java.lang.String pKey,
                                                                     java.lang.Integer pDefault)

Returns the value of a environment instance property as an Integer for the given instance code and property name. Returns pDefault if property is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as an Integer

getIntegerCurrentInstancePropertyValue

protected java.lang.Integer getIntegerCurrentInstancePropertyValue(java.lang.String pKey)

Returns the value of a environment instance property as an Integer for the given property name within the current instance. Returns null if pKey is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as an Integer

getIntegerCurrentInstancePropertyValueOrDefault

protected java.lang.Integer getIntegerCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                            java.lang.Integer pDefault)

Returns the value of a environment instance property as an Integer for the given property name within the current instance. Returns pDefault if property is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as an Integer

getBooleanProjectPropertyValue

protected java.lang.Boolean getBooleanProjectPropertyValue(java.lang.String pKey)

Returns the value of a project property as a Boolean for the given name. Returns null if pKey is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as a Boolean

getBooleanProjectPropertyValueOrDefault

protected java.lang.Boolean getBooleanProjectPropertyValueOrDefault(java.lang.String pKey,
                                                                    java.lang.Boolean pDefault)

Returns the value of a project property as a Boolean for the given name. Returns pDefault if property is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as a Boolean

getBooleanInstancePropertyValue

protected java.lang.Boolean getBooleanInstancePropertyValue(java.lang.String pInstanceCode,
                                                            java.lang.String pKey)

Returns the value of a environment instance property as a Boolean for the given instance code and property name. Returns null if pKey is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Boolean

getBooleanInstancePropertyValueOrDefault

protected java.lang.Boolean getBooleanInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                                     java.lang.String pKey,
                                                                     java.lang.Boolean pDefault)

Returns the value of a environment instance property as a Boolean for the given instance code and property name. Returns pDefault if property is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Boolean

getBooleanCurrentInstancePropertyValue

protected java.lang.Boolean getBooleanCurrentInstancePropertyValue(java.lang.String pKey)

Returns the value of a environment instance property as a Boolean for the given property name within the current instance. Returns null if pKey is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Boolean

getBooleanCurrentInstancePropertyValueOrDefault

protected java.lang.Boolean getBooleanCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                            java.lang.Boolean pDefault)

Returns the value of a environment instance property as a Boolean for the given property name within the current instance. Returns pDefault if property is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Boolean

getLongProjectPropertyValue

protected java.lang.Long getLongProjectPropertyValue(java.lang.String pKey)

Returns the value of a project property as a Long for the given name. Returns null if pKey is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as a Long

getLongProjectPropertyValueOrDefault

protected java.lang.Long getLongProjectPropertyValueOrDefault(java.lang.String pKey,
                                                              java.lang.Long pDefault)

Returns the value of a project property as a Long for the given name. Returns pDefault if property is not found.

Parameters:

pKey - the name of the project property

Returns:

the project property value as a Long

getLongInstancePropertyValue

protected java.lang.Long getLongInstancePropertyValue(java.lang.String pInstanceCode,
                                                      java.lang.String pKey)

Returns the value of a environment instance property as a Long for the given instance code and property name. Returns null if pKey is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Long

getLongInstancePropertyValueOrDefault

protected java.lang.Long getLongInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                               java.lang.String pKey,
                                                               java.lang.Long pDefault)

Returns the value of a environment instance property as a Long for the given instance code and property name. Returns pDefault if property is not found within the given instance code.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Long

getLongCurrentInstancePropertyValue

protected java.lang.Long getLongCurrentInstancePropertyValue(java.lang.String pKey)

Returns the value of a environment instance property as a Long for the given property name within the current instance. Returns null if pKey is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Long

getLongCurrentInstancePropertyValueOrDefault

protected java.lang.Long getLongCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                      java.lang.Long pDefault)

Returns the value of a environment instance property as a Long for the given property name within the current instance. Returns pDefault if property is not found within the current instance.

Parameters:

pKey - the name of the environment instance property

Returns:

the environment instance property value as a Long

isExecutionAborting

protected boolean isExecutionAborting()

Returns whether an abort signal was received for the current plugin execution.

Returns:

true if an abort signal was received, false otherwise

abortOnRequest

protected void abortOnRequest()
                       throws FlexAbortPluginException

Aborts the current execution if an abort signal was received.

Throws:

FlexAbortPluginException - if an abort signal was received

abortOnRequest

protected void abortOnRequest(java.lang.String pMessage)
                       throws FlexAbortPluginException

Aborts the current execution if an abort signal was received.

Parameters:

pMessage - the message to log with the exception which is thrown

Throws:

FlexAbortPluginException - if an abort signal was received