@MBean(objectName="XSiteAdmin", description="Exposes tooling for handling backing up data to remote sites.") public class XSiteAdminOperations extends Object
Modifier and Type | Field and Description |
---|---|
static String |
FAILED |
static String |
OFFLINE |
static String |
ONLINE |
static String |
SUCCESS |
Constructor and Description |
---|
XSiteAdminOperations() |
public static final String ONLINE
public static final String FAILED
public static final String OFFLINE
public static final String SUCCESS
public static String siteStatusToString(SiteStatus status, Function<CacheMixedSiteStatus,String> mixedFunction)
public static String siteStatusToString(SiteStatus status)
public Map<String,SiteStatus> clusterStatus()
@ManagedOperation(description="Check whether the given backup site is offline or not.", displayName="Check whether the given backup site is offline or not.") public String siteStatus(@Parameter(name="site",description="The name of the backup site") String site)
public Map<Address,String> nodeStatus(String site)
site
- The name of the backup site@ManagedOperation(description="Returns the the status(offline/online) of all the configured backup sites.", displayName="Returns the the status(offline/online) of all the configured backup sites.") public String status()
@ManagedOperation(description="Takes this site offline in all nodes in the cluster.", displayName="Takes this site offline in all nodes in the cluster.") public String takeSiteOffline(@Parameter(name="site",description="The name of the backup site") String site)
@ManagedOperation(description="Amends the values for \'afterFailures\' for the \'TakeOffline\' functionality on all the nodes in the cluster.", displayName="Amends the values for \'TakeOffline.afterFailures\' on all the nodes in the cluster.") public String setTakeOfflineAfterFailures(@Parameter(name="site",description="The name of the backup site") String site, @Parameter(name="afterFailures",description="The number of failures after which the site will be taken offline") int afterFailures)
@ManagedOperation(description="Amends the values for \'minTimeToWait\' for the \'TakeOffline\' functionality on all the nodes in the cluster.", displayName="Amends the values for \'TakeOffline.minTimeToWait\' on all the nodes in the cluster.") public String setTakeOfflineMinTimeToWait(@Parameter(name="site",description="The name of the backup site") String site, @Parameter(name="minTimeToWait",description="The minimum amount of time in milliseconds to wait before taking a site offline") long minTimeToWait)
@ManagedOperation(description="Amends the values for \'TakeOffline\' functionality on all the nodes in the cluster.", displayName="Amends the values for \'TakeOffline\' functionality on all the nodes in the cluster.") public String amendTakeOffline(@Parameter(name="site",description="The name of the backup site") String site, @Parameter(name="afterFailures",description="The number of failures after which the site will be taken offline") int afterFailures, @Parameter(name="minTimeToWait",description="The minimum amount of time in milliseconds to wait before taking a site offline") long minTimeToWait)
@ManagedOperation(description="Returns the value of the \'minTimeToWait\' for the \'TakeOffline\' functionality.", displayName="Returns the value of the \'minTimeToWait\' for the \'TakeOffline\' functionality.") public String getTakeOfflineMinTimeToWait(@Parameter(name="site",description="The name of the backup site") String site)
@ManagedOperation(description="Returns the value of the \'afterFailures\' for the \'TakeOffline\' functionality.", displayName="Returns the value of the \'afterFailures\' for the \'TakeOffline\' functionality.") public String getTakeOfflineAfterFailures(@Parameter(name="site",description="The name of the backup site") String site)
public TakeOfflineConfiguration getTakeOfflineConfiguration(String site)
public boolean checkSite(String site)
@ManagedOperation(description="Brings the given site back online on all the cluster.", displayName="Brings the given site back online on all the cluster.") public String bringSiteOnline(@Parameter(name="site",description="The name of the backup site") String site)
@ManagedOperation(displayName="Push state to site", description="Pushes the state of this cache to the remote site. The remote site will be bring back online", name="pushState") public final String pushState(@Parameter(description="The destination site name",name="SiteName") String siteName)
@ManagedOperation(displayName="Push State Status", description="Shows a map with destination site name and the state transfer status.", name="PushStateStatus") public final Map<String,String> getPushStateStatus()
@ManagedOperation(displayName="Clear State Status", description="Clears the state transfer status.", name="ClearPushStateStatus") public final String clearPushStateStatus()
@ManagedOperation(displayName="Cancel Push Status", description="Cancels the push state to remote site.", name="CancelPushState") public final String cancelPushState(@Parameter(description="The destination site name",name="SiteName") String siteName)
@ManagedOperation(displayName="Cancel Receive State", description="Cancels the push state to this site. All the state received from state transfer will be ignored.", name="CancelReceiveState") public final String cancelReceiveState(@Parameter(description="The sending site name",name="SiteName") String siteName)
@ManagedOperation(displayName="Sending Site Name", description="Returns the site name from which this site is receiving state.", name="SendingSiteName") public final String getSendingSiteName()
Copyright © 2021 JBoss by Red Hat. All rights reserved.