aviadlevy.jenkins.plugin.giphy

Class GiphyStepExecution<T,S extends GiphyStep>

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<T>

aviadlevy.jenkins.plugin.giphy.GiphyStepExecution<T,S>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GiphyRandomStepExecution, GiphySearchStepExecution, GiphyTranslateStepExecution

public abstract class GiphyStepExecution<T,S extends GiphyStep>
extends org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<T>

Author:

aviadlevy

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_IMAGE_SIZE
protected S	step

Constructor Summary

Constructors

Constructor and Description
GiphyStepExecution(S giphyStep, org.jenkinsci.plugins.workflow.steps.StepContext context) Constructor for StepExecution

Method Summary

Modifier and Type	Method and Description
protected String	getGiphyHost() We can now override it in the tests and test the api calls to giphy without actually calling giphy each time
protected abstract URI	getGiphyUri(String apiKey) build the giphy uri
protected String	getScheme() We can now override it in the tests and test the api calls to giphy without actually calling giphy each time TODO: make mockServer work with https and then remove this method
protected abstract T	handleGiphyResponse(S step, org.json.simple.JSONObject json) method that responsible to what should we do with the response from giphy
protected T	run() Meat of the execution.
protected abstract void	validateSpecificStepValues() validate the required values for the specific step implementation exists, and set default value to optional in case they don't exists
protected void	validateValues() validate the required values exists, and set default value to optional in case they don't exists

Methods inherited from class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution

getStatus, onResume, start, stop

Methods inherited from class org.jenkinsci.plugins.workflow.steps.StepExecution

applyAll, applyAll, getContext, getStatusBounded

Methods inherited from class java.lang.Object

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

Field Detail

step

protected final S extends GiphyStep step

DEFAULT_IMAGE_SIZE

protected static final String DEFAULT_IMAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

GiphyStepExecution

public GiphyStepExecution(S giphyStep,
                          org.jenkinsci.plugins.workflow.steps.StepContext context)

Constructor for StepExecution

Parameters:

giphyStep - the step running

context - step context

Method Detail

run

protected T run()
         throws Exception

Meat of the execution. When this method returns, a step execution is over.

Specified by:

run in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<T>

Throws:

Exception

validateValues

protected void validateValues()

validate the required values exists, and set default value to optional in case they don't exists

validateSpecificStepValues

protected abstract void validateSpecificStepValues()

validate the required values for the specific step implementation exists, and set default value to optional in case they don't exists

getGiphyUri

protected abstract URI getGiphyUri(String apiKey)
                            throws URISyntaxException

build the giphy uri

Parameters:

apiKey - the apikey to giphy

Returns:

the uri to execute

Throws:

URISyntaxException - in case the uri is not valid

handleGiphyResponse

protected abstract T handleGiphyResponse(S step,
                                         org.json.simple.JSONObject json)

method that responsible to what should we do with the response from giphy

Parameters:

step - the step with all the values from the user

json - the response from giphy with JSON format

Returns:

the return value of the execution

getScheme

protected String getScheme()

We can now override it in the tests and test the api calls to giphy without actually calling giphy each time TODO: make mockServer work with https and then remove this method

Returns:

the scheme we want to call

getGiphyHost

protected String getGiphyHost()

We can now override it in the tests and test the api calls to giphy without actually calling giphy each time

Returns:

the host we want to call