Package com.epicentric.portalbeans

Contains the main interfaces and classes related to PortalBean portlets.

See:
Package Summary

Interface Summary

BeanCategoryPermission	Interface holding permission ID constants for permissions used by PortalBean categories.
BeanPermission	Interface holding permission ID constants for permissions on PortalBeans.
EntitlementUsage	(Not for customer use) An interface that PortalBeanView will implement.
PageContextTunnelling	Interface that is used only internally by the Vignette framework and has no usefulness for customers.
PageStartHandler	Any object interested in doing something at the start of a PortalBeanView should implement this, and pass itself to the view via its constructor.
PortalBean	Main persistence and administration interface for a module.
PortalBeanView	Interface for servicing modules' HTTP requests.
PortalPageContext	Provides a central point to access all the information and objects associated with a particular portal page request/response transaction, including the HTTP request and response objects, the user making the request, and the request's view ID (such as the front door, user edit screen, etc).
PortalPageInfo	Tells the PortalBeans about the display characteristics of the HTML page that's being constructed.
ViewFilter	A ViewFilter contains criteria which a PortalBean should evaluate when returning a contextual PortalBeanView.
ViewInfo	ViewInfos have a class-to-instance relationship to PortalBeanViews.

Class Summary

EntitledGenericBeanView	(Not for customer use) View to support built-in entitlement checking and usage monitoring
GenericBeanView	Generic implementation of the PortalBeanView interface.
GenericPortalBean	PortalBean implementation providing defaults for common PortalBean behavior, such as setting the name, title, description, etc.
GenericPortalPageInfo	Contains info about the portal HTML page that's being constructed.
GenericViewFilter	A GenericViewFilter contains criteria which a PortalBean should evaluate when returning a contextual PortalBeanView.
GenericViewInfo	This class implements a description of a PortalBeanView, in which view attributes can be stored.
ModulePaletteManager
ObsoletePortalBean	A PortalBean that has become obsolete, with or without a replacement.
PortalBeanDBManager	Static methods for getting a connection to the PortalBean DB.
PortalBeanDescriptor	Metadata describing a PortalBean type.
PortalBeanDuplicator	User: jgillam Date: May 5, 2003 Time: 3:36:34 PM
PortalBeanFileItem	Deprecated. since 7.0, to be removed in 9.0 or later.
PortalBeanManager	Class that maintains the persistence of PortalBeans and handles their retrieval
PortalBeanServlet	This is a support servlet that allows binary content for views.
PortalBeanUpgrader
PortalBeanUtils	Utility methods to manage PortalBean view state and manipulating/cleaning up user preferences for beans.
UserBeanFolderSweeper	A thread that periodically sweeps user MetaStore folders for bean subfolders belonging to beans that the user no longer has in their layout.

Exception Summary

DocumentTypeAlreadyDefinedException	Thrown when attempting to set a DocumentType on a PortalPageContext when one is already defined.
PortalBeanDescriptorException
PortalBeanException	Exception for portalbean-related conditions.
PortalBeanObsoleteException	Typically thrown by obsolete beans when they find themselves being used.
PortalBeanPersistificationException	Thrown when there's an error persistifying a PortalBean.
PortalBeanSecurityException	Exception for PortalBean security related conditions.

Package com.epicentric.portalbeans Description

Contains the main interfaces and classes related to PortalBean portlets. A PortalBean is a Web service or application that can be integrated into a Web site in an administrable, pluggable, modular fashion. Examples of PortalBeans are news, weather, stocks, bookmarks, and various Web searches. The com.epicentric.page package manages the layout of portlets within the pages that are accessible to users.

NOTE: The PortalBean API is being deprecated in favor of the Java Portlet Specification (JSR-168). Vignette Portal complies with the standards set in this specification. Earlier versions of Vignette Portal referred to PortalBean portlets as "modules."

The portalbeans package provides a development and administration container for Web applications and services. Among the facilities that this package offers are the following:

• Access control (making PortalBeans, as well as their feature sets, selectively available)
• Interoperability with other Web applications and services that share a page
• Storage of application state
• Storage of user state
• Multiple instances of a single PortalBean type (for example, e-mail PortalBean instances that point to different mail servers, or multiple instances of the Clip PortalBean clipping content from different URLs)

PortalBeans typically use JSP, XML-XSL, or other display technologies for their HTML rendering. The com.epicentric.portalbeans.beans.jspbean package supports creation of PortalBeans using JSP entirely.

See:
Discussion