public interface GenticsPluginServer
Modifier and Type | Method and Description |
---|---|
void |
afterProcessPluginAction(java.lang.String PluginID,
javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse)
process the afterProcessAction of the given plugin
|
GenticsPlugin |
getPlugin(java.lang.String Id)
returns a plugin from the server (if registered), or else null
|
void |
onPluginEvent(EventRequest eventRequest,
EventResponse eventResponse)
onPluginEvent will be called everytime a plugin triggers an event
|
void |
processPluginAction(java.lang.String PluginID,
javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse)
processes a plugin action the pluginserver needs to distribute actions to
its plugins
|
void |
registerPlugin(java.lang.String Id,
GenticsPlugin plugin)
allows to register plugins to the server so he can further distribute
events and forward actions as well as provide rendering facility
|
java.lang.String |
renderPlugin(java.lang.String Id,
javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
renders a plugin specified by the pluginid it provides the plugin with a
adapted request and response so it can only see its own variables
|
void |
unregisterPlugin(java.lang.String id)
Unregister the plugin with the given id.
|
void registerPlugin(java.lang.String Id, GenticsPlugin plugin)
Id
- the pluginidplugin
- the pluginvoid unregisterPlugin(java.lang.String id)
id
- id of the plugin to unregisterGenticsPlugin getPlugin(java.lang.String Id)
Id
- pluginidjava.lang.String renderPlugin(java.lang.String Id, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, java.io.IOException
Id
- plugin idrequest
- the request of the module callingresponse
- the response of the calling modulejavax.portlet.PortletException
- an exception if anything in terms of processing
goes wrongjava.io.IOException
- any i/o problemsvoid onPluginEvent(EventRequest eventRequest, EventResponse eventResponse)
eventRequest
- the event requesteventResponse
- the event responsevoid processPluginAction(java.lang.String PluginID, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse) throws javax.portlet.PortletException, java.io.IOException
PluginID
- pluginidactionRequest
- requestactionResponse
- responsejavax.portlet.PortletException
- any processing problemjava.io.IOException
- any i/o problemvoid afterProcessPluginAction(java.lang.String PluginID, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse) throws javax.portlet.PortletException, java.io.IOException
PluginID
- pluginidactionRequest
- requestactionResponse
- responsejavax.portlet.PortletException
java.io.IOException
Copyright © 2019 Gentics Software. All Rights Reserved.