/*************************************************************************
 * 
 * ADOBE CONFIDENTIAL __________________
 * 
 * [2002] - [2007] Adobe Systems Incorporated All Rights Reserved.
 * 
 * NOTICE: All information contained herein is, and remains the property of Adobe Systems Incorporated and its suppliers, if any. The intellectual and technical concepts contained herein are
 * proprietary to Adobe Systems Incorporated and its suppliers and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of
 * this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Adobe Systems Incorporated.
 **************************************************************************/
package flex.messaging.cluster;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import flex.messaging.log.LogCategories;

/**
 * @exclude Base interface for cluster implementations.
 * 
 * @author neville
 */
public abstract class Cluster
{
    public static final String LOG_CATEGORY = LogCategories.SERVICE_CLUSTER;

    List removeNodeListeners = Collections.synchronizedList(new ArrayList());

    /* Are we the default cluster? */
    boolean def;

    boolean urlLoadBalancing;

    /**
     * Because destinations are the constructs which become clustered, clusters are identified by a unique name composed in the format "serviceType:destinationId".
     */
    static String getClusterDestinationKey(String serviceType, String destinationName)
    {
        StringBuffer sb = new StringBuffer();
        sb.append(serviceType);
        sb.append(":");
        sb.append(destinationName);
        return sb.toString();
    }

    public void addRemoveNodeListener(RemoveNodeListener listener)
    {
        removeNodeListeners.add(listener);
    }

    protected void sendRemoveNodeListener(Object address)
    {
        synchronized (removeNodeListeners)
        {
            for (int i = 0; i < removeNodeListeners.size(); i++)
                ((RemoveNodeListener) removeNodeListeners.get(i)).removeClusterNode(address);
        }
    }

    /**
     * Returns true if this is the default cluster for any destination that does not specify a clustered destination.
     */
    public boolean isDefault()
    {
        return def;
    }

    public void setDefault(boolean d)
    {
        this.def = d;
    }

    public boolean getURLLoadBalancing()
    {
        return urlLoadBalancing;
    }

    public void setURLLoadBalancing(boolean u)
    {
        urlLoadBalancing = u;
    }

    /**
     * Shutdown the cluster.
     */
    public abstract void destroy();

    /**
     * Retrieve a List of Maps, where each Map contains channel id keys mapped to endpoint URLs for the given service type and destination name. There is exactly one endpoint URL for each channel id.
     * This List represents all of the known endpoint URLs for all of the channels in the Cluster.
     * 
     * @return List of maps of channel ids to endpoint URLs for each node in the cluster.
     */
    public abstract List getAllEndpoints(String serviceType, String destName);

    public abstract List getMemberAddresses();

    public abstract Object getLocalAddress();

    /**
     * Broadcast a service-related operation, which usually includes a Message as a method parameter. This method allows a local service to process a Message and then send the Message to the services
     * on all peer nodes so that they may perform the same processing.
     * 
     * @param serviceOperation
     *            The operation to broadcast.
     * @param params
     *            Parameters for the operation.
     */
    public abstract void broadcastServiceOperation(String serviceOperation, Object[] params);

    /**
     * Send a service-related operation in point-to-point fashion to one and only one member of the cluster. This is similar to the broadcastServiceOperation except that this invocation is sent to the
     * first node among the cluster members that does not have the local node's address.
     * 
     * @param serviceOperation
     *            The operation to send.
     * @param params
     *            Parameters for the operation.
     * @param targetAddress
     */
    public abstract void sendPointToPointServiceOperation(String serviceOperation, Object[] params, Object targetAddress);

    /**
     * Add a local endpoint URL for a local channel. After doing so, broadcast the information to peers so that they will be aware of the URL.
     */
    public abstract void addLocalEndpointForChannel(String serviceType, String destName, String channelId, String endpointUrl, int endpointPort);
}