Package org.infinispan.xsite.status

Class DefaultTakeOfflineManager

java.lang.Object

org.infinispan.xsite.status.DefaultTakeOfflineManager

All Implemented Interfaces:

org.infinispan.metrics.impl.CustomMetricsSupplier, XSiteResponse.XSiteResponseCompleted, TakeOfflineManager

public class DefaultTakeOfflineManager
extends Object
implements TakeOfflineManager, XSiteResponse.XSiteResponseCompleted

The default implementation of TakeOfflineManager.

It automatically takes a site offline when certain failures condition happens.

Since:

11.0

Author:

Pedro Ruivo

Constructor Summary

Constructors

Constructor	Description
DefaultTakeOfflineManager(String cacheName)

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.
Collection<MetricInfo>	getCustomMetrics(GlobalMetricsConfiguration configuration)
org.infinispan.xsite.OfflineStatus	getOfflineStatus(String siteName)
SiteState	getSiteState(String siteName)	Returns the site state for site siteName.
static boolean	isCommunicationError(Throwable throwable)
void	onCompleted(org.infinispan.xsite.XSiteBackup backup, long sendTimeNanos, long durationNanos, Throwable throwable)
void	registerRequest(XSiteResponse<?> response)	Registers a cross-site request made.
void	start()
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultTakeOfflineManager

public DefaultTakeOfflineManager(String cacheName)

Method Details

isCommunicationError

public static boolean isCommunicationError(Throwable throwable)

start

public void start()

registerRequest

public void registerRequest(XSiteResponse<?> response)

Description copied from interface: TakeOfflineManager

Registers a cross-site request made.

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

Specified by:

registerRequest in interface TakeOfflineManager

Parameters:

response - The cross-site response.

getSiteState

public SiteState getSiteState(String siteName)

Description copied from interface: TakeOfflineManager

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.

Specified by:

getSiteState in interface TakeOfflineManager

Parameters:

siteName - The remote site name.

Returns:

The SiteState.

amendConfiguration

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

Description copied from interface: TakeOfflineManager

It changes the TakeOfflineConfiguration for site siteName.

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

Specified by:

amendConfiguration in interface TakeOfflineManager

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

public TakeOfflineConfiguration getConfiguration(String siteName)

Description copied from interface: TakeOfflineManager

It returns the current TakeOfflineConfiguration for site siteName.

Specified by:

getConfiguration in interface TakeOfflineManager

Parameters:

siteName - The remote site name.

Returns:

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

status

public Map<String,Boolean> status()

Description copied from interface: TakeOfflineManager

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.

Specified by:

status in interface TakeOfflineManager

Returns:

A Map with the site state.

bringSiteOnline

public BringSiteOnlineResponse bringSiteOnline(String siteName)

Description copied from interface: TakeOfflineManager

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.

Specified by:

bringSiteOnline in interface TakeOfflineManager

Parameters:

siteName - The remote site name.

Returns:

The BringSiteOnlineResponse.

takeSiteOffline

public TakeSiteOfflineResponse takeSiteOffline(String siteName)

Description copied from interface: TakeOfflineManager

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.

Specified by:

takeSiteOffline in interface TakeOfflineManager

Parameters:

siteName - The remote site name.

Returns:

The TakeSiteOfflineResponse.

getCustomMetrics

public Collection<MetricInfo> getCustomMetrics(GlobalMetricsConfiguration configuration)

Specified by:

getCustomMetrics in interface TakeOfflineManager

onCompleted

public void onCompleted(org.infinispan.xsite.XSiteBackup backup,
 long sendTimeNanos,
 long durationNanos,
 Throwable throwable)

Specified by:

onCompleted in interface XSiteResponse.XSiteResponseCompleted

getOfflineStatus

public org.infinispan.xsite.OfflineStatus getOfflineStatus(String siteName)

toString

public String toString()

Overrides:

toString in class Object