01: /*
02: * Created on 10-Mar-2003
03: */
04: package net.sf.jportlet.portlet;
05:
06: import javax.servlet.http.HttpServletResponse;
07:
08: /**
09: * The <code>PortletResponse</code> interface represents the response sent to
10: * the client device.
11: * It is up to the portlet container to enhance, extend,
12: * or modify the response as required before it is actually sent to the
13: * client device.
14: *
15: * @author <a href="mailto:tchbansi@sourceforge.net">Herve Tchepannou</a>
16: */
17: public interface PortletResponse extends HttpServletResponse {
18: //~ Methods ----------------------------------------------------------------
19:
20: /**
21: * Creates a portlet URI pointing to the current portlet mode.
22: * The returned URI can be further extended by adding portlet-specific parameters,
23: * action and mode
24: *
25: * @return PortletURI
26: */
27: public PortletURI createURI();
28:
29: /**
30: * Create a portlet URI for executing an action
31: *
32: * @param action action to execute
33: * @return PortletURI
34: */
35: public PortletURI createURI(String action);
36:
37: /**
38: * Create a portlet URI pointing to the current portlet for a given mode and
39: * state.
40: *
41: * @param mode Portlet mode
42: * @param state Portlet state
43: * @return PortletURI
44: */
45: public PortletURI createURI(Portlet.Mode mode,
46: PortletWindow.State state);
47:
48: /**
49: * Maps the given string value into this portlet's namespace.
50: * Should be applied to every variable or name used in the output stream.
51: * For example, a parameter used in a form, or a function name in javascript
52: *
53: * @param name
54: * @return String
55: */
56: public String encodeNamespace(String name);
57:
58: /**
59: * Returns the encoded URI of the resource at the given path.
60: * Encoding may include prefixing, conversion to absolute URL, etc.
61: * To generate unprotected URI's like an image use the direct path inside
62: * of you portlet (e.g. /myportlet/myimage.gif).
63: * Otherwise, to generate protected URI's like a property file use the path
64: * inside of your portlet prefixed with /WEB-INF/
65: * (e.g. /WEB-INF/myportlet/myportlet.jsp)
66: *
67: * @see javax.servlet.http.HttpServletResponse#encodeURL(String)
68: */
69: public String encodeURL(String url);
70: }
|