Skip navigation links

oracle.ocsg.heartbeat.management
Interface HeartbeatMBean

public interface HeartbeatMBean

Field Summary

static int	interval
static boolean	isActive
static int	maxRetry

Method Summary

int	getInterval() Returns the maximum interval of time (in milliseconds) a server has to respond to a heartbeat message.
boolean	getIsActive() Returns the status of the heartbeat feature within a domain.
int	getmaxRetry() Returns the total number of unanswered heartbeat messages that a server receives before it is deemed unavailable to process further traffic.
void	setInterval(int interval) Sets the maximum interval of time (in milliseconds) a server has to respond to a heartbeat message.
void	setIsActive(boolean active) Sets the status of the heartbeat feature within a domain.
void	setmaxRetry(int retry) Sets the total number of unanswered heartbeat messages that a server receives before it is deemed unavailable to process further traffic.

Field Detail

interval

public static final int interval

See Also:

Constant Field Values

isActive

public static final boolean isActive

See Also:

Constant Field Values

maxRetry

public static final int maxRetry

See Also:

Constant Field Values

Method Detail

getInterval

public int getInterval()
                throws ConfigurationException

Returns the maximum interval of time (in milliseconds) a server has to respond to a heartbeat message. Used in conjunction with MaxRetry. attribute.

Scope: Cluster

Returns:

maximum interval in milliseconds

Throws:

ConfigurationException

getIsActive

public boolean getIsActive()
                    throws ConfigurationException

Returns the status of the heartbeat feature within a domain. True if enabled, false otherwise.

Scope: Cluster

Returns:

true if heartbeat feature enabled, false otherwise

Throws:

ConfigurationException

getmaxRetry

public int getmaxRetry()
                throws ConfigurationException

Returns the total number of unanswered heartbeat messages that a server receives before it is deemed unavailable to process further traffic.

Scope: Cluster

Returns:

number of heartbeat retries

Throws:

ConfigurationException

setInterval

public void setInterval(int interval)
                 throws ConfigurationException

Sets the maximum interval of time (in milliseconds) a server has to respond to a heartbeat message. Used in conjunction with MaxRetry. attribute. Default Value: 300.

Scope: Cluster

Parameters:

interval - maximum interval in milliseconds

Throws:

ConfigurationException

setIsActive

public void setIsActive(boolean active)
                 throws ConfigurationException

Sets the status of the heartbeat feature within a domain. True if enabled, false otherwise. Default Value: Disabled (false).

Scope: Cluster

Parameters:

active - true to enable heartbeats, false to disable

Throws:

ConfigurationException

setmaxRetry

public void setmaxRetry(int retry)
                 throws ConfigurationException

Sets the total number of unanswered heartbeat messages that a server receives before it is deemed unavailable to process further traffic. The amount of time a server has to respond is set by Interval, and the intervals are totaled. For example 5 heartbeats with an interval of 300 milliseconds gives the server a total of 1500 milliseconds to reply to one of the heartbeats. Default Value: 3

Scope: Cluster

Parameters:

retry - number of heartbeat retries

Throws:

ConfigurationException

Skip navigation links