org.apache.sling.hc.api.execution

Class HealthCheckExecutionOptions

java.lang.Object

org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

public class HealthCheckExecutionOptions
extends java.lang.Object

Options for behavior of health check execution.

Constructor Summary

Constructors

Constructor and Description
HealthCheckExecutionOptions()

Method Summary

Modifier and Type	Method and Description
int	getOverrideGlobalTimeout()
boolean	isCombineTagsWithOr()
boolean	isForceInstantExecution()
void	setCombineTagsWithOr(boolean combineTagsWithOr) If activated, the given tags will be combined with a logical "or" instead of "and".
void	setForceInstantExecution(boolean forceInstantExecution) If activated, this will ensure that asynchronous checks will be executed immediately.
void	setOverrideGlobalTimeout(int overrideGlobalTimeout) Allows to override the global timeout for this particular execution of the health check.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HealthCheckExecutionOptions

public HealthCheckExecutionOptions()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setForceInstantExecution

public void setForceInstantExecution(boolean forceInstantExecution)

If activated, this will ensure that asynchronous checks will be executed immediately.

Parameters:

forceInstantExecution - boolean flag

setCombineTagsWithOr

public void setCombineTagsWithOr(boolean combineTagsWithOr)

If activated, the given tags will be combined with a logical "or" instead of "and".

Parameters:

combineTagsWithOr - boolean flag

setOverrideGlobalTimeout

public void setOverrideGlobalTimeout(int overrideGlobalTimeout)

Allows to override the global timeout for this particular execution of the health check.

Parameters:

overrideGlobalTimeout - timeout in ms to be used for this execution of the execution

isForceInstantExecution

public boolean isForceInstantExecution()

Returns:

true if instant execution is turned on

isCombineTagsWithOr

public boolean isCombineTagsWithOr()

Returns:

true if combining tags with or is turned on

getOverrideGlobalTimeout

public int getOverrideGlobalTimeout()

Returns:

the timeout to be used for this execution (overriding the global timeout)