PortletResponse


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;
56  
57  import java.io.PrintWriter  ;
58  import java.io.IOException  ;
59  
60  import org.apache.jetspeed.portlet.event.ActionListener;
61  
62  /**
63   ** The <CODE>PortletResponse</CODE> interface represents the response
64   ** sent to the client device.
65   **
66   ** <P>
67   ** It is up to the portlet container to enhance, extend, or modify
68   ** the response as required before it is actually sent to the client
69   ** device.
70   **
71   ** @see   PortletRequest
72   **
73   ** @author   <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
74   **/
75  
76  public interface PortletResponse
77  {
78      /**
79       * Returns the writer object that can be used to contribute
80       * markup to the portlet response.
81       * 
82       * <P>
83       * It is important to note that the markup generated by the
84       * portlet is either a full document or just a fragment of the
85       * markup. A corresponding setting in the deployment descriptor
86       * has to be made.
87       * </P>
88       * 
89       * @return the print writer
90       * @exception IOException
91       *                   if the I/O operation fails
92       */
93      public PrintWriter   getWriter () throws IOException  ;
94  
95      /**
96       * Creates a portlet URI for the given portlet mode. The returned URI
97       * can be further extended by adding portlet-specific parameters
98       * and by attaching actions. Also, the portlet window will stay in the
99       * same state as before.
100      * 
101      * @param mode
102      *               the portlet mode
103      * @return a portlet URI
104      */
105     public PortletURI createURI (Portlet.Mode mode);
106 
107     /**
108      * Creates a portlet URI for the given portlet mode and given portlet
109      * window state. The returned URI can be further extended
110      * by adding portlet-specific parameters and by attaching actions.
111      * 
112      * @param mode
113      *               the portlet mode
114      * @param state
115      *               the portlet window state
116      * @return a portlet URI
117      */
118     public PortletURI createURI (Portlet.Mode mode, PortletWindow.State state);
119 
120     /**
121      * <P>
122      * Returns the encoded URI of the resource at the given path.
123      * Encoding may include prefixing, conversion to absolute URL, etc.
124      * </P>
125      * <P>
126      * To generate unprotected URI's like an image use the direct
127      * path inside of you portlet (e.g. /myportlet/myimage.gif).
128      * Otherwise, to generate protected URI's like an property file use the
129      * path inside of your portlet prefixed with /portlet-inf/
130      * (e.g. /portlet-inf/myportlet/myportlet.jsp)
131      * </P>
132      * 
133      * @param path
134      *               the path to the resource
135      * @return the resource URI as string
136      */
137     public String   encodeURI (String   path);
138 
139     /**
140      * Maps the given string value into this portlet's namespace.
141      * Should be applied to every variable or name used in the
142      * output stream. For example, an parameter used in forms,
143      * a function name in javascript.
144      * 
145      * @param aValue
146      *               the name to be mapped
147      * @return the mapped name
148      */
149     public String   encodeNamespace (String   aValue);
150 }
151 
152 
153
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags