001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/cluster/ClusterSessionBase.java,v 1.3 2001/07/22 20:25:06 pier Exp $
003: * $Revision: 1.3 $
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: import org.apache.catalina.util.StringManager;
068:
069: /**
070: * This is an abstract implementation of <code>ClusterSender</code>
071: * and <code>ClusterReceiver</code> which provide basic functionallity
072: * shared by the two components.
073: *
074: * @author Bip Thelin
075: * @version $Revision: 1.3 $, $Date: 2001/07/22 20:25:06 $
076: */
077:
078: public abstract class ClusterSessionBase {
079:
080: // ----------------------------------------------------- Instance Variables
081:
082: /**
083: * The senderId associated with this component
084: */
085: private String senderId = null;
086:
087: /**
088: * The debug level for this component
089: */
090: private int debug = 0;
091:
092: /**
093: * The Logger associated with this component.
094: */
095: private Logger logger = null;
096:
097: /**
098: * The string manager for this package.
099: */
100: protected StringManager sm = StringManager
101: .getManager(Constants.Package);
102:
103: // --------------------------------------------------------- Public Methods
104:
105: /**
106: * The senderId is a identifier used to identify different
107: * packagesin a Cluster. Each package received or send through
108: * the concrete implementation of this interface will have
109: * the senderId set at runtime. Usually the senderId is the
110: * name of the component that is using this component.
111: *
112: * @param senderId The senderId to use
113: */
114: public void setSenderId(String senderId) {
115: this .senderId = senderId;
116: }
117:
118: /**
119: * get the senderId used to identify messages being
120: * send or received in a Cluster.
121: *
122: * @return The senderId for this component
123: */
124: public String getSenderId() {
125: return (this .senderId);
126: }
127:
128: /**
129: * Set the debug detail level for this component.
130: *
131: * @param debug The debug level
132: */
133: public void setDebug(int debug) {
134: this .debug = debug;
135: }
136:
137: /**
138: * Get the debug level for this component
139: *
140: * @return The debug level
141: */
142: public int getDebug() {
143: return (this .debug);
144: }
145:
146: /**
147: * Set the Logger for this component.
148: *
149: * @param debug The Logger to use with this component.
150: */
151: public void setLogger(Logger logger) {
152: this .logger = logger;
153: }
154:
155: /**
156: * Get the Logger for this component
157: *
158: * @return The Logger associated with this component.
159: */
160: public Logger getLogger() {
161: return (this .logger);
162: }
163:
164: public abstract String getName();
165:
166: /**
167: * The log method to use in the implementation
168: *
169: * @param message The message to be logged.
170: */
171: public void log(String message) {
172: Logger logger = getLogger();
173:
174: if (logger != null)
175: logger.log("[Cluster/" + getName() + "]: " + message);
176: else
177: System.out.println("[Cluster/" + getName() + "]: "
178: + message);
179: }
180: }
|