|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.portlet.GenericPortlet
com.openmarket.Satellite.portlet.BasePortlet
public abstract class BasePortlet
Abstract implementation of a portlet class that invokes Satellite Server functionality. Application lifecycle is managed by this portlet's init and destroy methods.
Constructor Summary | |
---|---|
BasePortlet() |
Method Summary | |
---|---|
protected abstract com.openmarket.Satellite.Application |
constructApp(java.lang.String tempFolder) Return a concrete implementation of a Satellite Server application. |
void |
destroy() Destroys the portlet. |
protected abstract java.lang.String |
getContentType() Return the content type to be used for the response if available. |
protected com.openmarket.Satellite.portlet.SSRenderParams |
getSSRenderParams(javax.portlet.RenderRequest req) Get the SSRenderParams object that holds all request parameters that are sent by Satellite Server to Content Server. |
void |
init(javax.portlet.PortletConfig config) Initializes the portlet. |
void |
processAction(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res) It's not possible to override ProcessAction in the satellite portlet. |
void |
render(javax.portlet.RenderRequest req, javax.portlet.RenderResponse res) Render method is called to render the portlet. |
protected void |
ssProcessAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) This method is called by BasePortlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse) and allows for custom logic to occur at the portlet level prior to the execution of the Satellite Server logic. |
Methods inherited from class javax.portlet.GenericPortlet |
---|
doDispatch, doEdit, doHelp, doView, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BasePortlet()
Method Detail |
---|
protected abstract com.openmarket.Satellite.Application constructApp(java.lang.String tempFolder) throws com.openmarket.Satellite.ConfigurationException
tempFolder
- The temporary folder accessible to this applicationcom.openmarket.Satellite.ConfigurationException
- if application construction failspublic void init(javax.portlet.PortletConfig config) throws javax.portlet.PortletException
init
in interface javax.portlet.Portlet
init
in class javax.portlet.GenericPortlet
config
- input Portlet Config object.javax.portlet.PortletException
public void destroy()
destroy
in interface javax.portlet.Portlet
destroy
in class javax.portlet.GenericPortlet
public final void processAction(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res)
processAction
in interface javax.portlet.Portlet
processAction
in class javax.portlet.GenericPortlet
req
- the portlet ActionRequestres
- the portlet ActionResponseBasePortlet.ssProcessAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
protected void ssProcessAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
BasePortlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
and allows for custom logic to occur at the portlet level prior to the execution of the Satellite Server logic.request
- ActionRequestresponse
- ActionResponseprotected final com.openmarket.Satellite.portlet.SSRenderParams getSSRenderParams(javax.portlet.RenderRequest req)
SSRenderParams.addParameter(java.lang.String, java.lang.String)
method in order to set arbitrary parameters such as context parameters, portal user information and other server-specific information into the request object for the use of Content Server when the portlet is rendered.req
- RenderRequest objectpublic final void render(javax.portlet.RenderRequest req, javax.portlet.RenderResponse res) throws javax.portlet.PortletException, java.io.IOException
render
in interface javax.portlet.Portlet
render
in class javax.portlet.GenericPortlet
req
- render requestres
- render responsejavax.portlet.PortletException
java.io.IOException
protected abstract java.lang.String getContentType()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.