aviadlevy.jenkins.plugin.giphy.search

Class GiphySearchStepExecution<T>

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

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

aviadlevy.jenkins.plugin.giphy.search.GiphySearchStepExecution<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GiphySearchRandomByKeywordStepExecution, GiphySearchStepExecutionImpl

public abstract class GiphySearchStepExecution<T>
extends org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<T>

Author:

aviadlevy

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GiphySearchStepExecution(GiphySearchStep 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 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	handleGiphySearchResponse(GiphySearchStep 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.

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

Constructor Detail

GiphySearchStepExecution

public GiphySearchStepExecution(GiphySearchStep 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

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

handleGiphySearchResponse

protected abstract T handleGiphySearchResponse(GiphySearchStep 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