org.gridgain.grid.spi.discovery.jms
Interface GridJmsDiscoverySpiMBean

All Superinterfaces:

GridSpiManagementMBean

All Known Implementing Classes:

GridJmsDiscoverySpi

@GridMBeanDescription(value="MBean that provides access to JMS-based discovery SPI configuration.")
public interface GridJmsDiscoverySpiMBean
extends GridSpiManagementMBean

Management bean for GridJmsDiscoverySpi.



See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.1.0

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

Method Summary

javax.jms.ConnectionFactory	getConnectionFactory() Returns JMS connection factory.
String	getConnectionFactoryName() Returns name of the JMS connection factory in JNDI tree that is used for establishing connections by discovery SPI.
int	getHandshakeActiveThreadCount() Returns the approximate number of threads that are actively processing handshake tasks.
int	getHandshakeCorePoolSize() Returns the core number of handshake threads.
int	getHandshakeLargestPoolSize() Returns the largest number of handshake threads that have ever simultaneously been in the pool.
int	getHandshakeMaximumPoolSize() Returns the maximum allowed number of handshake threads.
int	getHandshakePoolSize() Returns the current number of handshake threads in the pool.
int	getHandshakeQueueSize() Gets current size of the handshake queue size.
long	getHandshakeTotalCompletedCount() Returns the approximate total number of handshakes that have completed execution.
long	getHandshakeTotalScheduledCount() Returns the approximate total number of handshake tasks that have been scheduled for execution.
long	getHandshakeWaitTime() Returns timeout value for attributes handshake.
long	getHeartbeatFrequency() Returns interval for heartbeat messages.
Map<Object,Object>	getJndiEnvironment() Returns naming context variables which are used by node to establish JNDI tree connection.
int	getMaximumHandshakeThreads() Returns maximum number of handshake threads.
long	getMaximumMissedHeartbeats() Returns numbers of heartbeat messages that could be missed before node is considered to be failed.
long	getPingWaitTime() Returns timeout value for ping request.
int	getRemoteNodeCount() Returns number of remote nodes.
Collection<UUID>	getRemoteNodeIds() Returns set of discovered remote nodes IDs.
long	getTimeToLive() Returns JMS time to live value for messages.
javax.jms.Topic	getTopic() Returns JMS topic for broadcasting messages to all discovered nodes.
String	getTopicName() Returns JMS topic name for broadcasting messages to all discovered nodes.
String	getUser() Returns username to connect to JNDI.

Methods inherited from interface org.gridgain.grid.spi.GridSpiManagementMBean

getAuthor, getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, getVendorEmail, getVendorUrl, getVersion

Method Detail

getRemoteNodeIds

@GridMBeanDescription(value="Set of remote nodes IDs.")
Collection<UUID> getRemoteNodeIds()

Returns set of discovered remote nodes IDs.

Returns:

Set of remote nodes IDs.

getRemoteNodeCount

@GridMBeanDescription(value="Number of remote nodes.")
int getRemoteNodeCount()

Returns number of remote nodes.

Returns:

Number of remote nodes.

getUser

@GridMBeanDescription(value="Username to connect to JNDI.")
String getUser()

Returns username to connect to JNDI.

Returns:

Name of the user. If not set, null is returned.

getHeartbeatFrequency

@GridMBeanDescription(value="Interval in milliseconds for heartbeat messages.")
long getHeartbeatFrequency()

Returns interval for heartbeat messages.

Returns:

Time in milliseconds.

getMaximumMissedHeartbeats

@GridMBeanDescription(value="Numbers of heartbeat messages that could be missed before node is considered to be failed.")
long getMaximumMissedHeartbeats()

Returns numbers of heartbeat messages that could be missed before node is considered to be failed.

Returns:

Number of heartbeat messages.

getTimeToLive

@GridMBeanDescription(value="JMS time to live value for messages in milliseconds.")
long getTimeToLive()

Returns JMS time to live value for messages.

Returns:

Time-to-live value in milliseconds.

getPingWaitTime

@GridMBeanDescription(value="Timeout value for ping request in milliseconds.")
long getPingWaitTime()

Returns timeout value for ping request.

Returns:

Time in milliseconds.

