com.plumtree.portaluiinfrastructure.restconsumerframework
Class EnsembleRestAPIService

java.lang.Object
  com.plumtree.portaluiinfrastructure.restconsumerframework.EnsembleRestAPIService

public class EnsembleRestAPIService
extends java.lang.Object

Field Summary

static java.lang.String	ADD_INLINEREFRESH
static java.lang.String	ALLOW_ALL
protected static java.lang.String	BASEURI Rest API URL Parameters
static java.lang.String	CODESAMPLE
static java.lang.String	CREATED
protected static java.lang.String	DATAENTRY_PAGELET
static java.lang.String	DESCRIPTION
static int	ENSEMBLE_PAGELETPARAMETER_MAXLENGTH Ensemble Constants
protected static java.lang.String	GETPAGELETS
static java.lang.String	ID
static java.lang.String	LASTMODIFIED
static java.lang.String	LIBRARYNAME
protected static java.lang.String	LIMITRESULTS
static java.lang.String	NAME Expected Pagelets data node names
static java.lang.String	PAGELET_EXTURL
static java.lang.String	PARAM_DESCRIPTION
static java.lang.String	PARAM_ISMANDATORY
static java.lang.String	PARAM_NAME Pagelet Parameter node names
static java.lang.String	PARAMETERS
static java.lang.String	PARAMETERS_TRANSPORT
static java.lang.String	PARENT_RESOURCE_DESCRIPTION
static java.lang.String	PARENT_RESOURCE_EXTURL_LIST
static java.lang.String	PARENT_RESOURCE_ID
static java.lang.String	PARENT_RESOURCE_NAME
static java.lang.String	PUBLISHDOCS
static java.lang.String	REFRESH_INTERVAL
protected static java.lang.String	ROOTNAME_PAGELETLIST Element names in Rest API Response
protected static java.lang.String	ROOTNAME_SINGLEPAGELET
protected static java.lang.String	SEARCHID
protected static java.lang.String	SEARCHNAME
static java.lang.String	URL_SUFFIX

Constructor Summary

EnsembleRestAPIService()

Method Summary

protected void	EnsembleAuthenticate(RestRequest request, IPTSession session) NOTE: Ensemble moving to use basic auth instead of csp login tokens Set authentication
EnsemblePageletRestData[]	GetAllPageletsFromRest(int maxResults, IPTSession session)
EnsemblePageletRestData[]	GetAllPageletsFromRest(IPTSession session) Get a list of all pagelets from Ensemble Rest API by sending a Rest Request to Ensemble service
protected java.lang.String	GetEnsembleBaseUrl(IPTSession session) Gets the ensemble base url from the ensemble remote server object
protected EnsemblePageletRestData[]	GetPageletListData(IRestResponse response) Internal helper method to get pagelet data in Ensemble Rest API response with a list of pagelets
EnsemblePageletRestData	GetPageletWithIdFromRest(int id, IPTSession session)
EnsemblePageletRestData[]	GetPageletWithNameFromRest(java.lang.String pageletName, IPTSession session) Returns a single pagelet entry specified by its name ?? Pagelet with same name? Partial search on name?
protected EnsemblePageletRestData	GetSinglePageletData(IRestResponse response) Internal helper method to get pagelet data in Ensemble Rest API response with single pagelet Calling method should perform validation that the response contains a list of pagelet data entries
protected boolean	VerifyEnsemblePageletEntryResponse(IRestResponse response) Helper method to verify Ensemble Rest API response with a single pagelet entry Calling method should perform validation that the response contains a single pagelet data entry should
protected boolean	VerifyEnsemblePageletListResponse(IRestResponse response) Helper method to verify Ensemble Rest API response with a list of pagelet entries

Methods inherited from class java.lang.Object

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

Field Detail

ENSEMBLE_PAGELETPARAMETER_MAXLENGTH

public static final int ENSEMBLE_PAGELETPARAMETER_MAXLENGTH

Ensemble Constants

See Also:

Constant Field Values

BASEURI

protected static final java.lang.String BASEURI

Rest API URL Parameters

See Also:

Constant Field Values

GETPAGELETS

protected static final java.lang.String GETPAGELETS

See Also:

Constant Field Values

LIMITRESULTS

protected static final java.lang.String LIMITRESULTS

See Also:

Constant Field Values

SEARCHNAME

protected static final java.lang.String SEARCHNAME

See Also:

Constant Field Values

SEARCHID

protected static final java.lang.String SEARCHID

See Also:

Constant Field Values

ROOTNAME_PAGELETLIST

protected static final java.lang.String ROOTNAME_PAGELETLIST

Element names in Rest API Response

See Also:

Constant Field Values

ROOTNAME_SINGLEPAGELET

protected static final java.lang.String ROOTNAME_SINGLEPAGELET

See Also:

Constant Field Values

DATAENTRY_PAGELET

protected static final java.lang.String DATAENTRY_PAGELET

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Expected Pagelets data node names

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

