fr.toutatice.portail.cms.nuxeo.api.domain

Class AbstractPluginPortlet

java.lang.Object

javax.portlet.GenericPortlet

org.osivia.portal.api.portlet.PortalGenericPortlet

fr.toutatice.portail.cms.nuxeo.api.domain.AbstractPluginPortlet

All Implemented Interfaces:

javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet, org.osivia.portal.api.customization.ICustomizationModule

public abstract class AbstractPluginPortlet
extends org.osivia.portal.api.portlet.PortalGenericPortlet
implements org.osivia.portal.api.customization.ICustomizationModule

Plugin portlet abstract super-class.

See Also:

PortalGenericPortlet, ICustomizationModule

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DEPLOYMENT_ORDER Customization modules repository attribute name.

Fields inherited from class org.osivia.portal.api.portlet.PortalGenericPortlet

CLASS_LOADER_CONTEXT

Fields inherited from interface org.osivia.portal.api.customization.ICustomizationModule

PLUGIN_ID

Constructor Summary

Constructors

Constructor and Description
AbstractPluginPortlet() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addSubtype(org.osivia.portal.api.customization.CustomizationContext context, String parentDocTypeName, String childDocTypeName) Add document subtype.
void	customize(org.osivia.portal.api.customization.CustomizationContext context)
protected abstract void	customizeCMSProperties(org.osivia.portal.api.customization.CustomizationContext context) Generate customization module metadatas.
void	destroy()
protected Map<String,org.osivia.portal.api.cms.DocumentType>	getDocTypes(org.osivia.portal.api.customization.CustomizationContext context) Get document types.
protected List<org.osivia.portal.core.cms.DomainContextualization>	getDomainContextualizations(org.osivia.portal.api.customization.CustomizationContext context) Get domain contextualizations.
protected Map<String,EditableWindow>	getEditableWindows(org.osivia.portal.api.customization.CustomizationContext context) Get the editable windows types
protected Map<String,FormFilter>	getFormFilters(org.osivia.portal.api.customization.CustomizationContext context) Get form filters.
protected List<FragmentType>	getFragmentTypes(org.osivia.portal.api.customization.CustomizationContext context) Get the fragment types.
protected Map<String,ListTemplate>	getListTemplates(org.osivia.portal.api.customization.CustomizationContext context) Get list templates.
protected List<org.osivia.portal.api.menubar.MenubarModule>	getMenubarModules(org.osivia.portal.api.customization.CustomizationContext context) Get menubar modules.
protected SortedMap<String,String>	getMenuTemplates(org.osivia.portal.api.customization.CustomizationContext context) Get menu templates.
protected List<INavigationAdapterModule>	getNavigationAdapters(org.osivia.portal.api.customization.CustomizationContext context) Get navigation adapters.
int	getOrder() Get deployment order.
protected List<org.osivia.portal.api.player.IPlayerModule>	getPlayers(org.osivia.portal.api.customization.CustomizationContext context) Gets the players.
protected abstract String	getPluginName() Get plugin name.
protected Map<String,org.osivia.portal.api.set.SetType>	getSetTypes(org.osivia.portal.api.customization.CustomizationContext context) Get Set types
protected Map<String,org.osivia.portal.api.theming.TabGroup>	getTabGroups(org.osivia.portal.api.customization.CustomizationContext context) Get tab groups.
protected org.osivia.portal.api.taskbar.TaskbarItems	getTaskbarItems(org.osivia.portal.api.customization.CustomizationContext context) Get taskbar items.
org.osivia.portal.api.taskbar.ITaskbarService	getTaskbarService() Getter for taskbarService.
protected List<org.osivia.portal.api.theming.TemplateAdapter>	getTemplateAdapters(org.osivia.portal.api.customization.CustomizationContext context) Get template adapters.
void	init()
void	parseJavaServerPages(String directoryPath, File directory, Map<String,CustomizedJsp> customizedPages) Parse and register customized JavaServer pages.

Methods inherited from class org.osivia.portal.api.portlet.PortalGenericPortlet

addNotification, addNotification, getBundleFactory, getDirectoryService, getMenubarService, getMessage, getMessage, getNotificationsService, getPortalUrlFactory, getTraceService

Methods inherited from class javax.portlet.GenericPortlet

doDispatch, doEdit, doHeaders, doHelp, doView, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, processAction, processEvent, render, serveResource

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEPLOYMENT_ORDER

public static final int DEFAULT_DEPLOYMENT_ORDER

Customization modules repository attribute name.

See Also:

Constant Field Values

Constructor Detail

AbstractPluginPortlet

public AbstractPluginPortlet()

Constructor.

Method Detail

getOrder

