org.apache.pluto.driver.config
Interface DriverConfiguration

All Known Implementing Classes:
DriverConfigurationImpl

public interface DriverConfiguration

Interface defining a means for retrieving driver services based upon configuration information. Within the portal, an implementation of this interface should be bound to the portal's ServletContext.

Since:
Sep 2, 2005
Author:
David H. DeWolf

Method Summary
 void destroy()
          Shutdown method used to remove the driver configuration from service;
 java.lang.String getContainerName()
          Retrieves the name of the container which pluto should create and embed.
 PageConfig getPageConfig(java.lang.String pageId)
           
 java.util.Collection getPages()
           
 PortalCallbackService getPortalCallbackService()
           
 java.lang.String getPortalName()
          Retrieve the name of the portal as should be returned in PortalContext.getPortalInfo()
 PortalURLParser getPortalUrlParser()
           
 java.lang.String getPortalVersion()
          Retrieve the version of the portal as should be returned in PortalContext.getPortalInfo()
 PortletPreferencesService getPortletPreferencesService()
           
 RenderConfigService getRenderConfigService()
           
 java.util.Collection getSupportedPortletModes()
           
 java.util.Collection getSupportedWindowStates()
           
 void init(javax.servlet.ServletContext context)
          Initialization method used to place the driver configuration into service.
 boolean isPortletModeSupported(java.lang.String portletId, java.lang.String mode)
           
 boolean isPortletModeSupportedByPortal(java.lang.String mode)
           
 boolean isPortletModeSupportedByPortlet(java.lang.String portletId, java.lang.String mode)
           
 boolean isWindowStateSupported(java.lang.String portletId, java.lang.String windowState)
           
 boolean isWindowStateSupportedByPortal(java.lang.String windowState)
           
 boolean isWindowStateSupportedByPortlet(java.lang.String portletId, java.lang.String windowState)
           
 

Method Detail

init

void init(javax.servlet.ServletContext context)
          throws DriverConfigurationException
Initialization method used to place the driver configuration into service.

Parameters:
context -
Throws:
DriverConfigurationException - when an error occurs during startup.

destroy

void destroy()
             throws DriverConfigurationException
Shutdown method used to remove the driver configuration from service;

Throws:
DriverConfigurationException - when an error occurs during shutdown.

getPortalName

java.lang.String getPortalName()
Retrieve the name of the portal as should be returned in PortalContext.getPortalInfo()

Returns:
the name of the portal.

getPortalVersion

java.lang.String getPortalVersion()
Retrieve the version of the portal as should be returned in PortalContext.getPortalInfo()

Returns:
the portal version.

getContainerName

java.lang.String getContainerName()
Retrieves the name of the container which pluto should create and embed.

Returns:
the container name.

getSupportedPortletModes

java.util.Collection getSupportedPortletModes()

getSupportedWindowStates

java.util.Collection getSupportedWindowStates()

getPages

java.util.Collection getPages()

getPageConfig

PageConfig getPageConfig(java.lang.String pageId)

isPortletModeSupportedByPortal

boolean isPortletModeSupportedByPortal(java.lang.String mode)

isPortletModeSupportedByPortlet

boolean isPortletModeSupportedByPortlet(java.lang.String portletId,
                                        java.lang.String mode)

isPortletModeSupported

boolean isPortletModeSupported(java.lang.String portletId,
                               java.lang.String mode)

isWindowStateSupportedByPortal

boolean isWindowStateSupportedByPortal(java.lang.String windowState)

isWindowStateSupportedByPortlet

boolean isWindowStateSupportedByPortlet(java.lang.String portletId,
                                        java.lang.String windowState)

isWindowStateSupported

boolean isWindowStateSupported(java.lang.String portletId,
                               java.lang.String windowState)

getPortalCallbackService

PortalCallbackService getPortalCallbackService()

getPortletPreferencesService

PortletPreferencesService getPortletPreferencesService()

getPortalUrlParser

PortalURLParser getPortalUrlParser()

getRenderConfigService

RenderConfigService getRenderConfigService()


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.