org.infinispan.remoting.transport.jgroups

Class JGroupsTransport

java.lang.Object

org.infinispan.remoting.transport.AbstractTransport

org.infinispan.remoting.transport.jgroups.JGroupsTransport

All Implemented Interfaces:

Lifecycle, Transport, MembershipListener

public class JGroupsTransport
extends AbstractTransport
implements MembershipListener

An encapsulation of a JGroups transport. JGroups transports can be configured using a variety of methods, usually by passing in one of the following properties:

• configurationString - a JGroups configuration String
• configurationXml - JGroups configuration XML as a String
• configurationFile - String pointing to a JGroups XML configuration file
• channelLookup - Fully qualified class name of a JGroupsChannelLookup instance

These are normally passed in as Properties in GlobalConfiguration.setTransportProperties(java.util.Properties) or in the Infinispan XML configuration file.

Since:

4.0

Author:

Manik Surtani, Galder Zamarreño

Field Summary

Fields

Modifier and Type	Field and Description
protected Address	address
protected ExecutorService	asyncExecutor
protected Channel	channel
static String	CHANNEL_LOOKUP
protected CountDownLatch	channelConnectedLatch
static String	CONFIGURATION_FILE
static String	CONFIGURATION_STRING
static String	CONFIGURATION_XML
protected Address	coordinator
protected static String	DEFAULT_JGROUPS_CONFIGURATION_FILE
protected InboundInvocationHandler	inboundInvocationHandler
protected boolean	isCoordinator
protected StreamingMarshaller	marshaller
protected List<Address>	members
protected CacheManagerNotifier	notifier
protected Address	physicalAddress
protected TypedProperties	props
protected boolean	startChannel
protected boolean	stopChannel

Fields inherited from class org.infinispan.remoting.transport.AbstractTransport

configuration

Constructor Summary

Constructors

Constructor and Description
JGroupsTransport()
JGroupsTransport(Channel channel) This form is used when the transport is created by an external source and passed in to the GlobalConfiguration.

Method Summary

Methods

Modifier and Type	Method and Description
void	block() Called (usually by the FLUSH protocol), as an indication that the member should stop sending messages.
Address	getAddress() Retrieves the current cache instance's network address
Channel	getChannel()
CommandAwareRpcDispatcher	getCommandAwareRpcDispatcher()
Address	getCoordinator()
Log	getLog()
List<Address>	getMembers() Returns a list of members in the current cluster view.
List<Address>	getPhysicalAddresses() Retrieves the current cache instance's physical network addresses.
int	getViewId()
protected void	initChannel()
void	initialize(StreamingMarshaller marshaller, ExecutorService asyncExecutor, InboundInvocationHandler inboundInvocationHandler, CacheManagerNotifier notifier) Initializes the transport with global cache configuration and transport-specific properties.
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpcCommand, ResponseMode mode, long timeout, boolean usePriorityQueue, ResponseFilter responseFilter) Invokes an RPC call on other caches in the cluster.
boolean	isCoordinator()
boolean	isMulticastCapable() Tests whether the transport supports true multicast
void	start()
protected void	startJGroupsChannelIfNeeded()
void	stop()
void	suspect(Address suspected_mbr) Called whenever a member is suspected of having crashed, but has not yet been excluded.
protected static Address	toJGroupsAddress(Address a)
void	unblock() Called after the FLUSH protocol has unblocked previously blocked senders, and messages can be sent again.
void	viewAccepted(View newView) Called when a change in membership has occurred.
void	waitForChannelToConnect()

Methods inherited from class org.infinispan.remoting.transport.AbstractTransport

checkResponse, parseResponseAndAddToResponseList, setConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_STRING

public static final String CONFIGURATION_STRING

See Also:

Constant Field Values

CONFIGURATION_XML

public static final String CONFIGURATION_XML

See Also:

Constant Field Values

CONFIGURATION_FILE

public static final String CONFIGURATION_FILE

See Also:

Constant Field Values

CHANNEL_LOOKUP

public static final String CHANNEL_LOOKUP

See Also:

Constant Field Values

DEFAULT_JGROUPS_CONFIGURATION_FILE

protected static final String DEFAULT_JGROUPS_CONFIGURATION_FILE

See Also:

Constant Field Values

startChannel

protected boolean startChannel

stopChannel

protected boolean stopChannel

props

protected TypedProperties props

inboundInvocationHandler

protected InboundInvocationHandler inboundInvocationHandler

marshaller

protected StreamingMarshaller marshaller

asyncExecutor

protected ExecutorService asyncExecutor

notifier

protected CacheManagerNotifier notifier

channel

protected Channel channel

address

protected Address address

physicalAddress

protected Address physicalAddress

members

protected volatile List<Address> members

coordinator

protected volatile Address coordinator

isCoordinator

protected volatile boolean isCoordinator

channelConnectedLatch

protected CountDownLatch channelConnectedLatch

Constructor Detail

JGroupsTransport

public JGroupsTransport(Channel channel)

This form is used when the transport is created by an external source and passed in to the GlobalConfiguration.

Parameters:

channel - created and running channel to use

JGroupsTransport

public JGroupsTransport()

