com.openmarket.Satellite.portlet
Class Satellite

java.lang.Object
  GenericPortlet
      com.openmarket.Satellite.portlet.BasePortlet
          com.openmarket.Satellite.portlet.Satellite

public class Satellite
extends BasePortlet

Base class for portlets that access Content Server through Satellite Server. It operates by passing parameters destined for this portlet to the Satellite Server application which will either retrieve the content from cache or fetch it from Content Server. This portlet does not have direct access to Content Server or any of its functionality. To access Content Server functionality, write pages and elements using standard practices. If the content needs to be dynamic, uncached pages or pagelets are suitable and supported. Cached pages and pagelets are also supported by this portlet. If Content Server functionality is required in a portlet class directly, then extend CSPortlet instead of this class. To create a standard portlet that requires nothing other than an input pagename, configure your portlet using this class as the portlet class and specify a portlet init parameter named Constants#CONFIG_RENDERPAGE, Constants#CONFIG_EDITPAGE, and Constants#CONFIG_HELPPAGE for view, edit, and help portlet modes, respectively. If more advanced processing is required, such as setting additional parameters into the portlet request, override BasePortlet.ssProcessAction(ActionRequest, ActionResponse), Satellite.doView(RenderRequest, RenderResponse),Satellite.doEdit(RenderRequest, RenderResponse), Satellite.doHelp(RenderRequest, RenderResponse), Satellite.getRenderPage(RenderRequest, RenderResponse), Satellite.getEditPage(RenderRequest, RenderResponse), or Satellite.getHelpPage(RenderRequest, RenderResponse) and set the parameters using BasePortlet.getSSRenderParams(RenderRequest) and SSRenderParams#addParameter.

Since:

16-May-2005 12:09:38 PM

Constructor Summary

Satellite()

Method Summary

protected Application	constructApp(java.lang.String tempFolder) Return a concrete implementation of a Satellite Server application.
protected void	doEdit(RenderRequest request, RenderResponse response) Implementation of GenericPortlet.doEdit that dispatches to a ContentServer page.
protected void	doHelp(RenderRequest request, RenderResponse response) Implementation of GenericPortlet.doHelp that dispatches to a ContentServer page.
protected void	doView(RenderRequest request, RenderResponse response) Implementation of GenericPortlet.doView that dispatches to a ContentServer page.
protected java.lang.String	getContentType() Content type is not set by this method; rather, the application itself is allowed to set it.
protected java.lang.String	getEditPage(RenderRequest request, RenderResponse response) Get the default CS pagename to handle edit mode render requests for this portlet.
protected java.lang.String	getHelpPage(RenderRequest request, RenderResponse response) Get the default CS pagename to handle help mode render requests for this portlet.
protected java.lang.String	getRenderPage(RenderRequest request, RenderResponse response) Get the default CS pagename to handle render requests for this portlet.

Methods inherited from class com.openmarket.Satellite.portlet.BasePortlet

destroy, getSSRenderParams, init, processAction, render, ssProcessAction

Methods inherited from class java.lang.Object

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

Constructor Detail

Satellite

public Satellite()

Method Detail

constructApp

protected Application constructApp(java.lang.String tempFolder)
                            throws ConfigurationException

Description copied from class: BasePortlet

Return a concrete implementation of a Satellite Server application. This portlet will hold on to the application for its lifecycle.

Specified by:

constructApp in class BasePortlet

Parameters:

tempFolder - The temporary folder accessible to this application

Returns:

application instance

Throws:

ConfigurationException - if application construction fails

getContentType

protected java.lang.String getContentType()

Content type is not set by this method; rather, the application itself is allowed to set it. Content Server usually sets a default value if none has been set in the page.

Specified by:

getContentType in class BasePortlet

Returns:

null, always.

getRenderPage

protected java.lang.String getRenderPage(RenderRequest request,
                                         RenderResponse response)

Get the default CS pagename to handle render requests for this portlet. The value returned by this method will be used if no parameter has been found in the RenderRequest named Constants#PARAM_RENDERPAGENAME. The default implementation looks up a portlet init parameter named Constants#CONFIG_EDITPAGE.

Parameters:

request - The RenderRequest for the current request to render

response - The RenderResponse for the current request to render

Returns:

The default pagename to handle render requests for this portlet.

getEditPage

protected java.lang.String getEditPage(RenderRequest request,
                                       RenderResponse response)

Get the default CS pagename to handle edit mode render requests for this portlet. The value returned by this method will be used if no parameter has been found in the RenderRequest named Constants#PARAM_RENDERPAGENAME. The default implementation looks up a portlet init parameter named Constants#CONFIG_EDITPAGE.

Parameters:

request - The RenderRequest for the current request to render

response - The RenderResponse for the current request to render

Returns:

The default pagename to handle edit mode render requests for this portlet.

getHelpPage

protected java.lang.String getHelpPage(RenderRequest request,
                                       RenderResponse response)

Get the default CS pagename to handle help mode render requests for this portlet. The value returned by this method will be used if no parameter has been found in the RenderRequest named Constants#PARAM_RENDERPAGENAME. The default implementation looks up a portlet init parameter named Constants#CONFIG_HELPPAGE.

Parameters:

request - The RenderRequest for the current request to render

response - The RenderResponse for the current request to render

Returns:

The default pagename to handle help mode render requests for this portlet.

doView

protected void doView(RenderRequest request,
                      RenderResponse response)

Implementation of GenericPortlet.doView that dispatches to a ContentServer page. Overriding classes must set the target page for Satellite Server to render, either by calling this method, or by explicitly setting a render parameter called Constants#PARAM_RENDERPAGENAME using BasePortlet.getSSRenderParams(RenderRequest).

Parameters:

request - The portlet RenderRequest

response - The portlet RenderResponse

See Also:

Satellite.getRenderPage(RenderRequest, RenderResponse), Constants#PARAM_RENDERPAGENAME, BasePortlet.getSSRenderParams(RenderRequest)

doEdit

protected void doEdit(RenderRequest request,
                      RenderResponse response)

Implementation of GenericPortlet.doEdit that dispatches to a ContentServer page. Overriding classes must set the target page for Satellite Server to render, either by calling this method, or by explicitly setting a render parameter called Constants#PARAM_RENDERPAGENAME using BasePortlet.getSSRenderParams(RenderRequest).

Parameters:

request - The portlet RenderRequest

response - The portlet RenderResponse

See Also:

Satellite.getEditPage(RenderRequest, RenderResponse), Constants#PARAM_RENDERPAGENAME, BasePortlet.getSSRenderParams(RenderRequest)

doHelp

protected void doHelp(RenderRequest request,
                      RenderResponse response)

Implementation of GenericPortlet.doHelp that dispatches to a ContentServer page. Overriding classes must set the target page for Satellite Server to render, either by calling this method, or by explicitly setting a render parameter called Constants#PARAM_RENDERPAGENAME using BasePortlet.getSSRenderParams(RenderRequest).

Parameters:

request - The portlet RenderRequest

response - The portlet RenderResponse

See Also:

Satellite.getHelpPage(RenderRequest, RenderResponse), Constants#PARAM_RENDERPAGENAME, BasePortlet.getSSRenderParams(RenderRequest)