org.finra.herd.service.helper

Class EmrStepHelper

java.lang.Object

org.finra.herd.service.helper.EmrStepHelper

Direct Known Subclasses:

EmrHadoopJarStepHelper, EmrHiveStepHelper, EmrPigStepHelper, EmrShellStepHelper

public abstract class EmrStepHelper
extends Object

Base abstract class for EMR step helpers. All EMR step helpers will extend this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationHelper	configurationHelper
protected EmrHelper	emrHelper

Constructor Summary

Constructors

Constructor and Description
EmrStepHelper()

Method Summary

Modifier and Type	Method and Description
abstract Object	buildResponseFromRequest(Object stepRequest, String trustingAccountStagingBucketName) This method builds the Step object for the given Step request.
abstract com.amazonaws.services.elasticmapreduce.model.StepConfig	getEmrStepConfig(Object step) This method gets the StepConfig object for the given Step.
abstract String	getRequestAccountId(Object stepRequest) Gets Request accountId
abstract String	getRequestEmrClusterDefinitionName(Object stepRequest) Return the cluster definition name.
abstract String	getRequestEmrClusterId(Object stepRequest) Gets EMR cluster ID.
abstract String	getRequestEmrClusterName(Object stepRequest) Return the cluster name.
abstract String	getRequestNamespace(Object stepRequest) Return the namespace.
abstract String	getRequestStepName(Object stepRequest) Return the step name.
protected String	getS3ManagedReplaceString()
abstract String	getStepId(Object step) Return the step Id.
abstract String	getStepRequestType() Return the type of step request it supports, the name of the step request class.
abstract String	getStepType() Return the type of step it supports, the name of the step class.
abstract Boolean	isRequestContinueOnError(Object stepRequest) Return the continue on error.
abstract void	setRequestAccountId(Object stepRequest, String accountId) Sets Request accountID.
abstract void	setRequestContinueOnError(Object stepRequest, Boolean continueOnError) Sets the continue on error.
abstract void	setRequestEmrClusterDefinitionName(Object stepRequest, String clusterDefinitionName) Sets the cluster definition name.
abstract void	setRequestEmrClusterId(Object stepRequest, String emrClusterId) Sets EMR cluster ID.
abstract void	setRequestEmrClusterName(Object stepRequest, String clusterName) Sets the cluster name.
abstract void	setRequestNamespace(Object stepRequest, String namespace) Sets the namespace.
abstract void	setRequestStepName(Object stepRequest, String stepName) Sets the step name.
abstract void	setStepId(Object step, String stepId) Sets the step Id.
abstract void	validateAddStepRequest(Object step) Validates the step request.
protected void	validateScriptLocation(String scriptLocationString) Validates that script location is specified.
protected void	validateStepName(String stepName) Validates that Step name is specified.

Methods inherited from class java.lang.Object

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

Field Detail

configurationHelper

@Autowired
protected ConfigurationHelper configurationHelper

emrHelper

@Autowired
protected EmrHelper emrHelper

Constructor Detail

EmrStepHelper

public EmrStepHelper()

Method Detail

buildResponseFromRequest

public abstract Object buildResponseFromRequest(Object stepRequest,
                                                String trustingAccountStagingBucketName)

This method builds the Step object for the given Step request.

Parameters:

stepRequest - the step request object

trustingAccountStagingBucketName - the optional S3 staging bucket name to be used in the trusting account, maybe null or empty

Returns:

the step object

getEmrStepConfig

public abstract com.amazonaws.services.elasticmapreduce.model.StepConfig getEmrStepConfig(Object step)

This method gets the StepConfig object for the given Step.

Parameters:

step - the step object

Returns:

the step config object

getRequestEmrClusterDefinitionName

public abstract String getRequestEmrClusterDefinitionName(Object stepRequest)

Return the cluster definition name.

Parameters:

stepRequest - the Add Step request object.

Returns:

the cluster definition name.

getRequestEmrClusterId

public abstract String getRequestEmrClusterId(Object stepRequest)

Gets EMR cluster ID.

Parameters:

stepRequest - The step request

Returns:

The EMR cluster ID

getRequestEmrClusterName

public abstract String getRequestEmrClusterName(Object stepRequest)

Return the cluster name.

Parameters:

stepRequest - the Add Step request object.

Returns:

the cluster name.

getRequestNamespace

public abstract String getRequestNamespace(Object stepRequest)

Return the namespace.

Parameters:

stepRequest - the Add Step request object.

Returns:

the namespace.

getRequestStepName

public abstract String getRequestStepName(Object stepRequest)

Return the step name.

Parameters:

stepRequest - the Add Step request object.

Returns:

the step name.

getStepId

public abstract String getStepId(Object step)

Return the step Id.

Parameters:

step - the Step object.

Returns:

the Step Id.

getStepRequestType

public abstract String getStepRequestType()

Return the type of step request it supports, the name of the step request class.

Returns:

the Step request class name

getStepType

public abstract String getStepType()

Return the type of step it supports, the name of the step class.

Returns:

the Step class name

isRequestContinueOnError

public abstract Boolean isRequestContinueOnError(Object stepRequest)

Return the continue on error.

Parameters:

stepRequest - the Add Step request object.

Returns:

the continue on error.

setRequestContinueOnError

public abstract void setRequestContinueOnError(Object stepRequest,
                                               Boolean continueOnError)

Sets the continue on error.

Parameters:

stepRequest - the Add Step request object.

continueOnError - the continue on error value to set.

setRequestEmrClusterDefinitionName

public abstract void setRequestEmrClusterDefinitionName(Object stepRequest,
                                                        String clusterDefinitionName)

Sets the cluster definition name.

Parameters:

stepRequest - the Add Step request object.

clusterDefinitionName - the cluster definition name value to set.

setRequestEmrClusterId

public abstract void setRequestEmrClusterId(Object stepRequest,
                                            String emrClusterId)

Sets EMR cluster ID.

Parameters:

stepRequest - The step request

emrClusterId - The EMR cluster ID

setRequestEmrClusterName

public abstract void setRequestEmrClusterName(Object stepRequest,
                                              String clusterName)

Sets the cluster name.

Parameters:

stepRequest - the Add Step request object.

clusterName - the cluster name value to set.

setRequestNamespace

public abstract void setRequestNamespace(Object stepRequest,
                                         String namespace)

Sets the namespace.

Parameters:

stepRequest - the Add Step request object.

namespace - the namespace value to set.

setRequestStepName

public abstract void setRequestStepName(Object stepRequest,
                                        String stepName)

Sets the step name.

Parameters:

stepRequest - the Add Step request object.

stepName - the step name value to set.

setStepId

public abstract void setStepId(Object step,
                               String stepId)

Sets the step Id.

Parameters:

step - the Step object.

stepId - the step Id value to set.

validateAddStepRequest

public abstract void validateAddStepRequest(Object step)

Validates the step request.

Parameters:

step - request object

getS3ManagedReplaceString

protected String getS3ManagedReplaceString()

validateStepName

protected void validateStepName(String stepName)

Validates that Step name is specified.

Parameters:

stepName - the name of the step.

validateScriptLocation

protected void validateScriptLocation(String scriptLocationString)

Validates that script location is specified.

Parameters:

scriptLocationString - the script location.

getRequestAccountId

public abstract String getRequestAccountId(Object stepRequest)

Gets Request accountId

Parameters:

stepRequest - The step request

Returns:

The Request account Id

setRequestAccountId

public abstract void setRequestAccountId(Object stepRequest,
                                         String accountId)

Sets Request accountID.

Parameters:

stepRequest - The step request

accountId - The account ID