KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > portal > server > PortalRequest


1 /*****************************************
2  * *
3  * JBoss Portal: The OpenSource Portal *
4  * *
5  * Distributable under LGPL license. *
6  * See terms of license at gnu.org. *
7  * *
8  *****************************************/

9 package org.jboss.portal.server;
10
11 import javax.servlet.http.HttpServletRequest JavaDoc;
12
13 import org.jboss.portal.server.util.Parameters;
14 import org.jboss.portal.server.util.Properties;
15
16 /**
17  * @author <a HREF="mailto:julien@jboss.org">Julien Viet</a>
18  * @version $Revision: 1.6 $
19  */

20 public interface PortalRequest extends HttpServletRequest JavaDoc
21 {
22
23    /**
24     * Returns the control parameters.
25     */

26    Parameters getControlParameters();
27
28    /**
29     * Returns the target parameters.
30     */

31    Parameters getTargetParameters();
32
33    /**
34     * Return the target or null if there is no target.
35     */

36    ServerObject getTarget();
37
38    /**
39     * Return the portal of the request.
40     */

41    Portal getPortal();
42
43    /**
44     * Return the container associated with this request.
45     */

46    PortalServer getServer();
47
48    /**
49     * Return the incoming URL that generated this request or null if it cannot be built.
50     */

51    ServerURL getURL();
52
53    /**
54     * Return a set of properties during the requet.
55     */

56    Properties getProperties();
57
58    /**
59     * Force the portal to be idempotent.
60     */

61    void setIdempotent(Boolean JavaDoc idempotent);
62
63    /**
64     * Return the idempotent mode for this request.
65     */

66    Boolean JavaDoc getIdempotent();
67
68 }
69
Popular Tags