io.parallec.core.actor.poll

Class HttpPollerProcessor

java.lang.Object

io.parallec.core.actor.poll.HttpPollerProcessor

public class HttpPollerProcessor
extends Object

Define how to poll progress 1. how to get the job id from the 1st response. 2. what is the URL template to poll progress (assuming it is a HTTP GET) 3. the regex to get the progress num. Note that this progress regex is not used to check if the job is completed. just for record. 4. Poll API: assume the HTTP Method for poll: is GET / no body/ and with the same header as the 1st reqwuest

Author:

Yuanteng (Jeff) Pei

Constructor Summary

Constructors

Constructor and Description
HttpPollerProcessor() default as the cronus agent poller Assuming the polling API is By HTTP GET; without any postbody (for GET, no post body for sure)
HttpPollerProcessor(String pollerType, String successRegex, String failureRegex, String uuidRegex, String progressRegex, int progressStuckTimeoutSeconds, long pollIntervalMillis, String pollerRequestTemplate, String jobIdPlaceHolder, int maxPollError) Instantiates a new http poller processor.

Method Summary

Modifier and Type	Method and Description
String	getFailureRegex() Gets the failure regex.
String	getJobIdPlaceHolder() Gets the job id place holder.
String	getJobIdRegex() Gets the job id regex.
int	getMaxPollError() Gets the max poll error.
String	getPollerRequestTemplate() Gets the poller request template.
String	getPollerRequestUrl(String uuid) Important.
String	getPollerType() Gets the poller type.
long	getPollIntervalMillis() Gets the poll interval millis.
double	getProgressFromResponse(ResponseOnSingeRequest myResponse) Gets the progress from response.
String	getProgressRegex() Gets the progress regex.
int	getProgressStuckTimeoutSeconds() Gets the progress stuck timeout seconds.
String	getUuidFromResponse(ResponseOnSingeRequest myResponse) Gets the uuid from response.
boolean	ifTaskCompletedSuccessOrFailureFromResponse(ResponseOnSingeRequest myResponse) If task completed success or failure from response.
boolean	ifThereIsErrorInResponse(ResponseOnSingeRequest myResponse) If there is error in response.
void	setFailureRegex(String failureRegex) Sets the failure regex.
void	setJobIdPlaceHolder(String jobIdPlaceHolder) Sets the job id place holder.
void	setJobIdRegex(String jobIdRegex) Sets the job id regex.
void	setMaxPollError(int maxPollError) Sets the max poll error.
void	setPollerRequestTemplate(String pollerRequestTemplate) Sets the poller request template.
void	setPollerType(String pollerType) Sets the poller type.
void	setPollIntervalMillis(long pollIntervalMillis) Sets the poll interval millis.
void	setProgressRegex(String progressRegex) Sets the progress regex.
void	setProgressStuckTimeoutSeconds(int progressStuckTimeoutSeconds) Sets the progress stuck timeout seconds.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpPollerProcessor

public HttpPollerProcessor()

default as the cronus agent poller Assuming the polling API is By HTTP GET; without any postbody (for GET, no post body for sure)

HttpPollerProcessor

public HttpPollerProcessor(String pollerType,
                           String successRegex,
                           String failureRegex,
                           String uuidRegex,
                           String progressRegex,
                           int progressStuckTimeoutSeconds,
                           long pollIntervalMillis,
                           String pollerRequestTemplate,
                           String jobIdPlaceHolder,
                           int maxPollError)

Instantiates a new http poller processor.

Parameters:

pollerType - the poller type

successRegex - the success regex

failureRegex - the failure regex

uuidRegex - the uuid regex

progressRegex - the progress regex

progressStuckTimeoutSeconds - the progress stuck timeout seconds

pollIntervalMillis - the poll interval millis

pollerRequestTemplate - the poller request template

jobIdPlaceHolder - the job id place holder

maxPollError - the max poll error

Method Detail

getPollerRequestUrl

public String getPollerRequestUrl(String uuid)

Important. get the poller URL

Parameters:

uuid - the uuid

Returns:

the poller request url

getPollIntervalMillis

public long getPollIntervalMillis()

Gets the poll interval millis.

Returns:

the poll interval millis

setPollIntervalMillis

public void setPollIntervalMillis(long pollIntervalMillis)

Sets the poll interval millis.

Parameters:

pollIntervalMillis - the new poll interval millis

getPollerRequestTemplate

public String getPollerRequestTemplate()

Gets the poller request template.

Returns:

the poller request template

setPollerRequestTemplate

public void setPollerRequestTemplate(String pollerRequestTemplate)

Sets the poller request template.

Parameters:

pollerRequestTemplate - the new poller request template

getUuidFromResponse

public String getUuidFromResponse(ResponseOnSingeRequest myResponse)

Gets the uuid from response.

Parameters:

myResponse - the my response

Returns:

the uuid from response

getProgressFromResponse

public double getProgressFromResponse(ResponseOnSingeRequest myResponse)

Gets the progress from response.

Parameters:

myResponse - the my response

Returns:

the progress from response

ifThereIsErrorInResponse

public boolean ifThereIsErrorInResponse(ResponseOnSingeRequest myResponse)

If there is error in response.

Parameters:

myResponse - the my response

Returns:

true, if successful

ifTaskCompletedSuccessOrFailureFromResponse

public boolean ifTaskCompletedSuccessOrFailureFromResponse(ResponseOnSingeRequest myResponse)

If task completed success or failure from response.

Parameters:

myResponse - the my response

Returns:

true, if successful

getPollerType

public String getPollerType()

Gets the poller type.

Returns:

the poller type

setPollerType

public void setPollerType(String pollerType)

Sets the poller type.

Parameters:

pollerType - the new poller type

getFailureRegex

public String getFailureRegex()

Gets the failure regex.

Returns:

the failure regex

setFailureRegex

public void setFailureRegex(String failureRegex)

Sets the failure regex.

Parameters:

failureRegex - the new failure regex

getProgressRegex

public String getProgressRegex()

Gets the progress regex.

Returns:

the progress regex

setProgressRegex

public void setProgressRegex(String progressRegex)

Sets the progress regex.

Parameters:

progressRegex - the new progress regex

getProgressStuckTimeoutSeconds

public int getProgressStuckTimeoutSeconds()

Gets the progress stuck timeout seconds.

Returns:

the progress stuck timeout seconds

setProgressStuckTimeoutSeconds

public void setProgressStuckTimeoutSeconds(int progressStuckTimeoutSeconds)

Sets the progress stuck timeout seconds.

Parameters:

progressStuckTimeoutSeconds - the new progress stuck timeout seconds

toString

public String toString()

Overrides:

toString in class Object

getJobIdPlaceHolder

public String getJobIdPlaceHolder()

Gets the job id place holder.

Returns:

the job id place holder

setJobIdPlaceHolder

public void setJobIdPlaceHolder(String jobIdPlaceHolder)

Sets the job id place holder.

Parameters:

jobIdPlaceHolder - the new job id place holder

getJobIdRegex

public String getJobIdRegex()

Gets the job id regex.

Returns:

the job id regex

setJobIdRegex

public void setJobIdRegex(String jobIdRegex)

Sets the job id regex.

Parameters:

jobIdRegex - the new job id regex

getMaxPollError

public int getMaxPollError()

Gets the max poll error.

Returns:

the max poll error

setMaxPollError

public void setMaxPollError(int maxPollError)

Sets the max poll error.

Parameters:

maxPollError - the new max poll error