org.gridgain.grid.spi.communication.jms
Interface GridJmsCommunicationSpiMBean

All Superinterfaces:

GridSpiManagementMBean

All Known Implementing Classes:

GridJmsCommunicationSpi

@GridMBeanDescription(value="MBean provides access to the JMS communication SPI configuration.")
public interface GridJmsCommunicationSpiMBean
extends GridSpiManagementMBean

Management bean that provides read-only access to the JMS communication SPI configuration. Beside connectivity this bean shows message delivery mode, queue/topic transaction mode and messages priority.



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.
int	getDeliveryMode() Gets messages delivery mode.
Map<Object,Object>	getJndiEnvironment() Gets naming context variables which are used by node to establish JNDI tree connection.
String	getPassword() Gets JMS connection password for connectivity authentication.
int	getPriority() Gets messages delivery priority as defined in Message.
javax.jms.Queue	getQueue() Gets JMS queue.
String	getQueueName() Gets JNDI name for JMS queue.
long	getTimeToLive() Gets messages lifetime.
javax.jms.Topic	getTopic() Gets JMS topic.
String	getTopicName() Gets JNDI name of the JMS topic.
String	getUser() Gets JMS connection user name for connectivity authentication.
boolean	isTransacted() Indicates whether JMS messages are transacted or not.

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

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

Method Detail

isTransacted

@GridMBeanDescription(value="Indicates whether JMS messages are transacted or not.")
boolean isTransacted()

Indicates whether JMS messages are transacted or not.

Returns:

true if session supports transactions, otherwise false.

getDeliveryMode

@GridMBeanDescription(value="Messages delivery mode.")
int getDeliveryMode()

Gets messages delivery mode.

Returns:

Either DeliveryMode.PERSISTENT or DeliveryMode.NON_PERSISTENT.

getPriority

@GridMBeanDescription(value="Message priority.")
int getPriority()

Gets messages delivery priority as defined in Message. The lower the faster.

Returns:

Message priority.

getTimeToLive

@GridMBeanDescription(value="Time-to-live value in milliseconds.")
long getTimeToLive()

Gets messages lifetime. Messages stays in the queue/topic until they run out of time.

Returns:

Time-to-live value in milliseconds.

getQueueName

@GridMBeanDescription(value="Name of the queue in JNDI tree.")
String getQueueName()

Gets JNDI name for JMS queue. If provided, then queue will be used for node-to-node communication otherwise topic will be used.

Returns:

Name of the queue in JNDI tree.

getQueue

@GridMBeanDescription(value="JMS queue.")
javax.jms.Queue getQueue()

Gets JMS queue. If provided, then queue will be used for node-to-node communication otherwise topic will be used.

Returns:

JMS queue.

getTopicName

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

Gets JNDI name of the JMS topic.

Returns:

Name of JMS topic in JNDI tree.

getTopic

@GridMBeanDescription(value="JMS topic.")
javax.jms.Topic getTopic()

Gets JMS topic.

Returns:

JMS topic.

getJndiEnvironment

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

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

Returns:

Map of JNDI environment variables.

getConnectionFactoryName

@GridMBeanDescription(value="Connection factory name.")
String getConnectionFactoryName()

Returns name of the JMS connection factory in JNDI tree.

Returns:

Connection factory name.

getConnectionFactory

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

Returns JMS connection factory.

Returns:

Connection factory.

getUser

@GridMBeanDescription(value="Name of the user.")
String getUser()

Gets JMS connection user name for connectivity authentication.

Returns:

Name of the user.

getPassword

@GridMBeanDescription(value="User password.")
String getPassword()

Gets JMS connection password for connectivity authentication.

Returns:

User password.