01: /* Copyright 2001 The JA-SIG Collaborative. All rights reserved.
02: * See license distributed with this file and
03: * available online at http://www.uportal.org/license.html
04: */
05:
06: package org.jasig.portal;
07:
08: /**
09: * Houses constants used in the portal code base. Developers, any constants
10: * added here should be clearly documented.
11: * @author Mark Boyd {@link <a href="mailto:mark.boyd@engineer.com">mark.boyd@engineer.com</a>}
12: * @version $Revision: 36782 $
13: */
14: public class Constants {
15:
16: /**
17: * The query parameter name that can be appended to a baseActionUrl along
18: * with its value, the fname of a channel, to cause an instance of that
19: * channel to appear in focused mode without the user having to subcribe
20: * to that channel. Examples are infrastructure channels like
21: * CChannelManager and CUserPreferences. They don't reside in a user's
22: * layout but are merged in via the fname functionality as needed.
23: */
24: public static final String FNAME_PARAM = "uP_fname";
25:
26: /**
27: * The request parameter name that can be appended to a baseActionURL along
28: * with its value, the locales to which the portal should assign priority.
29: * These locales will be a priority for the remainder of a user's session.
30: * The value of this parameter should be a comma-delimited list of locale
31: * codes. For example, en_US,ja_JP,de_DE
32: */
33: public static final String LOCALES_PARAM = "uP_locales";
34:
35: /**
36: * The name of a category into which automatically published channels from
37: * a channel archive are placed. It is expected to be found in the root
38: * category and if not found during publishing is automatically created.
39: */
40: public static final String AUTO_PUBLISH_CATEGORY = "Auto-Published";
41:
42: /**
43: * The default functional name of the administrative links channel. This is
44: * used by channels designed for being delegated to from the administrative
45: * links channel that return to that channel when the user is finished
46: * with their functionality. Returning to the links channel is accomplished
47: * through the use of a URL obtained from
48: * ChannelRuntimeData.getFnameActionUrl passing a functional name. The
49: * value of this field can be passed to that method to obtain a URL that
50: * will bring that channel into focus.
51: */
52: public static final String NAVIGATION_CHAN_FNAME = "admin.navigation.links";
53:
54: /**
55: * The prefix of DTDs owned by uPortal version 2.0. This is used to allow
56: * local resolution of uPortal specific DTDs.
57: */
58: public static final String UPORTAL_2_DTD_PREFIX = "http://www.ja-sig.org/products/uportal/2/dtds/";
59:
60: /**
61: * The attribute used to convey a custom template account from which to
62: * copy the initial layout for a user.
63: */
64: public static final String TEMPLATE_USER_NAME_ATT = "uPortalTemplateUserName";
65: }
|