01: /*
02: * Copyright (c) 1998-2004 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: * Free SoftwareFoundation, Inc.
23: * 59 Temple Place, Suite 330
24: * Boston, MA 02111-1307 USA
25: *
26: * @author Sam
27: */
28:
29: package javax.portlet;
30:
31: public interface PortletResponse {
32: public void addProperty(String key, String value);
33:
34: public void setProperty(String key, String value);
35:
36: /**
37: * Encode a url to a resource.
38: *
39: * The <code>path</code> may be an absolute URL ("http://myserver/...")
40: * or a URI with a full path ("/myapp/mypath/....").
41: *
42: * <code>path</code> may also be a relative path ("images/myimage.gif"), in
43: * which case it is a url to a resource in the current "portal", typically a
44: * path relative to the current webapp. Allowing a relative path is an
45: * extension of the behaviour defined by the portlet specification.
46: *
47: * The returned URL is always an absolute url. Some browsers do not
48: * understand relative url's supplied for certain parameters (such as the
49: * location of css files).
50: *
51: * @return an absolute URL
52: *
53: * @see javax.portlet.PortletResponse#encodeURL
54: */
55: public String encodeURL(String path);
56:
57: }
|