KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > services > message > MessageSender


1 /*
2  * Copyright (c) 2001-2004 Caucho Technology, Inc. All rights reserved.
3  *
4  * The Apache Software License, Version 1.1
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution, if
19  * any, must include the following acknowlegement:
20  * "This product includes software developed by the
21  * Caucho Technology (http://www.caucho.com/)."
22  * Alternately, this acknowlegement may appear in the software itself,
23  * if and wherever such third-party acknowlegements normally appear.
24  *
25  * 4. The names "Burlap", "Hessian", "Resin", and "Caucho" must not be
26  * used to endorse or promote products derived from this software
27  * without prior written permission. For written permission, please contact
28  * info@caucho.com.
29  *
30  * 5. Products derived from this software may not be called "Resin"
31  * nor may "Resin" appear in their names without prior written
32  * permission of Caucho Technology.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37  * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
38  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
39  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
40  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
41  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
42  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
44  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  * @author Scott Ferguson
47  */
48
49 package com.caucho.services.message;
50
51 import java.util.HashMap JavaDoc;
52
53 /**
54  * Service API for a bare-bones message server.
55  *
56  * <p>A minimal message server only needs to implement the MessageSender
57  * interface. Keeping the server API simple makes it easier for
58  * implementations to start up message servers.
59  *
60  * <p>The MessageSender service is queue or topic specific. So there's no
61  * need for a <b>To</b> header if there's no routing involved.
62  * In other words, the service URL generally includes the queue
63  * or topic identifier, e.g.
64  *
65  * <pre>
66  * http://www.caucho.com/hessian/hessian/message?ejbid=topic-a
67  * <pre>
68  *
69  * <p>More complicated messaging topologies, including configurations
70  * with routing mesaging servers, will use the headers to define the
71  * final destination. The headers have the same functional purpose as
72  * RFC-822 mail headers.
73  */
74 public interface MessageSender {
75   /**
76    * Send a message to the server.
77    *
78    * @param headers any message headers
79    * @param message the message data
80    *
81    * @exception MessageServiceException if the message cannot be delivered
82    */
83   public void send(HashMap JavaDoc headers, Object JavaDoc message)
84     throws MessageServiceException;
85 }
86
Popular Tags