Package org.infinispan.remoting.transport.jgroups

Class JGroupsTransport

  • All Implemented Interfaces:
    Lifecycle, Transport
    public class JGroupsTransport
extends java.lang.Object
implements Transport
    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 TransportConfigurationBuilder.withProperties(Properties) or in the Infinispan XML configuration file.
    Since:
    4.0
    Author:
    Manik Surtani, Galder Zamarreño

    • Field Detail

      • CONFIGURATION_STRING

        public static final java.lang.String CONFIGURATION_STRING
        See Also:
        Constant Field Values

      • CONFIGURATION_XML

        public static final java.lang.String CONFIGURATION_XML
        See Also:
        Constant Field Values

      • CONFIGURATION_FILE

        public static final java.lang.String CONFIGURATION_FILE
        See Also:
        Constant Field Values

      • CHANNEL_CONFIGURATOR

        public static final java.lang.String CHANNEL_CONFIGURATOR
        See Also:
        Constant Field Values

      • REPLY_FLAGS

        public static final short REPLY_FLAGS

      • DEFAULT_JGROUPS_CONFIGURATION_FILE

        protected static final java.lang.String DEFAULT_JGROUPS_CONFIGURATION_FILE
        See Also:
        Constant Field Values

      • log

        public static final org.infinispan.util.logging.Log log

      • timeoutExecutor

        protected java.util.concurrent.ScheduledExecutorService timeoutExecutor

      • remoteExecutor

        protected java.util.concurrent.ExecutorService remoteExecutor

      • connectChannel

        protected boolean connectChannel

      • disconnectChannel

        protected boolean disconnectChannel

      • closeChannel

        protected boolean closeChannel

      • channel

        protected org.jgroups.JChannel channel

      • address

        protected Address address

      • physicalAddress

        protected Address physicalAddress

      • clusterView

        protected volatile ClusterView clusterView

    • Constructor Detail

      • JGroupsTransport

        public JGroupsTransport​(org.jgroups.JChannel 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

      • sendTo

        public void sendTo​(Address destination,
                   org.infinispan.commands.ReplicableCommand command,
                   DeliverOrder deliverOrder)
        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.
        command - the ReplicableCommand to send.
        deliverOrder - the DeliverOrder to use.

      • sendToMany

        public void sendToMany​(java.util.Collection<Address> targets,
                       org.infinispan.commands.ReplicableCommand command,
                       DeliverOrder deliverOrder)
        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:
        targets - the collection of destination's Address. If null, it sends to all the members in the cluster.
        command - the ReplicableCommand to send.
        deliverOrder - the DeliverOrder to use.

      • backupRemotely

        public XSiteResponse backupRemotely​(XSiteBackup backup,
                                    XSiteReplicateCommand rpcCommand)
        Description copied from interface: Transport
        Sends a cross-site request to a remote site.

        Currently, no reply values are supported. Or the request completes successfully or it throws an Exception.

        If XSiteBackup.isSync() returns false, the XSiteResponse is only completed when the an ACK from the remote site is received. The invoker needs to make sure not to wait for the XSiteResponse.

        Specified by:
        backupRemotely in interface Transport
        Parameters:
        backup - The remote site.
        rpcCommand - The command to send.
        Returns:
        A XSiteResponse that is completed when the request is completed.

      • 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 java.util.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 java.util.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.

      • getMembersPhysicalAddresses

        public java.util.List<Address> getMembersPhysicalAddresses()
        Description copied from interface: Transport
        Returns physical addresses of members in the current cluster view.
        Specified by:
        getMembersPhysicalAddresses in interface Transport
        Returns:
        a list of physical addresses

      • 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: Lifecycle
        Invoked on component start
        Specified by:
        start in interface Lifecycle
        Specified by:
        start in interface Transport

      • initChannel

        protected void initChannel()

      • startJGroupsChannelIfNeeded

        protected void startJGroupsChannelIfNeeded()
        When overwriting this method, it allows third-party libraries to create a new behavior like: After JChannel has been created and before it is connected.

      • receiveClusterView

        protected void receiveClusterView​(org.jgroups.View newView)

      • stop

        public void stop()
        Description copied from interface: Lifecycle
        Invoked on component stop
        Specified by:
        stop in interface Lifecycle
        Specified by:
        stop in interface Transport

      • withView

        public java.util.concurrent.CompletableFuture<java.lang.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 java.lang.InterruptedException
        Specified by:
        waitForView in interface Transport
        Throws:
        java.lang.InterruptedException

      • getLog

        public org.infinispan.util.logging.Log getLog()
        Specified by:
        getLog in interface Transport

      • checkTotalOrderSupported

        public final 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

      • getSitesView

        public java.util.Set<java.lang.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> java.util.concurrent.CompletionStage<T> invokeCommand​(java.util.Collection<Address> targets,
                                                                 org.infinispan.commands.ReplicableCommand command,
                                                                 ResponseCollector<T> collector,
                                                                 DeliverOrder deliverOrder,
                                                                 long timeout,
                                                                 java.util.concurrent.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> java.util.concurrent.CompletionStage<T> invokeCommandOnAll​(org.infinispan.commands.ReplicableCommand command,
                                                                      ResponseCollector<T> collector,
                                                                      DeliverOrder deliverOrder,
                                                                      long timeout,
                                                                      java.util.concurrent.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

      • invokeCommandOnAll

        public <T> java.util.concurrent.CompletionStage<T> invokeCommandOnAll​(java.util.Collection<Address> requiredTargets,
                                                                      org.infinispan.commands.ReplicableCommand command,
                                                                      ResponseCollector<T> collector,
                                                                      DeliverOrder deliverOrder,
                                                                      long timeout,
                                                                      java.util.concurrent.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> java.util.concurrent.CompletionStage<T> invokeCommandStaggered​(java.util.Collection<Address> targets,
                                                                          org.infinispan.commands.ReplicableCommand command,
                                                                          ResponseCollector<T> collector,
                                                                          DeliverOrder deliverOrder,
                                                                          long timeout,
                                                                          java.util.concurrent.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> java.util.concurrent.CompletionStage<T> invokeCommands​(java.util.Collection<Address> targets,
                                                                  java.util.function.Function<Address,​org.infinispan.commands.ReplicableCommand> commandGenerator,
                                                                  ResponseCollector<T> collector,
                                                                  DeliverOrder deliverOrder,
                                                                  long timeout,
                                                                  java.util.concurrent.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

      • sendToAll

        public void sendToAll​(org.infinispan.commands.ReplicableCommand command,
                      DeliverOrder deliverOrder)
        Description copied from interface: Transport
        Asynchronously sends the ReplicableCommand to the entire cluster.
        Specified by:
        sendToAll in interface Transport

      • getChannel

        public org.jgroups.JChannel getChannel()