Package com.yahoo.container.handler

Class VipStatus

java.lang.Object

com.yahoo.container.handler.VipStatus

public class VipStatus
extends Object

A component which keeps track of whether or not this container instance should receive traffic and respond that it is in good health. This is multithread safe.

Author:

Steinar Knutsen, bratseth

Constructor Summary

Constructors

Constructor	Description
VipStatus()	For testing
VipStatus(ClustersStatus clustersStatus)	For testing
VipStatus(QrSearchersConfig dispatchers)	For testing
VipStatus(QrSearchersConfig dispatchers, VipStatusConfig ignored, ClustersStatus clustersStatus)	Deprecated.
VipStatus(QrSearchersConfig dispatchers, VipStatusConfig vipStatusConfig, ClustersStatus clustersStatus, StateMonitor healthState)	Deprecated.
VipStatus(QrSearchersConfig dispatchers, VipStatusConfig vipStatusConfig, ClustersStatus clustersStatus, StateMonitor healthState, com.yahoo.jdisc.Metric metric)
VipStatus(QrSearchersConfig dispatchers, ClustersStatus clustersStatus)	For testing
VipStatus(QrSearchersConfig dispatchers, ClustersStatus clustersStatus, StateMonitor healthState)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addToRotation(Object clusterIdentifier)	Deprecated. use addToRotation(String) instead
void	addToRotation(String clusterIdentifier)	Note that a cluster (which influences up/down state) is up
boolean	isInRotation()	Returns whether this container should receive traffic at this time
void	removeFromRotation(Object clusterIdentifier)	Deprecated. use removeFromRotation(String) instead
void	removeFromRotation(String clusterIdentifier)	Note that a cluster (which influences up/down state) is down
void	setInRotation(Boolean inRotation)	Explicitly set this container in or out of rotation

Methods inherited from class java.lang.Object

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

Constructor Details

VipStatus

public VipStatus()

For testing

VipStatus

public VipStatus(QrSearchersConfig dispatchers)

For testing

VipStatus

public VipStatus(ClustersStatus clustersStatus)

For testing

VipStatus

public VipStatus(QrSearchersConfig dispatchers,
 ClustersStatus clustersStatus)

For testing

VipStatus

@Inject
public VipStatus(QrSearchersConfig dispatchers,
 VipStatusConfig vipStatusConfig,
 ClustersStatus clustersStatus,
 StateMonitor healthState,
 com.yahoo.jdisc.Metric metric)

VipStatus

@Deprecated
public VipStatus(QrSearchersConfig dispatchers,
 VipStatusConfig vipStatusConfig,
 ClustersStatus clustersStatus,
 StateMonitor healthState)

Deprecated.

VipStatus

@Deprecated
public VipStatus(QrSearchersConfig dispatchers,
 ClustersStatus clustersStatus,
 StateMonitor healthState)

Deprecated.

VipStatus

@Deprecated
public VipStatus(QrSearchersConfig dispatchers,
 VipStatusConfig ignored,
 ClustersStatus clustersStatus)

Deprecated.

Method Details

setInRotation

public void setInRotation(Boolean inRotation)

Explicitly set this container in or out of rotation

Parameters:

inRotation - true to set this in rotation regardless of any clusters and of the default value, false to set it out, and null to make this decision using the usual cluster-dependent logic

addToRotation

public void addToRotation(String clusterIdentifier)

Note that a cluster (which influences up/down state) is up

removeFromRotation

public void removeFromRotation(String clusterIdentifier)

Note that a cluster (which influences up/down state) is down

addToRotation

@Deprecated
public void addToRotation(Object clusterIdentifier)

Deprecated.

use addToRotation(String) instead

removeFromRotation

@Deprecated
public void removeFromRotation(Object clusterIdentifier)

Deprecated.

use removeFromRotation(String) instead

isInRotation

public boolean isInRotation()

Returns whether this container should receive traffic at this time