Method Detail

getLog

public Log getLog()

Specified by:

getLog in interface Transport

initialize

public void initialize(StreamingMarshaller marshaller,
              ExecutorService asyncExecutor,
              InboundInvocationHandler inboundInvocationHandler,
              CacheManagerNotifier notifier)

Description copied from interface: Transport

Initializes the transport with global cache configuration and transport-specific properties.

Specified by:

initialize in interface Transport

Parameters:

marshaller - marshaller to use for marshalling and unmarshalling

asyncExecutor - executor to use for asynchronous calls

inboundInvocationHandler - handler for invoking remotely originating calls on the local cache

notifier - notifier to use

start

public void start()

Specified by:

start in interface Lifecycle

Specified by:

start in interface Transport

startJGroupsChannelIfNeeded

protected void startJGroupsChannelIfNeeded()

getViewId

public int getViewId()

Specified by:

getViewId in interface Transport

stop

public void stop()

Specified by:

stop in interface Lifecycle

Specified by:

stop in interface Transport

initChannel

protected void initChannel()

isCoordinator

public boolean isCoordinator()

Specified by:

isCoordinator in interface Transport

Returns:

true if the current Channel is the coordinator of the cluster.

getCoordinator

public Address getCoordinator()

Specified by:

getCoordinator in interface Transport

Returns:

the Address of the current coordinator.

waitForChannelToConnect

public void waitForChannelToConnect()

getMembers

public List<Address> getMembers()

Description copied from interface: Transport

Returns a list of members in the current cluster view.

Specified by:

getMembers in interface Transport

Returns:

a list of members. Typically, this would be defensively copied.

isMulticastCapable

public boolean isMulticastCapable()

Description copied from interface: Transport

Tests whether the transport supports true multicast

Specified by:

isMulticastCapable in interface Transport

Returns:

true if the transport supports true multicast

getAddress

public Address getAddress()

Description copied from interface: Transport

Retrieves the current cache instance's network address

Specified by:

getAddress in interface Transport

Returns:

an Address

getPhysicalAddresses

public List<Address> getPhysicalAddresses()

Description copied from interface: Transport

Retrieves the current cache instance's physical network addresses. Some implementations might differentiate between logical and physical addresses in which case, this method allows clients to query the physical ones associated with the logical address. Implementations where logical and physical address are the same will simply return a single entry List that contains the same Address as Transport.getAddress().

Specified by:

getPhysicalAddresses in interface Transport

Returns:

an List of Address

invokeRemotely

public Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                   ReplicableCommand rpcCommand,
                                   ResponseMode mode,
                                   long timeout,
                                   boolean usePriorityQueue,
                                   ResponseFilter responseFilter)
                                     throws Exception

Description copied from interface: Transport

Invokes an RPC call on other caches in the cluster.

Specified by:

invokeRemotely in interface Transport

Parameters:

recipients - a list of Addresses to invoke the call on. If this is null, the call is broadcast to the entire cluster.

rpcCommand - the cache command to invoke

mode - the response mode to use

timeout - a timeout after which to throw a replication exception.

usePriorityQueue - if true, a priority queue is used to deliver messages. May not be supported by all implementations.

responseFilter - a response filter with which to filter out failed/unwanted/invalid responses.

Returns:

a map of responses from each member contacted.

Throws:

Exception - in the event of problems.

viewAccepted

public void viewAccepted(View newView)

Description copied from interface: MembershipListener

Called when a change in membership has occurred. No long running actions, sending of messages or anything that could block should be done in this callback. If some long running action needs to be performed, it should be done in a separate thread.

Note that on reception of the first view (a new member just joined), the channel will not yet be in the connected state. This only happens when Channel.connect(String) returns.

Specified by:

viewAccepted in interface MembershipListener

suspect

public void suspect(Address suspected_mbr)

Description copied from interface: MembershipListener

Called whenever a member is suspected of having crashed, but has not yet been excluded.

Specified by:

suspect in interface MembershipListener

block

public void block()

Description copied from interface: MembershipListener

Called (usually by the FLUSH protocol), as an indication that the member should stop sending messages. Any messages sent after returning from this callback might get blocked by the FLUSH protocol. When the FLUSH protocol is done, and messages can be sent again, the FLUSH protocol will simply unblock all pending messages. If a callback for unblocking is desired, implement MembershipListener.unblock(). Note that block() is the equivalent of reception of a BlockEvent in the pull mode.

Specified by:

block in interface MembershipListener

unblock

public void unblock()

Description copied from interface: MembershipListener

Called after the FLUSH protocol has unblocked previously blocked senders, and messages can be sent again. This callback only needs to be implemented if we require a notification of that.

Note that during new view installation we provide guarantee that unblock invocation strictly follows view installation at some node A belonging to that view . However, some other message M may squeeze in between view and unblock callbacks. For more details see https://jira.jboss.org/jira/browse/JGRP-986

Specified by:

unblock in interface MembershipListener

toJGroupsAddress

protected static Address toJGroupsAddress(Address a)

getCommandAwareRpcDispatcher

public CommandAwareRpcDispatcher getCommandAwareRpcDispatcher()

getChannel

public Channel getChannel()