getHandshakeWaitTime

@GridMBeanDescription(value="Timeout value for attributes handshake in milliseconds.")
long getHandshakeWaitTime()

Returns timeout value for attributes handshake.

Returns:

Time in milliseconds.

getMaximumHandshakeThreads

@GridMBeanDescription(value="Maximum number of handshake threads.")
int getMaximumHandshakeThreads()

Returns maximum number of handshake threads. This means maximum number of handshakes that can be executed in parallel.

Note that if you expect a lot of nodes discovered each other in parallel you should better set higher value. After discovery number of unused threads will be shrank to 1. Typically two nodes that discover each other require one thread.

Returns:

Maximum number of handshake threads.

getHandshakeActiveThreadCount

@GridMBeanDescription(value="Approximate number of threads that are actively processing handshake tasks.")
int getHandshakeActiveThreadCount()

Returns the approximate number of threads that are actively processing handshake tasks.

Returns:

Approximate number of threads that are actively processing handshake tasks.

getHandshakeTotalCompletedCount

@GridMBeanDescription(value="Approximate total number of handshakes that have completed execution.")
long getHandshakeTotalCompletedCount()

Returns the approximate total number of handshakes that have completed execution.

Returns:

Approximate total number of handshakes that have completed execution.

getHandshakeQueueSize

@GridMBeanDescription(value="Current size of the handshake queue size.")
int getHandshakeQueueSize()

Gets current size of the handshake queue size. Handshake queue keeps handshake tasks when there are not threads available for processing in the pool.

Returns:

Current size of the handshake queue size.

getHandshakeCorePoolSize

@GridMBeanDescription(value="Core number of handshake threads.")
int getHandshakeCorePoolSize()

Returns the core number of handshake threads.

Returns:

Core number of handshake threads.

getHandshakeLargestPoolSize

@GridMBeanDescription(value="Largest number of handshake threads that have ever simultaneously been in the pool.")
int getHandshakeLargestPoolSize()

Returns the largest number of handshake threads that have ever simultaneously been in the pool.

Returns:

Largest number of handshake threads that have ever simultaneously been in the pool.

getHandshakeMaximumPoolSize

@GridMBeanDescription(value="Maximum allowed number of handshake threads.")
int getHandshakeMaximumPoolSize()

Returns the maximum allowed number of handshake threads.

Returns:

Maximum allowed number of handshake threads.

getHandshakePoolSize

@GridMBeanDescription(value="Current number of handshake threads in the pool.")
int getHandshakePoolSize()

Returns the current number of handshake threads in the pool.

Returns:

Current number of handshake threads in the pool.

getHandshakeTotalScheduledCount

@GridMBeanDescription(value="Approximate total number of handshake tasks that have been scheduled for execution.")
long getHandshakeTotalScheduledCount()

Returns the approximate total number of handshake tasks that have been scheduled for execution.

Returns:

Approximate total number of handshake tasks that have been scheduled for execution.

getJndiEnvironment

@GridMBeanDescription(value="Map of JNDI environment variables.")
Map<Object,Object> getJndiEnvironment()

Returns naming context variables which are used by node to establish JNDI tree connection.

Returns:

Map of JNDI environment variables.

See Also:

Context

getConnectionFactoryName

@GridMBeanDescription(value="Name of the JMS connection factory in JNDI tree.")
String getConnectionFactoryName()

Returns name of the JMS connection factory in JNDI tree that is used for establishing connections by discovery SPI.

Returns:

Connection factory name. If not set, null is returned.

getConnectionFactory

@GridMBeanDescription(value="JMS connection factory.")
javax.jms.ConnectionFactory getConnectionFactory()

Returns JMS connection factory.

Returns:

Connection factory.

getTopicName

@GridMBeanDescription(value="Name of the topic in JNDI tree.")
String getTopicName()

Returns JMS topic name for broadcasting messages to all discovered nodes.

Returns:

Name of the topic in JNDI tree.

getTopic

@GridMBeanDescription(value="JMS topic for broadcasting messages to all discovered nodes.")
javax.jms.Topic getTopic()

Returns JMS topic for broadcasting messages to all discovered nodes.

Returns:

JMS topic.