public int getOrder()

Get deployment order.

Returns:

order

init

public void init()
          throws javax.portlet.PortletException

Overrides:

init in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

getPluginName

protected abstract String getPluginName()

Get plugin name.

Returns:

plugin name

destroy

public void destroy()

Specified by:

destroy in interface javax.portlet.Portlet

Overrides:

destroy in class javax.portlet.GenericPortlet

parseJavaServerPages

public void parseJavaServerPages(String directoryPath,
                                 File directory,
                                 Map<String,CustomizedJsp> customizedPages)

Parse and register customized JavaServer pages.

Parameters:

directoryPath - directory path

directory - directory

customizedPages - customized JavaServer pages

customize

public void customize(org.osivia.portal.api.customization.CustomizationContext context)

Specified by:

customize in interface org.osivia.portal.api.customization.ICustomizationModule

customizeCMSProperties

protected abstract void customizeCMSProperties(org.osivia.portal.api.customization.CustomizationContext context)

Generate customization module metadatas.

Parameters:

context - customization context

getPlayers

protected List<org.osivia.portal.api.player.IPlayerModule> getPlayers(org.osivia.portal.api.customization.CustomizationContext context)

Gets the players.

Parameters:

context - the context

Returns:

the players

getListTemplates

protected Map<String,ListTemplate> getListTemplates(org.osivia.portal.api.customization.CustomizationContext context)

Get list templates.

Parameters:

context - the context

Returns:

list templates

getDocTypes

protected Map<String,org.osivia.portal.api.cms.DocumentType> getDocTypes(org.osivia.portal.api.customization.CustomizationContext context)

Get document types.

Parameters:

context - customization context

Returns:

document types

addSubtype

protected void addSubtype(org.osivia.portal.api.customization.CustomizationContext context,
                          String parentDocTypeName,
                          String childDocTypeName)

Add document subtype.

Parameters:

context - customization context

parentDocTypeName - parent document type name

childDocTypeName - child document type name

getFragmentTypes

protected List<FragmentType> getFragmentTypes(org.osivia.portal.api.customization.CustomizationContext context)

Get the fragment types.

Parameters:

context - the context

Returns:

the fragment types

getEditableWindows

protected Map<String,EditableWindow> getEditableWindows(org.osivia.portal.api.customization.CustomizationContext context)

Get the editable windows types

Parameters:

context - the context

Returns:

the EW list

getMenubarModules

protected List<org.osivia.portal.api.menubar.MenubarModule> getMenubarModules(org.osivia.portal.api.customization.CustomizationContext context)

Get menubar modules.

Parameters:

context - customization modules

Returns:

menubar modules

getMenuTemplates

protected SortedMap<String,String> getMenuTemplates(org.osivia.portal.api.customization.CustomizationContext context)

Get menu templates.

Parameters:

context - customization context

Returns:

menu templates

getNavigationAdapters

protected List<INavigationAdapterModule> getNavigationAdapters(org.osivia.portal.api.customization.CustomizationContext context)

Get navigation adapters.

Parameters:

context - customization context

Returns:

navigation adapters

getDomainContextualizations

protected List<org.osivia.portal.core.cms.DomainContextualization> getDomainContextualizations(org.osivia.portal.api.customization.CustomizationContext context)

Get domain contextualizations.

Parameters:

context - customization context

Returns:

domain contextualizations

getTabGroups

protected Map<String,org.osivia.portal.api.theming.TabGroup> getTabGroups(org.osivia.portal.api.customization.CustomizationContext context)

Get tab groups.

Parameters:

context - customization context

Returns:

tab groups

getTaskbarItems

protected org.osivia.portal.api.taskbar.TaskbarItems getTaskbarItems(org.osivia.portal.api.customization.CustomizationContext context)

Get taskbar items.

Parameters:

context - customization context

Returns:

taskbar items

getTemplateAdapters

protected List<org.osivia.portal.api.theming.TemplateAdapter> getTemplateAdapters(org.osivia.portal.api.customization.CustomizationContext context)

Get template adapters.

Parameters:

context - customization context

Returns:

template adapters

getFormFilters

protected Map<String,FormFilter> getFormFilters(org.osivia.portal.api.customization.CustomizationContext context)

Get form filters.

Parameters:

context - customization context

Returns:

form filters

getSetTypes

protected Map<String,org.osivia.portal.api.set.SetType> getSetTypes(org.osivia.portal.api.customization.CustomizationContext context)

Get Set types

Parameters:

context - customization context

Returns:

set types

getTaskbarService

public org.osivia.portal.api.taskbar.ITaskbarService getTaskbarService()

Getter for taskbarService.

Returns:

the taskbarService