com.bea.jsptools.portal
Class PortalVisitorManager

java.lang.Object
  com.bea.jsptools.portal.PortalVisitorManager

public class PortalVisitorManager

extends Object

Visitor Tool wrapper around the PortalManager. Customizations of visitor tool processing can be done in this class.

Constructor Summary

PortalVisitorManager()

Method Summary

static void	addNavigableInstances(com.bea.jsptools.portal.placement.NavigablePlacement[] navigables, String webapp, String portalPath, String desktopPath, HttpServletRequest request)
static void	addPlaceableInstances(com.bea.jsptools.portal.placement.PlaceablePlacement[] placeables, String webapp, String portalPath, String desktopPath, HttpServletRequest request)
static String	createBookDefinition(String webapp, String title, String desc, String menuId, Locale locale, HttpServletRequest request)
static String	createPageDefinition(String webapp, String title, String desc, String layoutId, Locale locale, HttpServletRequest request)
static String	crossSiteScriptFix(String stringInput)
static String[]	generatePortletCategoryArrays(String webAppName, String indentStr, Locale locale, HttpServletRequest request)
static BookInstance	getBookInstance(String id, Locale locale, HttpServletRequest request)
static BookView	getBookView(String bookInstanceId, String webAppName, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static DesktopView	getDesktopView(String portalPath, String webAppName, String desktopPath, Locale locale, HttpServletRequest request)
static LayoutDefinition[]	getLayoutDefinitions(String webapp, Locale locale, HttpServletRequest request)
static String	getLayoutHtml(String layoutHTMLPath, String currentWebApp)
static LookAndFeelDefinition[]	getLookAndFeelDefinitions(String webapp, Locale locale, HttpServletRequest request)
static MenuDefinition[]	getMenuDefinitions(String webapp, Locale locale, HttpServletRequest request)
static PageInstance	getPageInstance(String id, Locale locale, HttpServletRequest request)
static PageView	getPageView(String pageInstanceId, String webAppName, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static PortletDefinition[]	getPortletDefinitions(String webapp, Locale locale, HttpServletRequest request)
static PortletInstance	getPortletInstance(String id, Locale locale, HttpServletRequest request)
static PortletCategoryDefinition	getPortletRootCategoryDefinition(String webAppName, Locale locale, HttpServletRequest request)
static HashMap	getPortletsForCategory(PortletCategoryDefinition portletCategoryDefinition, Locale locale, HttpServletRequest request)
static HashMap	getPortletsHash(PortletDefinition[] portlets)
static PortletCategoryDefinition[]	getPortletSubCategoryDefinitions(PortletCategoryDefinitionId pcdId, Locale locale, HttpServletRequest request)
static BookDefinition[]	getPublicBookDefinitions(String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static PageDefinition[]	getPublicPageDefinitions(String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static ThemeDefinition[]	getThemeDefinitions(String webapp, Locale locale, HttpServletRequest request)
static boolean	isPlaceholderLocked(String webApp, String portalPath, String desktopPath, String pageId, String placeholderNum, HttpServletRequest request)
protected static void	log(String message, Exception e)
static void	moveNavigableInstances(com.bea.jsptools.portal.placement.NavigablePlacement[] navigables, String webapp, String portalPath, String desktopPath, HttpServletRequest request)
static void	movePlaceableInstances(com.bea.jsptools.portal.placement.PlaceablePlacement[] placeables, String webapp, String portalPath, String desktopPath, HttpServletRequest request)
static void	removeNavigableInstances(com.bea.jsptools.portal.placement.NavigablePlacement[] navigables, String webapp, String portalPath, String desktopPath, HttpServletRequest request)
static void	removePlaceableInstances(com.bea.jsptools.portal.placement.PlaceablePlacement[] placeables, String webapp, String portalPath, String desktopPath, HttpServletRequest request)
static int	updateBookInstanceMenu(String bookId, String newMenuId, String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static void	updateBookInstanceTheme(String bookId, String newThemeId, String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static void	updateBookInstanceTitle(String bookId, String newTitle, String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static void	updateDesktopInstance(String webapp, String portalPath, String desktopPath, String lookId, Locale locale, HttpServletRequest request)
static int	updatePageInstanceLayout(String pageId, String layoutId, String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static void	updatePageInstanceTheme(String pageId, String newThemeId, String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static void	updatePageInstanceTitle(String pageId, String newTitle, String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static void	updatePortletInstanceTheme(String portletId, String newThemeId, String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)
static void	updatePortletInstanceTitle(String portletId, String newTitle, String webapp, String portalPath, String desktopPath, Locale locale, HttpServletRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortalVisitorManager

public PortalVisitorManager()

Method Detail

addNavigableInstances

public static void addNavigableInstances(com.bea.jsptools.portal.placement.NavigablePlacement[] navigables,
                                         String webapp,
                                         String portalPath,
                                         String desktopPath,
                                         HttpServletRequest request)

addPlaceableInstances

public static void addPlaceableInstances(com.bea.jsptools.portal.placement.PlaceablePlacement[] placeables,
                                         String webapp,
                                         String portalPath,
                                         String desktopPath,
                                         HttpServletRequest request)

createBookDefinition

public static String createBookDefinition(String webapp,
                                          String title,
                                          String desc,
                                          String menuId,
                                          Locale locale,
                                          HttpServletRequest request)

createPageDefinition

public static String createPageDefinition(String webapp,
                                          String title,
                                          String desc,
                                          String layoutId,
                                          Locale locale,
                                          HttpServletRequest request)

crossSiteScriptFix

public static String crossSiteScriptFix(String stringInput)

generatePortletCategoryArrays

public static String[] generatePortletCategoryArrays(String webAppName,
                                                     String indentStr,
                                                     Locale locale,
                                                     HttpServletRequest request)

getBookInstance

public static BookInstance getBookInstance(String id,
                                           Locale locale,
                                           HttpServletRequest request)

getBookView

public static BookView getBookView(String bookInstanceId,
                                   String webAppName,
                                   String portalPath,
                                   String desktopPath,
                                   Locale locale,
                                   HttpServletRequest request)

getDesktopView

public static DesktopView getDesktopView(String portalPath,
                                         String webAppName,
                                         String desktopPath,
                                         Locale locale,
                                         HttpServletRequest request)

getLayoutDefinitions

public static LayoutDefinition[] getLayoutDefinitions(String webapp,
                                                      Locale locale,
                                                      HttpServletRequest request)

getLayoutHtml

public static String getLayoutHtml(String layoutHTMLPath,
                                   String currentWebApp)

getLookAndFeelDefinitions

public static LookAndFeelDefinition[] getLookAndFeelDefinitions(String webapp,
                                                                Locale locale,
                                                                HttpServletRequest request)

getMenuDefinitions

public static MenuDefinition[] getMenuDefinitions(String webapp,
                                                  Locale locale,
                                                  HttpServletRequest request)

getPageInstance

public static PageInstance getPageInstance(String id,
                                           Locale locale,
                                           HttpServletRequest request)

getPageView

public static PageView getPageView(String pageInstanceId,
                                   String webAppName,
                                   String portalPath,
                                   String desktopPath,
                                   Locale locale,
                                   HttpServletRequest request)

getPortletDefinitions

public static PortletDefinition[] getPortletDefinitions(String webapp,
                                                        Locale locale,
                                                        HttpServletRequest request)

getPortletInstance

public static PortletInstance getPortletInstance(String id,
                                                 Locale locale,
                                                 HttpServletRequest request)

getPortletRootCategoryDefinition

public static PortletCategoryDefinition getPortletRootCategoryDefinition(String webAppName,
                                                                         Locale locale,
                                                                         HttpServletRequest request)

getPortletsForCategory

public static HashMap getPortletsForCategory(PortletCategoryDefinition portletCategoryDefinition,
                                             Locale locale,
                                             HttpServletRequest request)

getPortletsHash

public static HashMap getPortletsHash(PortletDefinition[] portlets)

getPortletSubCategoryDefinitions

public static PortletCategoryDefinition[] getPortletSubCategoryDefinitions(PortletCategoryDefinitionId pcdId,
                                                                           Locale locale,
                                                                           HttpServletRequest request)

getPublicBookDefinitions

public static BookDefinition[] getPublicBookDefinitions(String webapp,
                                                        String portalPath,
                                                        String desktopPath,
                                                        Locale locale,
                                                        HttpServletRequest request)

getPublicPageDefinitions

public static PageDefinition[] getPublicPageDefinitions(String webapp,
                                                        String portalPath,
                                                        String desktopPath,
                                                        Locale locale,
                                                        HttpServletRequest request)

getThemeDefinitions

public static ThemeDefinition[] getThemeDefinitions(String webapp,
                                                    Locale locale,
                                                    HttpServletRequest request)

isPlaceholderLocked

public static boolean isPlaceholderLocked(String webApp,
                                          String portalPath,
                                          String desktopPath,
                                          String pageId,
                                          String placeholderNum,
                                          HttpServletRequest request)

log

protected static void log(String message,
                          Exception e)

moveNavigableInstances

public static void moveNavigableInstances(com.bea.jsptools.portal.placement.NavigablePlacement[] navigables,
                                          String webapp,
                                          String portalPath,
                                          String desktopPath,
                                          HttpServletRequest request)

movePlaceableInstances

public static void movePlaceableInstances(com.bea.jsptools.portal.placement.PlaceablePlacement[] placeables,
                                          String webapp,
                                          String portalPath,
                                          String desktopPath,
                                          HttpServletRequest request)

removeNavigableInstances

public static void removeNavigableInstances(com.bea.jsptools.portal.placement.NavigablePlacement[] navigables,
                                            String webapp,
                                            String portalPath,
                                            String desktopPath,
                                            HttpServletRequest request)

removePlaceableInstances

public static void removePlaceableInstances(com.bea.jsptools.portal.placement.PlaceablePlacement[] placeables,
                                            String webapp,
                                            String portalPath,
                                            String desktopPath,
                                            HttpServletRequest request)

updateBookInstanceMenu

public static int updateBookInstanceMenu(String bookId,
                                         String newMenuId,
                                         String webapp,
                                         String portalPath,
                                         String desktopPath,
                                         Locale locale,
                                         HttpServletRequest request)

updateBookInstanceTheme

public static void updateBookInstanceTheme(String bookId,
                                           String newThemeId,
                                           String webapp,
                                           String portalPath,
                                           String desktopPath,
                                           Locale locale,
                                           HttpServletRequest request)

updateBookInstanceTitle

public static void updateBookInstanceTitle(String bookId,
                                           String newTitle,
                                           String webapp,
                                           String portalPath,
                                           String desktopPath,
                                           Locale locale,
                                           HttpServletRequest request)

updateDesktopInstance

public static void updateDesktopInstance(String webapp,
                                         String portalPath,
                                         String desktopPath,
                                         String lookId,
                                         Locale locale,
                                         HttpServletRequest request)

updatePageInstanceLayout

public static int updatePageInstanceLayout(String pageId,
                                           String layoutId,
                                           String webapp,
                                           String portalPath,
                                           String desktopPath,
                                           Locale locale,
                                           HttpServletRequest request)

updatePageInstanceTheme

public static void updatePageInstanceTheme(String pageId,
                                           String newThemeId,
                                           String webapp,
                                           String portalPath,
                                           String desktopPath,
                                           Locale locale,
                                           HttpServletRequest request)

updatePageInstanceTitle

public static void updatePageInstanceTitle(String pageId,
                                           String newTitle,
                                           String webapp,
                                           String portalPath,
                                           String desktopPath,
                                           Locale locale,
                                           HttpServletRequest request)

updatePortletInstanceTheme

public static void updatePortletInstanceTheme(String portletId,
                                              String newThemeId,
                                              String webapp,
                                              String portalPath,
                                              String desktopPath,
                                              Locale locale,
                                              HttpServletRequest request)

updatePortletInstanceTitle

public static void updatePortletInstanceTitle(String portletId,
                                              String newTitle,
                                              String webapp,
                                              String portalPath,
                                              String desktopPath,
                                              Locale locale,
                                              HttpServletRequest request)