org.fabric3.spi.federation.ZoneTopologyService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation
SPIs for runtime extensions
There is a newer version: 2.0.1
/*
 * Fabric3
 * Copyright (c) 2009-2011 Metaform Systems
 *
 * Fabric3 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version, with the
 * following exception:
 *
 * Linking this software statically or dynamically with other
 * modules is making a combined work based on this software.
 * Thus, the terms and conditions of the GNU General Public
 * License cover the whole combination.
 *
 * As a special exception, the copyright holders of this software
 * give you permission to link this software with independent
 * modules to produce an executable, regardless of the license
 * terms of these independent modules, and to copy and distribute
 * the resulting executable under terms of your choice, provided
 * that you also meet, for each linked independent module, the
 * terms and conditions of the license of that module. An
 * independent module is a module which is not derived from or
 * based on this software. If you modify this software, you may
 * extend this exception to your version of the software, but
 * you are not obligated to do so. If you do not wish to do so,
 * delete this exception statement from your version.
 *
 * Fabric3 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 General Public License for more details.
 *
 * You should have received a copy of the
 * GNU General Public License along with Fabric3.
 * If not, see .
*/
package org.fabric3.spi.federation;

import java.io.Serializable;
import java.util.List;

import org.fabric3.spi.command.Command;
import org.fabric3.spi.command.Response;
import org.fabric3.spi.command.ResponseCommand;

/**
 * Responsible for group communications within a domain zone. This service is present only on participant runtimes in a federated topology and
 * provides low-level communications between a participant and other runtimes (a participant or controller). Higher-level communications semantics
 * such as deployment can be layered over this service.
 *
 * @version $Rev: 9960 $ $Date: 2011-02-08 13:21:22 +0000 (Tue, 08 Feb 2011) $
 */
public interface ZoneTopologyService {

    /**
     * Returns true if the current runtime is the zone leader.
     *
     * @return true if the current runtime is the zone leader
     */
    boolean isZoneLeader();

    /**
     * Returns true if the group communications infrastructure supports creation of channels using {@link #openChannel(String, String,
     * MessageReceiver)}.
     *
     * @return true if the group communications infrastructure supports creation of channels
     */
    boolean supportsDynamicChannels();

    /**
     * Registers a transient {@link TopologyListener}.
     *
     * @param listener the listener
     */
    void register(TopologyListener listener);

    /**
     * De-registers a transient {@link TopologyListener}.
     *
     * @param listener the listener
     */
    void deregister(TopologyListener listener);

    /**
     * Registers runtime metadata that is propagated to the controller.
     *
     * @param key      the metadata key
     * @param metadata the metadata
     */
    void registerMetadata(String key, Serializable metadata);

    /**
     * Returns true if the domain controller is available.
     *
     * @return true if the domain controller is available
     */
    boolean isControllerAvailable();

    /**
     * Returns the name of the zone leader.
     *
     * @return the name of the zone leader or null if the current runtime has not joined the domain
     */
    String getZoneLeaderName();

    /**
     * Sends a command asynchronously to all runtimes in the zone.
     *
     * @param command the command
     * @throws MessageException if an error occurs sending the message
     */
    void broadcast(Command command) throws MessageException;

    /**
     * Sends a command asynchronously to a runtime.
     *
     * @param runtimeName the runtime
     * @param command     the command
     * @throws MessageException if an error occurs sending the message
     */
    void sendAsynchronous(String runtimeName, Command command) throws MessageException;

    /**
     * Sends a command synchronously to a runtime.
     *
     * @param runtimeName the runtime
     * @param command     the command
     * @param timeout     the time to wait on a response
     * @return the response
     * @throws MessageException if an error occurs sending the message
     */
    Response sendSynchronous(String runtimeName, ResponseCommand command, long timeout) throws MessageException;

    /**
     * Sends a command synchronously to all runtimes in the zone.
     *
     * @param command the command
     * @param timeout the timeout to wait for responses
     * @return the responses
     * @throws MessageException if an error occurs sending the message
     */
    List sendSynchronous(ResponseCommand command, long timeout) throws MessageException;

    /**
     * Sends a command synchronously to the controller.
     *
     * @param command the command
     * @param timeout the time to wait on a response
     * @return the response
     * @throws MessageException if an error occurs sending the message. {@link ControllerNotFoundException} wil be thrown if a controller
     */
    Response sendSynchronousToController(ResponseCommand command, long timeout) throws MessageException;

    /**
     * Sends a command asynchronously to the controller.
     *
     * @param command the command
     * @throws MessageException if an error occurs sending the message
     */
    void sendAsynchronousToController(Command command) throws MessageException;

    /**
     * Opens a channel.
     *
     * @param name          the channel name
     * @param configuration the channel configuration or null to use the default configuration
     * @param receiver      the receiver to callback when a message is received
     * @throws ZoneChannelException if an error occurs opening the channel
     */
    void openChannel(String name, String configuration, MessageReceiver receiver) throws ZoneChannelException;

    /**
     * Closes a channel.
     *
     * @param name the channel name
     * @throws ZoneChannelException if an error occurs closing the channel
     */
    void closeChannel(String name) throws ZoneChannelException;

    /**
     * Asynchronously sends a message over the given channel.
     *
     * @param name    the channel name
     * @param message the message
     * @throws MessageException if there is an error sending the message
     */
    void sendAsynchronous(String name, Serializable message) throws MessageException;

}