Package org.infinispan.remoting.transport

Class AbstractDelegatingTransport

java.lang.Object

org.infinispan.remoting.transport.AbstractDelegatingTransport

All Implemented Interfaces:

org.infinispan.commons.api.Lifecycle, Transport

public abstract class AbstractDelegatingTransport
extends Object
implements Transport

Designed to be overwrite.

Since:

6.0

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field	Description
protected Transport	actual

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDelegatingTransport(Transport actual)

Method Summary

Modifier and Type	Method	Description
protected BackupResponse	afterBackupRemotely(ReplicableCommand command, BackupResponse response)	method invoked after a successful backup remote invocation.
protected Map<Address,Response>	afterInvokeRemotely(ReplicableCommand command, Map<Address,Response> responseMap)	method invoked after a successful remote invocation.
BackupResponse	backupRemotely(Collection<XSiteBackup> backups, XSiteReplicateCommand rpcCommand)
protected void	beforeBackupRemotely(XSiteReplicateCommand command)	method invoked before a backup remote invocation.
protected void	beforeInvokeRemotely(ReplicableCommand command)	method invoked before a remote invocation.
void	checkTotalOrderSupported()	check if the transport has configured with total order deliver properties (has the sequencer in JGroups protocol stack.
Address	getAddress()	Retrieves the current cache instance's network address
Address	getCoordinator()
Transport	getDelegate()
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.
Set<String>	getSitesView()	Get the view of interconnected sites.
int	getViewId()
<T> CompletionStage<T>	invokeCommand(Collection<Address> targets, ReplicableCommand command, ResponseCollector<T> collector, DeliverOrder deliverOrder, long timeout, TimeUnit unit)	Invoke a command on a collection of node and pass the responses to a ResponseCollector.
<T> CompletionStage<T>	invokeCommand(Address target, ReplicableCommand command, ResponseCollector<T> collector, DeliverOrder deliverOrder, long timeout, TimeUnit unit)	Invoke a command on a single node and pass the response to a ResponseCollector.
<T> CompletionStage<T>	invokeCommandOnAll(ReplicableCommand command, ResponseCollector<T> collector, DeliverOrder deliverOrder, long timeout, TimeUnit unit)	Invoke a command on all the nodes in the cluster and pass the responses to a ResponseCollector.
<T> CompletionStage<T>	invokeCommands(Collection<Address> targets, Function<Address,ReplicableCommand> commandGenerator, ResponseCollector<T> collector, DeliverOrder deliverOrder, long timeout, TimeUnit timeUnit)	Invoke different commands on a collection of nodes and pass the responses to a ResponseCollector.
<T> CompletionStage<T>	invokeCommandStaggered(Collection<Address> targets, ReplicableCommand command, ResponseCollector<T> collector, DeliverOrder deliverOrder, long timeout, TimeUnit unit)	Invoke a command on a collection of nodes and pass the responses to a ResponseCollector.
Map<Address,Response>	invokeRemotely(Collection<Address> recipients, ReplicableCommand rpcCommand, ResponseMode mode, long timeout, ResponseFilter responseFilter, DeliverOrder deliverOrder, boolean anycast)	Invokes an RPC call on other caches in the cluster.
Map<Address,Response>	invokeRemotely(Map<Address,ReplicableCommand> rpcCommands, ResponseMode mode, long timeout, boolean usePriorityQueue, ResponseFilter responseFilter, boolean totalOrder, boolean anycast)
Map<Address,Response>	invokeRemotely(Map<Address,ReplicableCommand> rpcCommands, ResponseMode mode, long timeout, ResponseFilter responseFilter, DeliverOrder deliverOrder, boolean anycast)
CompletableFuture<Map<Address,Response>>	invokeRemotelyAsync(Collection<Address> recipients, ReplicableCommand rpcCommand, ResponseMode mode, long timeout, ResponseFilter responseFilter, DeliverOrder deliverOrder, boolean anycast)
boolean	isCoordinator()
boolean	isMulticastCapable()	Tests whether the transport supports true multicast
void	sendTo(Address destination, ReplicableCommand rpcCommand, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the destination using the specified DeliverOrder.
void	sendToAll(ReplicableCommand rpcCommand, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the entire cluster.
void	sendToMany(Collection<Address> destinations, ReplicableCommand rpcCommand, DeliverOrder deliverOrder)	Asynchronously sends the ReplicableCommand to the set of destination using the specified DeliverOrder.
void	start()	Invoked on component start
void	stop()	Invoked on component stop
void	waitForView(int viewId)
CompletableFuture<Void>	withView(int expectedViewId)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.remoting.transport.Transport

invokeCommandOnAll, invokeCommands

Field Detail

actual

protected final Transport actual

Constructor Detail

AbstractDelegatingTransport

protected AbstractDelegatingTransport(Transport actual)

Method Detail

invokeRemotely

public Map<Address,Response> invokeRemotely(Collection<Address> recipients,
                                                  ReplicableCommand rpcCommand,
                                                  ResponseMode mode,
                                                  long timeout,
                                                  ResponseFilter responseFilter,
                                                  DeliverOrder deliverOrder,
                                                  boolean anycast)
                                           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. implementations.

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

deliverOrder - the DeliverOrder.

anycast - used when {@param totalOrder} is true, it means that it must use TOA instead of TOB.

Returns:

a map of responses from each member contacted.

Throws:

Exception - in the event of problems.

invokeRemotely

public Map<Address,Response> invokeRemotely(Map<Address,ReplicableCommand> rpcCommands,
                                                  ResponseMode mode,
                                                  long timeout,
                                                  boolean usePriorityQueue,
                                                  ResponseFilter responseFilter,
                                                  boolean totalOrder,
                                                  boolean anycast)
                                           throws Exception

Specified by:

invokeRemotely in interface Transport

Throws:

Exception

invokeRemotely

public Map<Address,Response> invokeRemotely(Map<Address,ReplicableCommand> rpcCommands,
                                                  ResponseMode mode,
                                                  long timeout,
                                                  ResponseFilter responseFilter,
                                                  DeliverOrder deliverOrder,
                                                  boolean anycast)
                                           throws Exception

Specified by:

invokeRemotely in interface Transport

Throws:

Exception

invokeRemotelyAsync

public CompletableFuture<Map<Address,Response>> invokeRemotelyAsync(Collection<Address> recipients,
                                                                          ReplicableCommand rpcCommand,
                                                                          ResponseMode mode,
                                                                          long timeout,
                                                                          ResponseFilter responseFilter,
                                                                          DeliverOrder deliverOrder,
                                                                          boolean anycast)
                                                                   throws Exception

Specified by:

invokeRemotelyAsync in interface Transport

Throws:

Exception

sendTo

public void sendTo(Address destination,
                   ReplicableCommand rpcCommand,
                   DeliverOrder deliverOrder)
            throws Exception

Description copied from interface: Transport

Asynchronously sends the ReplicableCommand to the destination using the specified DeliverOrder.

Specified by:

sendTo in interface Transport

Parameters:

destination - the destination's Address.

rpcCommand - the ReplicableCommand to send.

deliverOrder - the DeliverOrder to use.

Throws:

Exception - if there was problem sending the request.

sendToMany

public void sendToMany(Collection<Address> destinations,
                       ReplicableCommand rpcCommand,
                       DeliverOrder deliverOrder)
                throws Exception

Description copied from interface: Transport

Asynchronously sends the ReplicableCommand to the set of destination using the specified DeliverOrder.

Specified by:

sendToMany in interface Transport

Parameters:

destinations - the collection of destination's Address. If null, it sends to all the members in the cluster.

rpcCommand - the ReplicableCommand to send.

deliverOrder - the DeliverOrder to use.

Throws:

Exception - if there was problem sending the request.

sendToAll

public void sendToAll(ReplicableCommand rpcCommand,
                      DeliverOrder deliverOrder)
               throws Exception

Description copied from interface: Transport

Asynchronously sends the ReplicableCommand to the entire cluster.

Specified by:

sendToAll in interface Transport

Throws:

Exception

backupRemotely

public BackupResponse backupRemotely(Collection<XSiteBackup> backups,
                                     XSiteReplicateCommand rpcCommand)
                              throws Exception

Specified by:

backupRemotely in interface Transport

Throws:

Exception

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.

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

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

start

public void start()

Description copied from interface: org.infinispan.commons.api.Lifecycle

Invoked on component start

Specified by:

start in interface org.infinispan.commons.api.Lifecycle

Specified by:

start in interface Transport

stop

public void stop()

Description copied from interface: org.infinispan.commons.api.Lifecycle

Invoked on component stop

Specified by:

stop in interface org.infinispan.commons.api.Lifecycle

Specified by:

stop in interface Transport

getViewId

public int getViewId()

Specified by:

getViewId in interface Transport

withView

public CompletableFuture<Void> withView(int expectedViewId)

Specified by:

withView in interface Transport

Returns:

A CompletableFuture that completes when the transport has installed the expected view.

waitForView

public void waitForView(int viewId)
                 throws InterruptedException

Specified by:

waitForView in interface Transport

Throws:

InterruptedException

checkTotalOrderSupported

public void checkTotalOrderSupported()

Description copied from interface: Transport

check if the transport has configured with total order deliver properties (has the sequencer in JGroups protocol stack.

Specified by:

checkTotalOrderSupported in interface Transport

getLog

public Log getLog()

Specified by:

getLog in interface Transport

getDelegate

public Transport getDelegate()

beforeInvokeRemotely

protected void beforeInvokeRemotely(ReplicableCommand command)

method invoked before a remote invocation.

Parameters:

command - the command to be invoked remotely

afterInvokeRemotely

protected Map<Address,Response> afterInvokeRemotely(ReplicableCommand command,
                                                          Map<Address,Response> responseMap)

method invoked after a successful remote invocation.

Parameters:

command - the command invoked remotely.

responseMap - can be null if not response is expected.

Returns:

the new response map

beforeBackupRemotely

protected void beforeBackupRemotely(XSiteReplicateCommand command)

method invoked before a backup remote invocation.

Parameters:

command - the command to be invoked remotely

afterBackupRemotely

protected BackupResponse afterBackupRemotely(ReplicableCommand command,
                                             BackupResponse response)

method invoked after a successful backup remote invocation.

Parameters:

command - the command invoked remotely.

response - can be null if not response is expected.

Returns:

the new response map

getSitesView

public Set<String> getSitesView()

Description copied from interface: Transport

Get the view of interconnected sites. If no cross site replication has been configured, this method returns null. Inspecting the site view can be useful to see if the different sites have managed to join each other, which is pre-requisite to get cross replication working.

Specified by:

getSitesView in interface Transport

Returns:

set containing the connected sites, or null if no cross site replication has been enabled.

invokeCommand

public <T> CompletionStage<T> invokeCommand(Address target,
                                            ReplicableCommand command,
                                            ResponseCollector<T> collector,
                                            DeliverOrder deliverOrder,
                                            long timeout,
                                            TimeUnit unit)

Description copied from interface: Transport

Invoke a command on a single node and pass the response to a ResponseCollector.

If the target is the local node and the delivery order is not DeliverOrder.TOTAL, the command is never executed, and ResponseCollector.finish() is called directly.

Specified by:

invokeCommand in interface Transport

invokeCommand

public <T> CompletionStage<T> invokeCommand(Collection<Address> targets,
                                            ReplicableCommand command,
                                            ResponseCollector<T> collector,
                                            DeliverOrder deliverOrder,
                                            long timeout,
                                            TimeUnit unit)

Description copied from interface: Transport

Invoke a command on a collection of node and pass the responses to a ResponseCollector.

If one of the targets is the local nodes and the delivery order is not DeliverOrder.TOTAL, the command is only executed on the remote nodes.

Specified by:

invokeCommand in interface Transport

invokeCommandOnAll

public <T> CompletionStage<T> invokeCommandOnAll(ReplicableCommand command,
                                                 ResponseCollector<T> collector,
                                                 DeliverOrder deliverOrder,
                                                 long timeout,
                                                 TimeUnit unit)

Description copied from interface: Transport

Invoke a command on all the nodes in the cluster and pass the responses to a ResponseCollector.

The command is only executed on the local node if the delivery order is DeliverOrder.TOTAL. The command is not sent across RELAY2 bridges to remote sites.

Specified by:

invokeCommandOnAll in interface Transport

invokeCommandStaggered

public <T> CompletionStage<T> invokeCommandStaggered(Collection<Address> targets,
                                                     ReplicableCommand command,
                                                     ResponseCollector<T> collector,
                                                     DeliverOrder deliverOrder,
                                                     long timeout,
                                                     TimeUnit unit)

Description copied from interface: Transport

Invoke a command on a collection of nodes and pass the responses to a ResponseCollector.

The command is only sent immediately to the first target, and there is an implementation-dependent delay before sending the command to each target. There is no delay if the target responds or leaves the cluster. The remaining targets are skipped if ResponseCollector.addResponse(Address, Response) returns a non-null value.

If one of the targets is the local node and the delivery order is not DeliverOrder.TOTAL, the command is only executed on the remote nodes.

Specified by:

invokeCommandStaggered in interface Transport

invokeCommands

public <T> CompletionStage<T> invokeCommands(Collection<Address> targets,
                                             Function<Address,ReplicableCommand> commandGenerator,
                                             ResponseCollector<T> collector,
                                             DeliverOrder deliverOrder,
                                             long timeout,
                                             TimeUnit timeUnit)

Description copied from interface: Transport

Invoke different commands on a collection of nodes and pass the responses to a ResponseCollector.

If one of the targets is the local node and the delivery order is not DeliverOrder.TOTAL, the command is only executed on the remote nodes.

Specified by:

invokeCommands in interface Transport