Package org.ovirt.vdsm.jsonrpc.client.internal

Class ClientPolicy

java.lang.Object

org.ovirt.vdsm.jsonrpc.client.internal.ClientPolicy

Direct Known Subclasses:

AwaitRetry, DefaultClientRetryPolicy, DefaultConnectionRetryPolicy, StompClientPolicy

public class ClientPolicy
extends Object

Java bean which provide information how retry logic should work.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<Class<? extends Exception>>	exceptions
private String	identifier
private int	incomingHeartbeat
private final AtomicBoolean	isIncomingHeartbeat
private final AtomicBoolean	isOutgoingHeartbeat
private int	outgoingHeartbeat
private final int	retryNumber
private final int	retryTimeOut
private TimeUnit	timeUnit

Constructor Summary

Constructors

Constructor	Description
ClientPolicy(int retryTimeOut, int retryNumber, int incomingHeartbeat)
ClientPolicy(int retryTimeOut, int retryNumber, int incomingHeartbeat, int outgoingHeartbeat)
ClientPolicy(int retryTimeOut, int retryNumber, int incomingHeartbeat, int outgoingHeartbeat, Class<? extends Exception> retryableException)
ClientPolicy(int retryTimeOut, int retryNumber, int incomingHeartbeat, int outgoingHeartbeat, List<Class<? extends Exception>> retryableExceptions)	Create policy using provided values.
ClientPolicy(int retryTimeOut, int retryNumber, int incomingHeartbeat, Class<? extends Exception> retryableException)

Method Summary

Modifier and Type	Method	Description
ClientPolicy	clone()
List<Class<? extends Exception>>	getExceptions()
String	getIdentifier()
int	getIncomingHeartbeat()
int	getOutgoingHeartbeat()
int	getRetryNumber()
int	getRetryTimeOut()
TimeUnit	getTimeUnit()
boolean	isIncomingHeartbeat()
boolean	isOutgoingHeartbeat()
void	setIdentifier(String identifier)
void	setIncomingHeartbeat(boolean isHeartbeat)
final void	setIncomingHeartbeat(int incomingHeartbeat)
void	setOutgoingHeartbeat(boolean isHeartbeat)
final void	setOutgoingHeartbeat(int outgoingHeartbeat)
void	setTimeUnit(TimeUnit timeUnit)

Methods inherited from class java.lang.Object

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

Field Details

retryTimeOut

private final int retryTimeOut

retryNumber

private final int retryNumber

exceptions

private final List<Class<? extends Exception>> exceptions

isIncomingHeartbeat

private final AtomicBoolean isIncomingHeartbeat

isOutgoingHeartbeat

private final AtomicBoolean isOutgoingHeartbeat

incomingHeartbeat

private volatile int incomingHeartbeat

outgoingHeartbeat

private volatile int outgoingHeartbeat

timeUnit

private TimeUnit timeUnit

identifier

private String identifier

Constructor Details

ClientPolicy

public ClientPolicy(int retryTimeOut,
 int retryNumber,
 int incomingHeartbeat,
 int outgoingHeartbeat,
 List<Class<? extends Exception>> retryableExceptions)

Create policy using provided values.

Parameters:

retryTimeOut - - Integer value which is used as timeout between operation retry combined with TimeUnit which is set to milliseconds by default.

retryNumber - - Integer value which defines number of retry attempts.

incomingHeartbeat - - Integer value which defines incoming heart beat.

outgoingHeartbeat - - Integer value which defines outgoing heart beat.

retryableExceptions - - List of retryable exceptions.

ClientPolicy

public ClientPolicy(int retryTimeOut,
 int retryNumber,
 int incomingHeartbeat)

ClientPolicy

public ClientPolicy(int retryTimeOut,
 int retryNumber,
 int incomingHeartbeat,
 int outgoingHeartbeat)

ClientPolicy

public ClientPolicy(int retryTimeOut,
 int retryNumber,
 int incomingHeartbeat,
 Class<? extends Exception> retryableException)

ClientPolicy

public ClientPolicy(int retryTimeOut,
 int retryNumber,
 int incomingHeartbeat,
 int outgoingHeartbeat,
 Class<? extends Exception> retryableException)

Method Details

getRetryTimeOut

public int getRetryTimeOut()

getRetryNumber

public int getRetryNumber()

getIncomingHeartbeat

public int getIncomingHeartbeat()

getOutgoingHeartbeat

public int getOutgoingHeartbeat()

setOutgoingHeartbeat

public final void setOutgoingHeartbeat(int outgoingHeartbeat)

setIncomingHeartbeat

public final void setIncomingHeartbeat(int incomingHeartbeat)

getExceptions

public List<Class<? extends Exception>> getExceptions()

getTimeUnit

public TimeUnit getTimeUnit()

getIdentifier

public String getIdentifier()

setIdentifier

public void setIdentifier(String identifier)

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

isIncomingHeartbeat

public boolean isIncomingHeartbeat()

setIncomingHeartbeat

public void setIncomingHeartbeat(boolean isHeartbeat)

isOutgoingHeartbeat

public boolean isOutgoingHeartbeat()

setOutgoingHeartbeat

public void setOutgoingHeartbeat(boolean isHeartbeat)

clone

public ClientPolicy clone()

Overrides:

clone in class Object