com.caucho.portal.generic
Interface Portal

All Known Implementing Classes:

GenericPortal

public interface Portal

Method Summary

BufferFactory	getBufferFactory()
Cache	getCache() XXX: caching not currently implemented
PortalContext	getPortalContext()
PreferencesStore	getPreferencesStore() Return a PreferencesStore for a connection.
java.lang.String	getReservedNamespace() The reserved namespace is used to mark parameters that have special meaning to the portal.
java.util.Set<java.lang.String>	getUserAttributeNames() Return a Set of all user attributes names that this portlet uses, null if all user attributes available from the portal should be made available.
UserAttributeStore	getUserAttributeStore() Return a UserAttributeStore.
boolean	isPortletModeAllowed(PortletRequest portletRequest, PortletMode portletMode) Return true if the PortletMode is allowed.
boolean	isWindowStateAllowed(PortletRequest portletRequest, WindowState windowState) Return true if the WindowState is allowed.

Method Detail

getPortalContext

PortalContext getPortalContext()

isWindowStateAllowed

boolean isWindowStateAllowed(PortletRequest portletRequest,
                             WindowState windowState)

Return true if the WindowState is allowed. portletRequest.getResponseContentType() can be used if the allowed portlet modes depends on the mime type of the response.

isPortletModeAllowed

boolean isPortletModeAllowed(PortletRequest portletRequest,
                             PortletMode portletMode)

Return true if the PortletMode is allowed. portletRequest.getResponseContentType() can be used if the allowed portlet modes depends on the mime type of the response.

getReservedNamespace

java.lang.String getReservedNamespace()

The reserved namespace is used to mark parameters that have special meaning to the portal. The specification suggests "javax.portal.", which is rather long so the default is ususally "__".

getPreferencesStore

PreferencesStore getPreferencesStore()

Return a PreferencesStore for a connection. The store is obtained once for each connection and used throughout the course of the connection to obtain a javax.portlet.PortletPreferences for each namespace.

getUserAttributeNames

java.util.Set<java.lang.String> getUserAttributeNames()

Return a Set of all user attributes names that this portlet uses, null if all user attributes available from the portal should be made available.

getUserAttributeStore

UserAttributeStore getUserAttributeStore()

Return a UserAttributeStore. The store is obtained once for each connection if needed.

getCache

Cache getCache()

XXX: caching not currently implemented

Returns:

null to disable caching

getBufferFactory

BufferFactory getBufferFactory()

Returns:

null to disable buffering