KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > xml > SaxPortlet


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * 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 itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" and
27  * "Apache Jetspeed" must not be used to endorse or promote products
28  * derived from this software without prior written permission. For
29  * written permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache" or
32  * "Apache Jetspeed", nor may "Apache" appear in their name, without
33  * prior written permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */
54
55 package org.apache.jetspeed.portlet.xml;
56
57 import org.apache.jetspeed.portlet.Portlet;
58 import org.apache.jetspeed.portlet.PortletRequest;
59 import org.apache.jetspeed.portlet.PortletResponse;
60 import org.apache.jetspeed.portlet.PortletException;
61
62 import java.io.IOException JavaDoc;
63
64 /**
65  ** The <CODE>SaxPortlet</CODE> is an abstract implementation of the
66  ** <CODE>Portlet</CODE> that enables the use of SAX events to be sent
67  ** as the response.
68  **
69  ** @see SaxPortletRequest
70  ** @see SaxPortletResponse
71  **
72  ** @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
73  **/
74
75 public abstract class SaxPortlet implements Portlet
76 {
77     public final void service (PortletRequest request,
78                                PortletResponse response) throws PortletException,
79                                                                 IOException JavaDoc
80     {
81         if (response instanceof SaxPortletResponse)
82         {
83             service ((SaxPortletRequest) request,
84                      (SaxPortletResponse) response);
85         }
86         else
87         {
88             // default implementation goes here
89 }
90     }
91
92     /**
93      ** This portlet maps the original <CODE>service()</CODE> call to this
94      ** method. With the derived response, the two SAX handlers are
95      ** accessible for sending SAX events as the response.
96      **
97      ** @param request
98      ** the stream portlet request
99      ** @param response
100      ** the stream portlet response
101      **/
102
103     public abstract void service (SaxPortletRequest request,
104                                   SaxPortletResponse response) throws PortletException,
105                                                                          IOException JavaDoc;
106 }
107
108
Popular Tags