senselogic.sitevision.api.portlet

Class GenericSiteVisionPortlet

Object

GenericPortlet

senselogic.sitevision.api.portlet.GenericSiteVisionPortlet

All Implemented Interfaces:

EventPortlet, Portlet, PortletConfig, ResourceServingPortlet

Direct Known Subclasses:

GenericConfigPortlet

Deprecated.

portlet applications are the legacy way of extending Sitevision. WebApp/RESTApp technique should be used instead as of Sitevision 5. This class will be removed in a future version of Sitevision.

@Deprecated
public abstract class GenericSiteVisionPortlet
extends GenericPortlet

This class that can be extended when creating GenericPortlet-based portlets that needs easy access to the Sitevision API.

Since:

Sitevision 3.0

Author:

Magnus Lövgren

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericSiteVisionPortlet() Deprecated. Does nothing and should not be explicitly called.

Method Summary

Modifier and Type	Method and Description
protected Session	getJcrSession(PortletRequest aPortletRequest) Deprecated. Convenience method that gets the Session instance from a portlet request.
protected Utils	getUtils(PortletRequest aPortletRequest) Deprecated. Convenience method that gets the Utils instance from a portlet request.
protected PrintWriter	getWriter(RenderResponse aRenderResponse) Deprecated. Convenience method that sets the text/html content type and gets the render response writer.
protected PrintWriter	getWriter(ResourceResponse aResourceResponse) Deprecated. Convenience method that sets the application/json content type with UTF-8 charset and gets the resource response writer.

Methods inherited from class GenericPortlet

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

Methods inherited from class Object

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

Constructor Detail

GenericSiteVisionPortlet

protected GenericSiteVisionPortlet()

Deprecated.

Does nothing and should not be explicitly called.

A portlet class constructor should only be invoked by the Sitevision portlet container. Portlet initial state should be implemented via any of the init methods!

Method Detail

getUtils

protected Utils getUtils(PortletRequest aPortletRequest)

Deprecated.

Convenience method that gets the Utils instance from a portlet request.

Parameters:

aPortletRequest - a portlet request

Returns:

an Utils instance, null if aPortletRequest is null

getJcrSession

protected Session getJcrSession(PortletRequest aPortletRequest)

Deprecated.

Convenience method that gets the Session instance from a portlet request.

Parameters:

aPortletRequest - a portlet request

Returns:

a Session instance, null if aPortletRequest is null

getWriter

protected PrintWriter getWriter(RenderResponse aRenderResponse)
                         throws IOException

Deprecated.

Convenience method that sets the text/html content type and gets the render response writer.

The portlet specification states that the content type for the render response must be set before obtaining the response writer. This convenience method ensures that.

     aRenderResponse.setContentType("text/html");
     return aRenderResponse.getWriter();

Note! This method should be called only once during your rendering process (and you should of course only use this method if you render content with the text/html content type).

Parameters:

aRenderResponse - a render response

Returns:

the aRenderResponse writer, null if aRenderResponse is null

Throws:

IOException - if an input or output exception occurred

IllegalStateException - if the getPortletOutputStream method has been called on aRenderResponse

getWriter

protected PrintWriter getWriter(ResourceResponse aResourceResponse)
                         throws IOException

Deprecated.

Convenience method that sets the application/json content type with UTF-8 charset and gets the resource response writer.

The portlet specification states that the content type for the resource response must be set before obtaining the response writer. This convenience method ensures that.

     aResourceResponse.setContentType("application/json");
     aResourceResponse.setCharacterEncoding("UTF-8");
     return aResourceResponse.getWriter();

Note! This method should be called only once during your serve resource process (and you should of course only use this method if you serve a UTF-8 resource with the application/json content type).

Parameters:

aResourceResponse - a resource response

Returns:

the aResourceResponse writer, null if aResourceResponse is null

Throws:

IOException - if an input or output exception occurred

IllegalStateException - if the getPortletOutputStream method has been called on aResourceResponse

Since:

Sitevision 4.0