KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > webapps > portal > PortalConstants


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.webapps.portal;
17
18 /**
19  * Some constants for the portal
20  *
21  * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
22  * @version CVS $Id: PortalConstants.java 30932 2004-07-29 17:35:38Z vgritsenko $
23 */
24 public interface PortalConstants {
25
26     /** The name of the portal context. */
27     String JavaDoc SESSION_CONTEXT_NAME = "portal";
28
29     /** The private context of the portal profile. Some more information
30      * is appended by the PortalManager to this key.
31      */
32     String JavaDoc PRIVATE_SESSION_CONTEXT_NAME = "org.apache.cocoon.webapps.portal.context.SessionContext";
33
34     /** The Module name of the authentication module */
35     String JavaDoc AUTHENTICATION_MODULE_NAME = "portal";
36
37     /** If a coplet is loaded the <code>SessionInfo.copletInfo</code> map
38      * contains in this key the parameters for the coplet.
39      */
40     String JavaDoc COPLETINFO_PARAMETERS = "COPLETINFO_PARAMETERS";
41
42     /** If a coplet is loaded the <code>SessionInfo.copletInfo</code> map
43      * contains in this key the portal URI
44      */
45     String JavaDoc COPLETINFO_PORTALURI = "COPLETINFO_PORTALURI";
46
47     /** If a coplet is loaded the <code>SessionInfo.copletInfo</code> map
48      * contains in this key the status profile
49      */
50     String JavaDoc COPLETINFO_STATUSPROFILE = "COPLETINFO_STATUSPROFILE";
51
52     // XML Elements
53 String JavaDoc ELEMENT_CONFIGURATION="configuration";
54     String JavaDoc ELEMENT_ID = "id";
55     String JavaDoc ELEMENT_ADMINCONF = "portaladminconf";
56     String JavaDoc ELEMENT_LAYOUT = "layout";
57     String JavaDoc ELEMENT_PORTAL = "portal";
58     String JavaDoc ELEMENT_PORTALCONF= "portalconf";
59     String JavaDoc ELEMENT_PROFILE = "profile";
60     String JavaDoc ELEMENT_ROLE = "role";
61     String JavaDoc ELEMENT_STATE = "state";
62     String JavaDoc ELEMENT_COPLET = "coplet";
63     String JavaDoc ELEMENT_COPLETS = "coplets";
64
65     // admin conf states
66 final String JavaDoc STATE_USER = "user";
67     final String JavaDoc STATE_ROLE = "role";
68     final String JavaDoc STATE_MAIN = "main";
69     final String JavaDoc STATE_COPLETS = "coplets";
70     final String JavaDoc STATE_GLOBAL = "global";
71     final String JavaDoc STATE_COPLET = "coplet";
72     final String JavaDoc STATE_MAIN_ROLE= "mainrole";
73
74     /** The name of the attribute holding the portal configuration */
75     final String JavaDoc ATTRIBUTE_CONFIGURATION = "portalConf";
76
77     /** The name of the attribute holding the url rewritten portal uri */
78     final String JavaDoc ATTRIBUTE_PORTAL_URI = "portalURI";
79
80     final String JavaDoc ATTRIBUTE_COPLET_REPOSITORY = "portalRep";
81
82     final String JavaDoc PROFILE_PROFILE = "profile"; // DocumentFragment
83 final String JavaDoc PROFILE_TYPE_PATHS = "typePaths"; // List
84 final String JavaDoc PROFILE_TYPE_CONF_PATHS= "typeConfPaths"; // List
85 final String JavaDoc PROFILE_PORTAL_LAYOUTS = "portalLayouts"; // Map
86 final String JavaDoc PROFILE_COPLET_LAYOUTS = "copletLayouts"; // Map
87 final String JavaDoc PROFILE_MISC_POINTER = "misc"; // Node[] with the values from below
88 final int PROFILE_MISC_HEADER_NODE = 0;
89         final int PROFILE_MISC_FOOTER_NODE = 1;
90         final int PROFILE_MISC_HEADER_CONTENT_NODE = 2;
91         final int PROFILE_MISC_FOOTER_CONTENT_NODE = 3;
92         final int PROFILE_MISC_COLUMNS_NODE= 4;
93         final int PROFILE_MISC_LAST_COPLET_NODE = 5;
94         final int PROFILE_MISC_MESSAGES_NODE = 6;
95         // starting with 8 the columns follow (by now max: 5)
96
97     final String JavaDoc PROFILE_DEFAULT_COPLETS= "defCoplets"; // Map
98 final String JavaDoc PROFILE_MEDIA_COPLETS = "mediaCoplets"; // Map
99 final String JavaDoc PROFILE_SAVE_STATUS_FLAG= "saveStatus"; // Value not used
100
101     /** Configuration Map */
102     final String JavaDoc CONF_BUILD_RESOURCE = "A";
103     final String JavaDoc CONF_AUTH_REDIRECT = "B";
104     final String JavaDoc CONF_LAYOUTBASE_RESOURCE = "C";
105     final String JavaDoc CONF_COPLETBASE_RESOURCE = "D";
106     final String JavaDoc CONF_COPLETBASE_SAVE_RESOURCE = "E";
107     final String JavaDoc CONF_TYPEBASE_RESOURCE = "F";
108     final String JavaDoc CONF_GLOBALDELTA_LOADRESOURCE = "G";
109     final String JavaDoc CONF_GLOBALDELTA_SAVERESOURCE = "H";
110     final String JavaDoc CONF_GLOBALDELTA_TYPERESOURCE = "I";
111     final String JavaDoc CONF_ROLEDELTA_LOADRESOURCE = "J";
112     final String JavaDoc CONF_ROLEDELTA_SAVERESOURCE = "K";
113     final String JavaDoc CONF_ROLEDELTA_TYPERESOURCE = "L";
114     final String JavaDoc CONF_USERDELTA_LOADRESOURCE = "M";
115     final String JavaDoc CONF_USERDELTA_SAVERESOURCE = "N";
116     final String JavaDoc CONF_USERDELTA_TYPERESOURCE = "O";
117     final String JavaDoc CONF_STATUS_LOADRESOURCE = "P";
118     final String JavaDoc CONF_STATUS_SAVERESOURCE = "Q";
119     final String JavaDoc CONF_ADMIN_TYPE_BASE = "R";
120     final String JavaDoc CONF_PORTAL_URI = "S";
121     final String JavaDoc CONF_PROFILE_CACHE = "T";
122     final String JavaDoc CONF_PARALLEL_COPLETS = "U";
123     final String JavaDoc CONF_COPLET_TIMEOUT = "V";
124
125     final int MAX_COLUMNS = 5;
126
127     /* The Parameters for the coplet */
128     final String JavaDoc PARAMETER_MEDIA = "media";
129     final String JavaDoc PARAMETER_ID = "id";
130     final String JavaDoc PARAMETER_NUMBER= "number";
131     final String JavaDoc PARAMETER_CUSTOMIZE = "customize";
132     final String JavaDoc PARAMETER_SIZE = "size";
133     final String JavaDoc PARAMETER_VISIBLE= "visible";
134     final String JavaDoc PARAMETER_PERSISTENT= "persistent";
135 }
136
Popular Tags