01: /* ====================================================================
02: * The Apache Software License, Version 1.1
03: *
04: * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
05: * reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions
09: * are met:
10: *
11: * 1. Redistributions of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: *
14: * 2. Redistributions in binary form must reproduce the above copyright
15: * notice, this list of conditions and the following disclaimer in
16: * the documentation and/or other materials provided with the
17: * distribution.
18: *
19: * 3. The end-user documentation included with the redistribution,
20: * if any, must include the following acknowledgment:
21: * "This product includes software developed by the
22: * Apache Software Foundation (http://www.apache.org/)."
23: * Alternately, this acknowledgment may appear in the software
24: * itself, if and wherever such third-party acknowledgments
25: * normally appear.
26: *
27: * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
28: * must not be used to endorse or promote products derived from this
29: * software without prior written permission. For written
30: * permission, please contact apache@apache.org.
31: *
32: * 5. Products derived from this software may not be called "Apache",
33: * nor may "Apache" appear in their name, without prior written
34: * permission of the Apache Software Foundation.
35: *
36: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47: * SUCH DAMAGE.
48: * ====================================================================
49: *
50: * This software consists of voluntary contributions made by many
51: * individuals on behalf of the Apache Software Foundation. For more
52: * information on the Apache Software Foundation, please see
53: * <http://www.apache.org/>.
54: */
55: package org.apache.log.output.jms;
56:
57: import javax.jms.JMSException;
58: import javax.jms.Message;
59: import javax.jms.Session;
60: import org.apache.log.LogEvent;
61:
62: /**
63: * Interface that classes implement to build JMS Messages.
64: *
65: * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
66: * @author <a href="mailto:peter@apache.org">Peter Donald</a>
67: */
68: public interface MessageBuilder {
69:
70: /**
71: * Creation of a new message.
72: * @param session the session against which the message will be created
73: * @param event the log event
74: * @return the message
75: * @exception JMSException if a messaging error occurs
76: */
77: Message buildMessage(Session session, LogEvent event)
78: throws JMSException;
79: }
|