001: /*
002: * The Apache Software License, Version 1.1
003: *
004: * Copyright (c) 2001-2004 Caucho Technology, Inc. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution, if
019: * any, must include the following acknowlegement:
020: * "This product includes software developed by the
021: * Caucho Technology (http://www.caucho.com/)."
022: * Alternately, this acknowlegement may appear in the software itself,
023: * if and wherever such third-party acknowlegements normally appear.
024: *
025: * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
026: * endorse or promote products derived from this software without prior
027: * written permission. For written permission, please contact
028: * info@caucho.com.
029: *
030: * 5. Products derived from this software may not be called "Resin"
031: * nor may "Resin" appear in their names without prior written
032: * permission of Caucho Technology.
033: *
034: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
035: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
036: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
037: * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
038: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
039: * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
040: * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
041: * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
042: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
043: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
044: * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
045: *
046: * @author Sam
047: */
048:
049: package com.caucho.portal.generic;
050:
051: import javax.portlet.PortalContext;
052: import javax.portlet.PortletMode;
053: import javax.portlet.PortletRequest;
054: import javax.portlet.WindowState;
055: import java.util.Set;
056:
057: public interface Portal {
058: public PortalContext getPortalContext();
059:
060: /**
061: * Return true if the WindowState is allowed.
062: * <code>portletRequest.getResponseContentType()</code> can be used
063: * if the allowed portlet modes depends on the mime type of the
064: * response.
065: */
066: public boolean isWindowStateAllowed(PortletRequest portletRequest,
067: WindowState windowState);
068:
069: /**
070: * Return true if the PortletMode is allowed.
071: * <code>portletRequest.getResponseContentType()</code> can be used
072: * if the allowed portlet modes depends on the mime type of the
073: * response.
074: */
075: public boolean isPortletModeAllowed(PortletRequest portletRequest,
076: PortletMode portletMode);
077:
078: /**
079: * The reserved namespace is used to mark parameters that have special
080: * meaning to the portal. The specification suggests "javax.portal.", which
081: * is rather long so the default is ususally "__".
082: */
083: public String getReservedNamespace();
084:
085: /**
086: * Return a PreferencesStore for a connection.
087: * The store is obtained once for each connection and used throughout the
088: * course of the connection to obtain a
089: * {@link javax.portlet.PortletPreferences} for each namespace.
090: */
091: public PreferencesStore getPreferencesStore();
092:
093: /**
094: * Return a Set of all user attributes names that this portlet uses,
095: * null if all user attributes available from the portal should be made
096: * available.
097: */
098: public Set<String> getUserAttributeNames();
099:
100: /**
101: * Return a UserAttributeStore.
102: * The store is obtained once for each connection if needed.
103: */
104: public UserAttributeStore getUserAttributeStore();
105:
106: /**
107: * XXX: caching not currently implemented
108: *
109: * @return null to disable caching
110: */
111: public Cache getCache();
112:
113: /**
114: * @return null to disable buffering
115: */
116: public BufferFactory getBufferFactory();
117: }
|