org.apache.catalina.ha.CatalinaCluster Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.ha;
import java.util.Map;
import org.apache.catalina.Cluster;
import org.apache.catalina.Manager;
import org.apache.catalina.Valve;
import org.apache.catalina.tribes.Channel;
import org.apache.catalina.tribes.Member;
/**
* A CatalinaCluster interface allows to plug in and out the different cluster implementations
*/
public interface CatalinaCluster extends Cluster {
/**
* Sends a message to all the members in the cluster
*
* @param msg ClusterMessage
*/
void send(ClusterMessage msg);
/**
* Sends a message to a specific member in the cluster.
*
* @param msg ClusterMessage
* @param dest Member
*/
void send(ClusterMessage msg, Member dest);
/**
* Sends a message with the specified sendOptions to a specific member in the cluster.
*
* @param msg ClusterMessage
* @param dest Member
* @param sendOptions sendOptions
*/
void send(ClusterMessage msg, Member dest, int sendOptions);
/**
* @return true if the cluster has members.
*/
boolean hasMembers();
/**
* @return an array containing all the members currently participating in the cluster.
*/
Member[] getMembers();
/**
* @return the member that represents this node.
*/
Member getLocalMember();
/**
* Add cluster valve. Cluster Valves are only add to container when cluster is started.
*
* @param valve The new cluster Valve.
*/
void addValve(Valve valve);
/**
* Add cluster message listener and register cluster to this listener.
*
* @param listener The new listener
*/
void addClusterListener(ClusterListener listener);
/**
* Remove message listener and deregister Cluster from listener.
*
* @param listener The listener to remove
*/
void removeClusterListener(ClusterListener listener);
/**
* Set a new Deployer, must be set before the cluster started.
*
* @param deployer The associated deployer
*/
void setClusterDeployer(ClusterDeployer deployer);
/**
* @return the current Deployer
*/
ClusterDeployer getClusterDeployer();
/**
* @return The map of managers
*/
Map getManagers();
/**
* Get Manager
*
* @param name The manager name
*
* @return The manager
*/
Manager getManager(String name);
/**
* Get a new cluster name for a manager.
*
* @param name Override name (optional)
* @param manager The manager
*
* @return the manager name in the cluster
*/
String getManagerName(String name, Manager manager);
/**
* @return the current cluster valves
*/
Valve[] getValves();
/**
* Set the channel associated with the cluster.
*
* @param channel the channel
*/
void setChannel(Channel channel);
/**
* @return the channel associated with the cluster
*/
Channel getChannel();
}