KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > portal > generic > Portal


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2001-2004 Caucho Technology, Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution, if
19  * any, must include the following acknowlegement:
20  * "This product includes software developed by the
21  * Caucho Technology (http://www.caucho.com/)."
22  * Alternately, this acknowlegement may appear in the software itself,
23  * if and wherever such third-party acknowlegements normally appear.
24  *
25  * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * info@caucho.com.
29  *
30  * 5. Products derived from this software may not be called "Resin"
31  * nor may "Resin" appear in their names without prior written
32  * permission of Caucho Technology.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37  * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
38  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
39  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
40  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
41  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
42  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
44  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  * @author Sam
47  */
48
49 package com.caucho.portal.generic;
50
51 import javax.portlet.PortalContext;
52 import javax.portlet.PortletMode;
53 import javax.portlet.PortletRequest;
54 import javax.portlet.WindowState;
55 import java.util.Set JavaDoc;
56
57 public interface Portal
58 {
59   public PortalContext getPortalContext();
60
61   /**
62    * Return true if the WindowState is allowed.
63    * <code>portletRequest.getResponseContentType()</code> can be used
64    * if the allowed portlet modes depends on the mime type of the
65    * response.
66    */
67   public boolean isWindowStateAllowed(PortletRequest portletRequest,
68                                       WindowState windowState);
69
70   /**
71    * Return true if the PortletMode is allowed.
72    * <code>portletRequest.getResponseContentType()</code> can be used
73    * if the allowed portlet modes depends on the mime type of the
74    * response.
75    */
76   public boolean isPortletModeAllowed(PortletRequest portletRequest,
77                                       PortletMode portletMode);
78
79   /**
80    * The reserved namespace is used to mark parameters that have special
81    * meaning to the portal. The specification suggests "javax.portal.", which
82    * is rather long so the default is ususally "__".
83    */
84   public String JavaDoc getReservedNamespace();
85
86   /**
87    * Return a PreferencesStore for a connection.
88    * The store is obtained once for each connection and used throughout the
89    * course of the connection to obtain a
90    * {@link javax.portlet.PortletPreferences} for each namespace.
91    */
92   public PreferencesStore getPreferencesStore();
93
94   /**
95    * Return a Set of all user attributes names that this portlet uses,
96    * null if all user attributes available from the portal should be made
97    * available.
98    */
99   public Set JavaDoc<String JavaDoc> getUserAttributeNames();
100
101   /**
102    * Return a UserAttributeStore.
103    * The store is obtained once for each connection if needed.
104    */
105   public UserAttributeStore getUserAttributeStore();
106
107   /**
108    * XXX: caching not currently implemented
109    *
110    * @return null to disable caching
111    */
112   public Cache getCache();
113
114   /**
115    * @return null to disable buffering
116    */
117   public BufferFactory getBufferFactory();
118 }
119
120
Popular Tags