Package org.infinispan.xsite.status

Interface TakeOfflineManager

All Superinterfaces:

CustomMetricsSupplier

All Known Implementing Classes:

DefaultTakeOfflineManager, NoOpTakeOfflineManager

public interface TakeOfflineManager
extends CustomMetricsSupplier

It keeps tracks of cross-site requests to take sites offline when certain failures conditions happen.

Those condition are configured in TakeOfflineConfiguration.

Since:

11.0

Author:

Pedro Ruivo

Method Summary

Modifier and Type	Method	Description
void	amendConfiguration(String siteName, Integer afterFailures, Long minTimeToWait)	It changes the TakeOfflineConfiguration for site siteName.
BringSiteOnlineResponse	bringSiteOnline(String siteName)	It changes the site siteName to online.
TakeOfflineConfiguration	getConfiguration(String siteName)	It returns the current TakeOfflineConfiguration for site siteName.
default Collection<MBeanMetadata.AttributeMetadata>	getCustomMetrics()
SiteState	getSiteState(String siteName)	Returns the site state for site siteName.
void	registerRequest(XSiteResponse<?> response)	Registers a cross-site request made.
Map<String,Boolean>	status()	It returns a Map with the sites name and their state (Online or Offline).
TakeSiteOfflineResponse	takeSiteOffline(String siteName)	It changes the site siteName to offline.

Method Details

registerRequest

void registerRequest(XSiteResponse<?> response)

Registers a cross-site request made.

Handles the response for the request and takes action in case of failure.

Parameters:

response - The cross-site response.

getSiteState

SiteState getSiteState(String siteName)

Returns the site state for site siteName.

The site can be SiteState.ONLINE or SiteState.OFFLINE. If it doesn't exist, SiteState.NOT_FOUND is returned.

Parameters:

siteName - The remote site name.

Returns:

The SiteState.

amendConfiguration

void amendConfiguration(String siteName,
 Integer afterFailures,
 Long minTimeToWait)

It changes the TakeOfflineConfiguration for site siteName.

If the siteName doesn't exist, this method is a no-op.

Parameters:

siteName - The remote site name.

afterFailures - The new TakeOfflineConfigurationBuilder.afterFailures(int) or null for no changes.

minTimeToWait - The new TakeOfflineConfigurationBuilder.minTimeToWait(long) or null for no changes.

getConfiguration

TakeOfflineConfiguration getConfiguration(String siteName)

It returns the current TakeOfflineConfiguration for site siteName.

Parameters:

siteName - The remote site name.

Returns:

The current TakeOfflineConfiguration or null if the site siteName doesn't exist.

status

Map<String,Boolean> status()

It returns a Map with the sites name and their state (Online or Offline).

If a site is online, then its value is Boolean.TRUE, otherwise is Boolean.FALSE.

Returns:

A Map with the site state.

bringSiteOnline

BringSiteOnlineResponse bringSiteOnline(String siteName)

It changes the site siteName to online.

If the site is already online, then BringSiteOnlineResponse.ALREADY_ONLINE is returned. If it doesn't exits, BringSiteOnlineResponse.NO_SUCH_SITE is returned.

Parameters:

siteName - The remote site name.

Returns:

The BringSiteOnlineResponse.

takeSiteOffline

TakeSiteOfflineResponse takeSiteOffline(String siteName)

It changes the site siteName to offline.

If the site is already offline, then TakeSiteOfflineResponse.ALREADY_OFFLINE is returned. If it doesn't exits, TakeSiteOfflineResponse.NO_SUCH_SITE is returned.

Parameters:

siteName - The remote site name.

Returns:

The TakeSiteOfflineResponse.

getCustomMetrics

default Collection<MBeanMetadata.AttributeMetadata> getCustomMetrics()

Specified by:

getCustomMetrics in interface CustomMetricsSupplier

Returns:

A list of MBeanMetadata.AttributeMetadata to be registered.