com.gentics.api.portalnode.plugin
Interface GenticsPlugin

All Superinterfaces:
EventHandler, javax.portlet.Portlet, javax.portlet.PortletConfig, Resolvable
All Known Implementing Classes:
AbstractGenticsPlugin, ViewPlugin

public interface GenticsPlugin
extends Resolvable, EventHandler, javax.portlet.Portlet, javax.portlet.PortletConfig

The GenticsPlugin defines the API of plugins. Plugins provide functionality that can easily be (re-)used inside any Gentics portlet.

Author:
dietmar

Method Summary
 void afterProcessAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
          This method is called by the portal after calling Portlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse) on this plugin.
 EventBroker getEventBroker()
          returns the current event broker
 FileUploadProvider getFileUploadProvider()
          Get the file upload provider.
 java.lang.String getFullPluginName()
          Get the full plugin name (including the portletapplication prefix)
 GenticsPortlet getModule()
          Get the module which registeres and uses this plugin
 void returnFileUploadProvider()
          Return the file upload provider which was fetched via getFileUploadProvider()before
 void setEventBrokerProvider(EventBrokerProvider eventBrokerProvider)
          Set the event broker provider
 void setId(java.lang.String id)
          Set the id of the plugin.
 void setModule(GenticsPortlet module)
          Set the module which registeres and uses this plugin.
 void setPluginName(java.lang.String applicationPrefix, java.lang.String pluginName)
          Set the plugin name
 
Methods inherited from interface com.gentics.api.lib.resolving.Resolvable
canResolve, get, getProperty
 
Methods inherited from interface com.gentics.api.portalnode.event.EventHandler
handleEvent
 
Methods inherited from interface javax.portlet.Portlet
destroy, init, processAction, render
 
Methods inherited from interface javax.portlet.PortletConfig
getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales
 

Method Detail

setEventBrokerProvider

void setEventBrokerProvider(EventBrokerProvider eventBrokerProvider)
Set the event broker provider

Parameters:
eventBrokerProvider -

getEventBroker

EventBroker getEventBroker()
returns the current event broker

Returns:
event broker of this plugin

setModule

void setModule(GenticsPortlet module)
Set the module which registeres and uses this plugin. This is typically done when the plugin is registered with the module via AbstractGenticsPortlet.registerPlugin(String, GenticsPlugin) and need not be called from outside.

Parameters:
module - module using this plugin

getModule

GenticsPortlet getModule()
Get the module which registeres and uses this plugin

Returns:
module using this plugin

setId

void setId(java.lang.String id)
Set the id of the plugin.

Parameters:
id - id of the plugin

afterProcessAction

void afterProcessAction(javax.portlet.ActionRequest request,
                        javax.portlet.ActionResponse response)
This method is called by the portal after calling Portlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse) on this plugin. The plugin implementation of this method may do some cleanup after processing the action.

Parameters:
request - action request
response - action response

getFileUploadProvider

FileUploadProvider getFileUploadProvider()
Get the file upload provider.

Returns:
an instance of FileUploadProvider

returnFileUploadProvider

void returnFileUploadProvider()
Return the file upload provider which was fetched via getFileUploadProvider()before


getFullPluginName

java.lang.String getFullPluginName()
Get the full plugin name (including the portletapplication prefix)

Returns:
full plugin name

setPluginName

void setPluginName(java.lang.String applicationPrefix,
                   java.lang.String pluginName)
Set the plugin name

Parameters:
applicationPrefix - application prefix
pluginName - plugin name


Copyright © 2013 Gentics Software GmbH. All Rights Reserved.