org.qas.api.http

Class ExecutionContext

java.lang.Object

org.qas.api.http.ExecutionContext

public final class ExecutionContext
extends java.lang.Object

ExecutionContext

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ExecutionContext() Creates ExecutionContext object from the empty list of RequestHandler objects.
ExecutionContext(java.util.List<RequestHandler> requestHandlers) Creates ExecutionContext object from the list of RequestHandler objects.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContextUserAgent()
Credentials	getCredentials()
CustomBackoffStrategy	getCustomBackoffStrategy() Returns the optional custom backoff strategy for controlling how long between retries on error responses.
java.util.List<RequestHandler>	getRequestHandlers()
Signer	getSigner()
void	setContextUserAgent(java.lang.String contextUserAgent) Sets the context user agent.
void	setCredentials(Credentials credentials) http://analytics.bkav.com/ Sets the execute context credentials.
void	setCustomBackoffStrategy(CustomBackoffStrategy backoffStrategy) Sets the optional custom backoff strategy for controlling how long between retries on error responses.
void	setSigner(Signer signer) Sets the Signer object.
ExecutionContext	withContextUserAgent(java.lang.String contextUserAgent) Sets the context user agent and returns the updated ExecutionContext object.
ExecutionContext	withCredentials(Credentials credentials) Sets the execute context credentials and return the updated ExecutionContext object.
ExecutionContext	withCustomBackoffStrategy(CustomBackoffStrategy backoffStrategy) Sets the optional custom backoff strategy for controlling how long between retries on error responses.
ExecutionContext	withSigner(Signer signer) Sets the Signer object and returns the updated ExecutionContext object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionContext

public ExecutionContext()

Creates ExecutionContext object from the empty list of RequestHandler objects.

ExecutionContext

public ExecutionContext(java.util.List<RequestHandler> requestHandlers)

Creates ExecutionContext object from the list of RequestHandler objects.

Parameters:

requestHandlers - the list of RequestHandler objects to handle the request and response.

Method Detail

getContextUserAgent

public java.lang.String getContextUserAgent()

Returns:

the context user agent.

setContextUserAgent

public void setContextUserAgent(java.lang.String contextUserAgent)

Sets the context user agent.

Parameters:

contextUserAgent - the context user agent to set.

withContextUserAgent

public ExecutionContext withContextUserAgent(java.lang.String contextUserAgent)

Sets the context user agent and returns the updated ExecutionContext object.

Parameters:

contextUserAgent - the context user agent.

Returns:

the updated ExecutionContext object with a new context user agent setting.

getRequestHandlers

public java.util.List<RequestHandler> getRequestHandlers()

Returns:

the list of RequestHandler object.

getSigner

public Signer getSigner()

Returns:

the Signer object used to sign the request.

setSigner

public void setSigner(Signer signer)

Sets the Signer object.

Parameters:

signer - the given Signer object to set.

withSigner

public ExecutionContext withSigner(Signer signer)

Sets the Signer object and returns the updated ExecutionContext object.

Parameters:

signer - the Signer object to set.

Returns:

the updated ExecutionContext object with a new Signer object.

getCredentials

public Credentials getCredentials()

Returns:

the execute context credentials.

setCredentials

public void setCredentials(Credentials credentials)

http://analytics.bkav.com/ Sets the execute context credentials.

Parameters:

credentials - the credentials to set.

withCredentials

public ExecutionContext withCredentials(Credentials credentials)

Sets the execute context credentials and return the updated ExecutionContext object.

Parameters:

credentials - the execution context credentials

Returns:

the updated ExecutionContext object with a new execution context credentials.

getCustomBackoffStrategy

public CustomBackoffStrategy getCustomBackoffStrategy()

Returns the optional custom backoff strategy for controlling how long between retries on error responses. If no custom backoff strategy is specified, a default exponential backoff strategy is used.

Returns:

the optional custom backoff strategy for the associated request.

setCustomBackoffStrategy

public void setCustomBackoffStrategy(CustomBackoffStrategy backoffStrategy)

Sets the optional custom backoff strategy for controlling how long between retries on error responses. If no custom backoff strategy is specified, a default exponential backoff strategy is used.

Parameters:

backoffStrategy - The optional custom backoff strategy for the associated request.

withCustomBackoffStrategy

public ExecutionContext withCustomBackoffStrategy(CustomBackoffStrategy backoffStrategy)

Sets the optional custom backoff strategy for controlling how long between retries on error responses. If no custom backoff strategy is specified, a default exponential backoff strategy is used.

Parameters:

backoffStrategy - The optional custom backoff strategy for the associated request.

Returns:

the updated execution context.