org.apache.jetspeed.factory
Interface PortletFactory

public interface PortletFactory

PortletFactory

Version:

$Id: PortletFactory.java 918551 2010-03-03 16:27:47Z woonsan $

Author:

Scott T. Weaver

Method Summary

java.lang.ClassLoader	getPortletApplicationClassLoader(PortletApplication pa)
java.util.List<javax.portlet.PortletURLGenerationListener>	getPortletApplicationListeners(PortletApplication pa)
PortletFilterInstance	getPortletFilterInstance(PortletApplication pa, java.lang.String filterName)
PortletInstance	getPortletInstance(javax.servlet.ServletContext servletContext, PortletDefinition pd)
PortletInstance	getPortletInstance(javax.servlet.ServletContext servletContext, PortletDefinition pd, boolean noProxy)
javax.portlet.PreferencesValidator	getPreferencesValidator(PortletDefinition pd)
java.util.ResourceBundle	getResourceBundle(PortletApplication pa, java.util.Locale locale)
java.util.ResourceBundle	getResourceBundle(PortletDefinition pd, java.util.Locale locale)
boolean	hasRenderHelperMethod(PortletDefinition pd, javax.portlet.PortletMode mode) Returns true when the portlet class is type of javax.portlet.GenericPortlet and it contains a helper method for the portlet mode with public access.
boolean	isPortletApplicationRegistered(PortletApplication pa)
void	registerPortletApplication(PortletApplication pa, java.lang.ClassLoader paClassLoader)
void	reloadResourceBundles(PortletApplication pa) Tries to reload resource bundles of portlet application.
void	reloadResourceBundles(PortletDefinition pd) Tries to reload resource bundles of portlet definition.
void	setPortalContext(PortalContext portalContext)
void	unregisterPortletApplication(PortletApplication pa)
void	updatePortletConfig(PortletDefinition pd)

Method Detail

setPortalContext

void setPortalContext(PortalContext portalContext)

registerPortletApplication

void registerPortletApplication(PortletApplication pa,
                                java.lang.ClassLoader paClassLoader)

unregisterPortletApplication

void unregisterPortletApplication(PortletApplication pa)

isPortletApplicationRegistered

boolean isPortletApplicationRegistered(PortletApplication pa)

getPortletApplicationClassLoader

java.lang.ClassLoader getPortletApplicationClassLoader(PortletApplication pa)

getPortletInstance

PortletInstance getPortletInstance(javax.servlet.ServletContext servletContext,
                                   PortletDefinition pd)
                                   throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

getPortletInstance

PortletInstance getPortletInstance(javax.servlet.ServletContext servletContext,
                                   PortletDefinition pd,
                                   boolean noProxy)
                                   throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

getPreferencesValidator

javax.portlet.PreferencesValidator getPreferencesValidator(PortletDefinition pd)

updatePortletConfig

void updatePortletConfig(PortletDefinition pd)

getResourceBundle

java.util.ResourceBundle getResourceBundle(PortletApplication pa,
                                           java.util.Locale locale)

getResourceBundle

java.util.ResourceBundle getResourceBundle(PortletDefinition pd,
                                           java.util.Locale locale)

getPortletApplicationListeners

java.util.List<javax.portlet.PortletURLGenerationListener> getPortletApplicationListeners(PortletApplication pa)
                                                                                          throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

getPortletFilterInstance

PortletFilterInstance getPortletFilterInstance(PortletApplication pa,
                                               java.lang.String filterName)
                                               throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

hasRenderHelperMethod

boolean hasRenderHelperMethod(PortletDefinition pd,
                              javax.portlet.PortletMode mode)

Returns true when the portlet class is type of javax.portlet.GenericPortlet and it contains a helper method for the portlet mode with public access.

The helper methods can be overriden from the javax.portlet.GenericPortlet such as the following methods or annotated with @RenderMode (javax.portlet.RenderMode).

• doView for handling view requests
• doEdit for handling edit requests
• doHelp for handling help requests

Parameters:

mode -

Returns:

See Also:

RenderMode, GenericPortlet.doView(RenderRequest, RenderResponse), GenericPortlet.doEdit(RenderRequest, RenderResponse), GenericPortlet.doHelp(RenderRequest, RenderResponse)

reloadResourceBundles

void reloadResourceBundles(PortletApplication pa)
                           throws javax.portlet.PortletException

Tries to reload resource bundles of portlet application.

Parameters:

pa - portlet application

Throws:

javax.portlet.PortletException

reloadResourceBundles

void reloadResourceBundles(PortletDefinition pd)
                           throws javax.portlet.PortletException

Tries to reload resource bundles of portlet definition.

Parameters:

pd - portlet definition

Throws:

javax.portlet.PortletException