KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > portal > server > invocation > AttachmentKey


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.invocation;
10
11 /**
12  * Typesafe enumeration for invocation elements.
13  *
14  * @author <a HREF="mailto:julien@jboss.org">Julien Viet</a>
15  * @version $Revision: 1.4 $
16  */
17 public class AttachmentKey
18 {
19    /** The invocation type. */
20    public static final AttachmentKey INVOCATION_TYPE = new AttachmentKey("INVOCATION_TYPE");
21
22    /** The portal request. */
23    public static final AttachmentKey PORTAL_REQUEST = new AttachmentKey("PORTAL_REQUEST");
24
25    /** The portal response. */
26    public static final AttachmentKey PORTAL_RESPONSE = new AttachmentKey("PORTAL_RESPONSE");
27
28    /** The dispatched request after the context dispatcher interceptor. */
29    public static final AttachmentKey DISPATCHED_REQUEST = new AttachmentKey("DISPATCHED_REQUEST");
30
31    /** The dispatched response after the context dispatcher interceptor. */
32    public static final AttachmentKey DISPATCHED_RESPONSE = new AttachmentKey("DISPATCHED_RESPONSE");
33
34    /** Properties available to components during the request. */
35    public static final AttachmentKey REQUEST_PROPERTIES = new AttachmentKey("REQUEST_PROPERTIES");
36
37    /** Properties used by components during the response. */
38    public static final AttachmentKey RESPONSE_PROPERTIES = new AttachmentKey("RESPONSE_PROPERTIES");
39
40    /** The target window context. */
41    public static final AttachmentKey WINDOW_CONTEXT = new AttachmentKey("WINDOW_CONTEXT");
42
43    /** The target window. */
44    public static final AttachmentKey WINDOW = new AttachmentKey("WINDOW");
45
46    /** The user context. */
47    public static final AttachmentKey USER_CONTEXT = new AttachmentKey("USER_CONTEXT");
48
49    /** The rendered windows. */
50    public static final AttachmentKey VIEW = new AttachmentKey("VIEW");
51
52    /** . */
53    public static final AttachmentKey PORTAL = new AttachmentKey("PORTAL");
54
55    /** . */
56    public static final AttachmentKey MODE = new AttachmentKey("MODE");
57
58    /** . */
59    public static final AttachmentKey WINDOW_STATE = new AttachmentKey("WINDOW_STATE");
60
61    /** the layout to delegate to in order to generate the markup of a portal response */
62    public static final AttachmentKey LAYOUT = new AttachmentKey("LAYOUT");
63
64    /** the uri (a jsp, part of the layout) to delegate to to generate the markup of a portal response */
65    public static final AttachmentKey LAYOUT_URI = new AttachmentKey("LAYOUT_URI");
66
67    private final String JavaDoc name;
68
69    protected AttachmentKey(String JavaDoc name)
70    {
71       if (name == null)
72       {
73          throw new NullPointerException JavaDoc("Cannot be null");
74       }
75       this.name = name;
76    }
77
78    public String JavaDoc toString()
79    {
80       return name;
81    }
82
83 }
84
Popular Tags