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: * Channels implementing this interface are considered "privileged" because
10: * they will have access to internal portal control structures such as the
11: * HttpServletRequest, HttpServletReponse, and UserPreferencesManager. IPrivilegedChannel
12: * is intended for channels that are integral to the framework such as those that
13: * manage user preferences, channel publishing, and channel subscription.
14: * IPrivilegedChannel is NOT intended for "normal" channels. Channels
15: * should normally implement {@link IChannel}.
16: *
17: * Portal administrators should only allow publishing/subscibing of channels
18: * implementing IPrivilegedChannel if the following are true:
19: *
20: * <ul>
21: * <li>The channel is an integral part of the uPortal framework, e.g. {@link org.jasig.portal.channels.CLogin}.</li>
22: * <li>The channel is well-understood and will not cause harm. An understanding of the
23: * portal architecture is necessary to determine if this is true.</li>
24: * <li>There is no way to implement the channel as an IChannel because access to
25: * internal structures is absolutely necessary.</li>
26: * </ul>
27: * @author Peter Kharchenko, pkharchenko@interactivebusiness.com
28: * @version $Revision: 34818 $
29: * @see IChannel
30: * @see PortalControlStructures
31: */
32: public interface IPrivilegedChannel extends IChannel, IPrivileged {
33: }
|