com.sage.orion.sdata.servlet
Class PortletResource

java.lang.Object
  com.sage.orion.sdata.servlet.PortletResource

public final class PortletResource
extends java.lang.Object

A utility class that provides the service of getting a single portlet information object given a portlet ID.

Use getInstance() to access the instance of this class.

Call initialize(SDataProvider, String) to initialize the instance of this class.

Method Summary

static PortletResource	getInstance()
java.util.Map<java.lang.String,SDataResourceElement>	getPortletInfo(java.lang.String id, java.lang.String authorizationToken, SDataServer server) Gets the portlet information object for the portlet with the specified ID.
void	initialize(SDataProvider sdataProvider, java.lang.String resourceKindName) Handle any initialization required by this class.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PortletResource getInstance()

Returns:

The unique instance of this class.

initialize

public void initialize(SDataProvider sdataProvider,
                       java.lang.String resourceKindName)

Handle any initialization required by this class.

Parameters:

sdataProvider - the SDataProvider that provides the data for the portlet lookup

resourceKindName - the name of the Resource Kind that handles the request for getting the portlet

getPortletInfo

public java.util.Map<java.lang.String,SDataResourceElement> getPortletInfo(java.lang.String id,
                                                                           java.lang.String authorizationToken,
                                                                           SDataServer server)

Gets the portlet information object for the portlet with the specified ID.

Parameters:

id - The ID of the portlet we want to get.

authorizationToken - The authorizationToken from the input SDataRequest.

server - The server information from the input SDataRequest.

Returns:

A portlet information object representing the portlet in question.