01: package com.protomatter.syslog;
02:
03: /**
04: * {{{ The Protomatter Software License, Version 1.0
05: * derived from The Apache Software License, Version 1.1
06: *
07: * Copyright (c) 1998-2002 Nate Sammons. All rights reserved.
08: *
09: * Redistribution and use in source and binary forms, with or without
10: * modification, are permitted provided that the following conditions
11: * are met:
12: *
13: * 1. Redistributions of source code must retain the above copyright
14: * notice, this list of conditions and the following disclaimer.
15: *
16: * 2. Redistributions in binary form must reproduce the above copyright
17: * notice, this list of conditions and the following disclaimer in
18: * the documentation and/or other materials provided with the
19: * distribution.
20: *
21: * 3. The end-user documentation included with the redistribution,
22: * if any, must include the following acknowledgment:
23: * "This product includes software developed for the
24: * Protomatter Software Project
25: * (http://protomatter.sourceforge.net/)."
26: * Alternately, this acknowledgment may appear in the software itself,
27: * if and wherever such third-party acknowledgments normally appear.
28: *
29: * 4. The names "Protomatter" and "Protomatter Software Project" must
30: * not be used to endorse or promote products derived from this
31: * software without prior written permission. For written
32: * permission, please contact support@protomatter.com.
33: *
34: * 5. Products derived from this software may not be called "Protomatter",
35: * nor may "Protomatter" appear in their name, without prior written
36: * permission of the Protomatter Software Project
37: * (support@protomatter.com).
38: *
39: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
40: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
42: * DISCLAIMED. IN NO EVENT SHALL THE PROTOMATTER SOFTWARE PROJECT OR
43: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
46: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
47: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
49: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50: * SUCH DAMAGE. }}}
51: */
52:
53: import java.net.*;
54: import java.util.*;
55:
56: /**
57: * An interface for objects that are aware of channels in
58: * syslog. <P>
59: *
60: * Why is this a good thing? The idea here is that in
61: * some baseclass for things that do logging, you implement
62: * this interface and then everytime you pass <tt>this</tt>
63: * into a syslog method, you magically get messages sent to
64: * the "right" channels for the circumstances. For instance,
65: * you might have multiple projects being hosted on the same
66: * VM, and you don't want to have to hardcode in channel
67: * names everywhere. You can just have the baseclass read
68: * a configuration file or something, and everyone is happy.
69: * Later, when you decide to have things go to other channels,
70: * or want certain object to write to your own channels, you just
71: * override the implementation of <tt>getSyslogChannel()</tt>
72: * and everyone is still happy.
73: */
74: public interface SyslogChannelAware {
75: /**
76: * This method should return the channel that messages
77: * coming from this object should be logged to if the
78: * call to Syslog didn't include a channel (or the channel
79: * specified was <tt>null</tt>). If an
80: * object implementing this interface is passed into
81: * a Syslog method as the logger (the first argument to
82: * any of the log methods) and a channel was not specified
83: * as part of the call to that log method, this method
84: * will be called to determine what channel(s) the message
85: * should be sent to. This method <b>must</b> return
86: * either an instance of <tt>java.lang.String</tt> or
87: * an array of <tt>java.lang.String</tt> if the message
88: * should be sent to multiple channels. If there is an
89: * error calling this method or something goes wrong,
90: * the channel will be set to <tt>Syslog.DEFAULT_CHANNEL</tt>.
91: */
92: public Object getSyslogChannel();
93: }
|