001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/cluster/ClusterSender.java,v 1.2 2001/07/22 20:25:06 pier Exp $
003: * $Revision: 1.2 $
004: * $Date: 2001/07/22 20:25:06 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina.cluster;
065:
066: import org.apache.catalina.Logger;
067:
068: /**
069: * This class is responsible for sending outgoing packets to a Cluster.
070: * Different Implementations may use different protocol to
071: * communicate within the Cluster.
072: *
073: * @author Bip Thelin
074: * @version $Revision: 1.2 $, $Date: 2001/07/22 20:25:06 $
075: */
076:
077: public interface ClusterSender {
078:
079: // --------------------------------------------------------- Public Methods
080:
081: /**
082: * The senderId is a identifier used to identify different
083: * packages being sent in a Cluster. Each package sent through
084: * the concrete implementation of this interface will have
085: * the senderId set at runtime. Usually the senderId is the
086: * name of the component that is using this <code>ClusterSender</code>
087: *
088: * @param senderId The senderId to use
089: */
090: public void setSenderId(String senderId);
091:
092: /**
093: * get the senderId used to identify messages being sent in a Cluster.
094: *
095: * @return The senderId for this ClusterSender
096: */
097: public String getSenderId();
098:
099: /**
100: * Set the debug detail level for this component.
101: *
102: * @param debug The debug level
103: */
104: public void setDebug(int debug);
105:
106: /**
107: * Get the debug level for this component
108: *
109: * @return The debug level
110: */
111: public int getDebug();
112:
113: /**
114: * Set the Logger for this component.
115: *
116: * @param debug The Logger to use with this component.
117: */
118: public void setLogger(Logger logger);
119:
120: /**
121: * Get the Logger for this component
122: *
123: * @return The Logger associated with this component.
124: */
125: public Logger getLogger();
126:
127: /**
128: * The log method to use in the implementation
129: *
130: * @param message The message to be logged.
131: */
132: public void log(String message);
133:
134: /**
135: * Send an array of bytes, the implementation of this
136: * <code>ClusterSender</code> is responsible for modifying
137: * the bytearray to something that it can use. Before anything
138: * is sent it is transformed into a ReplicationWrapper object
139: * and the right senderId is set.
140: *
141: * @param b the bytearray to send
142: */
143: public void send(byte[] b);
144:
145: /**
146: * Send an object, the implementation of this
147: * <code>ClusterSender</code> is responsible for modifying
148: * the Object to something that it can use. Before anything
149: * is sent it is transformed into a ReplicationWrapper object
150: * and the right senderId is set.
151: *
152: * @param o The object to send
153: */
154: public void send(Object o);
155: }
|