init

java/org/apache/catalina/tribes/MembershipService.java

@@ -0,0 +1,159 @@
+/*
+ * 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.tribes;
+
+
+/**
+ * MembershipService Interface<br>
+ * The <code>MembershipService</code> interface is the membership component
+ * at the bottom layer, the IO layer (for layers see the javadoc for the {@link Channel} interface).<br>
+ */
+public interface MembershipService {
+
+    public static final int MBR_RX = Channel.MBR_RX_SEQ;
+    public static final int MBR_TX = Channel.MBR_TX_SEQ;
+
+    /**
+     * Sets the properties for the membership service. This must be called before
+     * the <code>start()</code> method is called.
+     * The properties are implementation specific.
+     * @param properties - to be used to configure the membership service.
+     */
+    public void setProperties(java.util.Properties properties);
+
+    /**
+     * @return the properties for the configuration used.
+     */
+    public java.util.Properties getProperties();
+
+    /**
+     * Starts the membership service. If a membership listeners is added
+     * the listener will start to receive membership events.
+     * Performs a start level 1 and 2
+     * @throws java.lang.Exception if the service fails to start.
+     */
+    public void start() throws java.lang.Exception;
+
+    /**
+     * Starts the membership service. If a membership listeners is added
+     * the listener will start to receive membership events.
+     * @param level - level MBR_RX starts listening for members, level MBR_TX
+     * starts broad casting the server
+     * @throws java.lang.Exception if the service fails to start.
+     * @throws java.lang.IllegalArgumentException if the level is incorrect.
+     */
+    public void start(int level) throws java.lang.Exception;
+
+
+    /**
+     * Starts the membership service. If a membership listeners is added
+     * the listener will start to receive membership events.
+     * @param level - level MBR_RX stops listening for members, level MBR_TX
+     * stops broad casting the server
+     * @throws java.lang.IllegalArgumentException if the level is incorrect.
+     */
+    public void stop(int level);
+
+    /**
+     * @return true if the the group contains members
+     */
+    public boolean hasMembers();
+
+    /**
+     * Retrieve the specified member from the membership.
+     * @param mbr The member to retrieve
+     * @return the member
+     */
+    public Member getMember(Member mbr);
+
+    /**
+     * @return a list of all the members in the cluster.
+     */
+    public Member[] getMembers();
+
+    /**
+     * Get the local member.
+     * @return the member object that defines this member
+     * @param incAliveTime <code>true</code> to set the alive time
+     *  on the local member
+     */
+    public Member getLocalMember(boolean incAliveTime);
+
+    /**
+     * @return all members by name
+     */
+    public String[] getMembersByName();
+
+    /**
+     * Get a member.
+     * @param name The member name
+     * @return the member
+     */
+    public Member findMemberByName(String name);
+
+    /**
+     * Sets the local member properties for broadcasting.
+     *
+     * @param listenHost Listen to host
+     * @param listenPort Listen to port
+     * @param securePort Use a secure port
+     * @param udpPort Use UDP
+     */
+    public void setLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort);
+
+    /**
+     * Sets the membership listener, only one listener can be added.
+     * If you call this method twice, the last listener will be used.
+     * @param listener The listener
+     */
+    public void setMembershipListener(MembershipListener listener);
+
+    /**
+     * Removes the membership listener.
+     */
+    public void removeMembershipListener();
+
+    /**
+     * Set a payload to be broadcasted with each membership
+     * broadcast.
+     * @param payload byte[]
+     */
+    public void setPayload(byte[] payload);
+
+    public void setDomain(byte[] domain);
+
+    /**
+     * Broadcasts a message to all members.
+     * @param message The message to broadcast
+     * @throws ChannelException Message broadcast failed
+     */
+    public void broadcast(ChannelMessage message) throws ChannelException;
+
+    /**
+     * Return the channel that is related to this MembershipService
+     * @return Channel
+     */
+    public Channel getChannel();
+
+    /**
+     * Set the channel that is related to this MembershipService
+     * @param channel The channel
+     */
+    public void setChannel(Channel channel);
+
+}