Package com.epicentric.portalbeans.viewutils

Provides system mappings for PortalBeanView objects to identify physical files and to control access.

See:
Package Summary

Interface Summary

PageIDToURLMapping	Maintains mappings of page IDs to the URLs of the pages.
ViewToIsRootMapping	Maintains mappings of view IDs to isNavigationRoot.
ViewToPageMapping	Maintains mappings of view IDs to page IDs.
ViewToUserLevelMapping	Maintains mappings of view IDs to userLevel.

Class Summary

GenericMappingService	View mapping service.
GenericPageIDToURLMapping	PageIDToURLMapping implementation that looks for the pageID-to-URL mappings in the system properties.
GenericViewToIsRootMapping	ViewToIsRootMapping implementation that looks for the viewID-to-isNavigationRoot mappings in the system properties.
GenericViewToPageMapping	ViewToPageMapping implementation that looks for the viewID-to-pageID mappings in the system properties.
GenericViewToUserLevelMapping	ViewToUserLevelMapping implementation that looks for the viewID-to-userLevel mappings in the system properties.
MappingFactory	Static factory class for creating and retrieving the default mapping services.

Package com.epicentric.portalbeans.viewutils Description

Provides system mappings for PortalBeanView objects to identify physical files and to control access. This package should not be used directly; all necessary calls are built into the Vignette Portal framework.

The mappings for all standard views are defined in the Vignette Portal properties file. Mappings for any custom views that a particular PortalBean has are defined in that PortalBean's descriptor (.pbd) file. Overrides to the standard view mappings can also be specified at the individual PortalBean view level in the PortalBean's .pbd file.

A PortalBeanView contains the display logic for a particular PortalBean view; examples are front-door view, user edit view, and admin edit view.

• A page has a page ID and resolves to a URL.
• A view has a view ID and does not resolve to a URL.
• A navigation root is a navigable display view for a page that can be accessed via a URL or a request that requires POST parameters.
• A process view processes form input or takes query string parameters; it is not a display view.
• A user level identifies the access privileges required to access a view: guest, registered_user, or admin. Access is controlled by comparing a view's user level to the User object's user level.

This package supports the following mappings:

• Page ID to URL: for example, FRONT_PAGE=index.jsp
• View to Page: for example, MY_PORTAL_VIEW=FRONT_PAGE
• View to User Level: for example, MY_PORTAL_VIEW=guest
• View to IsRoot: for example, MY_PORTAL_VIEW=true because this view is a navigation root.

The com.epicentric.portalbeans.GenericViewInfo class enables the mappings for a particular view to be queried:

• GenericViewInfo.getPreferredPageID() returns the view's page ID.
• GenericViewInfo.isAdmin() and GenericViewInfo.isGuest() enable the view's user level to be queried. In addition, GenericViewInfo has static fields related to the view's user level: GenericViewInfo.USER_LEVEL_ADMIN, GenericViewInfo.USER_LEVEL_GUEST, GenericViewInfo.USER_LEVEL_REGISTERED_USER.
• GenericViewInfo.isNavigationRoot() returns the view's navigation root boolean value.

See Also:

com.epicentric.portalbeans, com.epicentric.user