LASTMODIFIED

public static final java.lang.String LASTMODIFIED

See Also:

Constant Field Values

CREATED

public static final java.lang.String CREATED

See Also:

Constant Field Values

LIBRARYNAME

public static final java.lang.String LIBRARYNAME

See Also:

Constant Field Values

PARENT_RESOURCE_NAME

public static final java.lang.String PARENT_RESOURCE_NAME

See Also:

Constant Field Values

PARENT_RESOURCE_DESCRIPTION

public static final java.lang.String PARENT_RESOURCE_DESCRIPTION

See Also:

Constant Field Values

PARENT_RESOURCE_ID

public static final java.lang.String PARENT_RESOURCE_ID

See Also:

Constant Field Values

PARENT_RESOURCE_EXTURL_LIST

public static final java.lang.String PARENT_RESOURCE_EXTURL_LIST

See Also:

Constant Field Values

CODESAMPLE

public static final java.lang.String CODESAMPLE

See Also:

Constant Field Values

PUBLISHDOCS

public static final java.lang.String PUBLISHDOCS

See Also:

Constant Field Values

ADD_INLINEREFRESH

public static final java.lang.String ADD_INLINEREFRESH

See Also:

Constant Field Values

REFRESH_INTERVAL

public static final java.lang.String REFRESH_INTERVAL

See Also:

Constant Field Values

URL_SUFFIX

public static final java.lang.String URL_SUFFIX

See Also:

Constant Field Values

PAGELET_EXTURL

public static final java.lang.String PAGELET_EXTURL

See Also:

Constant Field Values

PARAMETERS_TRANSPORT

public static final java.lang.String PARAMETERS_TRANSPORT

See Also:

Constant Field Values

ALLOW_ALL

public static final java.lang.String ALLOW_ALL

See Also:

Constant Field Values

PARAMETERS

public static final java.lang.String PARAMETERS

See Also:

Constant Field Values

PARAM_NAME

public static final java.lang.String PARAM_NAME

Pagelet Parameter node names

See Also:

Constant Field Values

PARAM_DESCRIPTION

public static final java.lang.String PARAM_DESCRIPTION

See Also:

Constant Field Values

PARAM_ISMANDATORY

public static final java.lang.String PARAM_ISMANDATORY

See Also:

Constant Field Values

Constructor Detail

EnsembleRestAPIService

public EnsembleRestAPIService()

Method Detail

GetEnsembleBaseUrl

protected java.lang.String GetEnsembleBaseUrl(IPTSession session)

Gets the ensemble base url from the ensemble remote server object

Parameters:

session -

Returns:

GetAllPageletsFromRest

public EnsemblePageletRestData[] GetAllPageletsFromRest(IPTSession session)

Get a list of all pagelets from Ensemble Rest API by sending a Rest Request to Ensemble service

Parameters:

session -

Returns:

GetAllPageletsFromRest

public EnsemblePageletRestData[] GetAllPageletsFromRest(int maxResults,
                                                        IPTSession session)

Parameters:

maxResults - Max results to return in the response

session -

Returns:

null if response is not valid and no data was retrieved

GetPageletWithNameFromRest

public EnsemblePageletRestData[] GetPageletWithNameFromRest(java.lang.String pageletName,
                                                            IPTSession session)

Returns a single pagelet entry specified by its name ?? Pagelet with same name? Partial search on name?

Parameters:

session -

Returns:

m_ensembleServerValid = false;

GetPageletWithIdFromRest

public EnsemblePageletRestData GetPageletWithIdFromRest(int id,
                                                        IPTSession session)

Parameters:

id -

session -

Returns:

EnsembleAuthenticate

protected void EnsembleAuthenticate(RestRequest request,
                                    IPTSession session)

NOTE: Ensemble moving to use basic auth instead of csp login tokens Set authentication

Parameters:

request -

session -

VerifyEnsemblePageletListResponse

protected boolean VerifyEnsemblePageletListResponse(IRestResponse response)

Helper method to verify Ensemble Rest API response with a list of pagelet entries

Parameters:

response -

Returns:

VerifyEnsemblePageletEntryResponse

protected boolean VerifyEnsemblePageletEntryResponse(IRestResponse response)

Helper method to verify Ensemble Rest API response with a single pagelet entry Calling method should perform validation that the response contains a single pagelet data entry should

Parameters:

response -

Returns:

false if response is not valid

GetSinglePageletData

protected EnsemblePageletRestData GetSinglePageletData(IRestResponse response)

Internal helper method to get pagelet data in Ensemble Rest API response with single pagelet Calling method should perform validation that the response contains a list of pagelet data entries

Parameters:

response -

Returns:

null if response is not valid and no data was retrieved

GetPageletListData

protected EnsemblePageletRestData[] GetPageletListData(IRestResponse response)

Internal helper method to get pagelet data in Ensemble Rest API response with a list of pagelets

Parameters:

response -

Returns:

null if response is not valid and no data was retrieved