org.jboss.ejb.client.ClusterNodeSelector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.ejb.client;

/**
 * A selector which selects and returns a node from the available nodes in a cluster. The {@link EJBReceiver}
 * corresponding to the selected node will then be used to forward the invocations on a EJB. Typical usage of a
 * {@link ClusterNodeSelector} involve load balancing of calls to various nodes in the cluster
 *
 * @author Jaikiran Pai
 */
public interface ClusterNodeSelector {

    /**
     * Returns a node from among the totalAvailableNodes, as the target node for EJB invocations.
     * The selector can decide whether to pick an already connected node (from the passed connectedNodes)
     * or decide to select a node to which a connection hasn't yet been established. If a node to which a connection
     * hasn't been established, is selected then the cluster context will create a connection to it before letting
     * the corresponding {@link EJBReceiver} to handle the EJB invocation.
     *
     * @param clusterName         The name of the cluster to which the nodes belong
     * @param connectedNodes      The cluster context auto-connects to only a maximum allowed limit of nodes. This
     *                            connectedNodes array contains the node names to which a connection has
     *                            been established. This can be an empty array but will not be null.
     * @param totalAvailableNodes Total available nodes in the cluster. This even includes the connected nodes.
     *                            This array will neither be empty nor null.
     * @return
     */
    String selectNode(final String clusterName, final String[] connectedNodes, final String[] totalAvailableNodes);
}