|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.restconsumerframework.EnsembleRestAPIService
public class EnsembleRestAPIService
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 |
---|
public static final int ENSEMBLE_PAGELETPARAMETER_MAXLENGTH
protected static final java.lang.String BASEURI
protected static final java.lang.String GETPAGELETS
protected static final java.lang.String LIMITRESULTS
protected static final java.lang.String SEARCHNAME
protected static final java.lang.String SEARCHID
protected static final java.lang.String ROOTNAME_PAGELETLIST
protected static final java.lang.String ROOTNAME_SINGLEPAGELET
protected static final java.lang.String DATAENTRY_PAGELET
public static final java.lang.String NAME
public static final java.lang.String DESCRIPTION
public static final java.lang.String ID
public static final java.lang.String LASTMODIFIED
public static final java.lang.String CREATED
public static final java.lang.String LIBRARYNAME
public static final java.lang.String PARENT_RESOURCE_NAME
public static final java.lang.String PARENT_RESOURCE_DESCRIPTION
public static final java.lang.String PARENT_RESOURCE_ID
public static final java.lang.String PARENT_RESOURCE_EXTURL_LIST
public static final java.lang.String CODESAMPLE
public static final java.lang.String PUBLISHDOCS
public static final java.lang.String ADD_INLINEREFRESH
public static final java.lang.String REFRESH_INTERVAL
public static final java.lang.String URL_SUFFIX
public static final java.lang.String PAGELET_EXTURL
public static final java.lang.String PARAMETERS_TRANSPORT
public static final java.lang.String ALLOW_ALL
public static final java.lang.String PARAMETERS
public static final java.lang.String PARAM_NAME
public static final java.lang.String PARAM_DESCRIPTION
public static final java.lang.String PARAM_ISMANDATORY
Constructor Detail |
---|
public EnsembleRestAPIService()
Method Detail |
---|
protected java.lang.String GetEnsembleBaseUrl(IPTSession session)
session
-
public EnsemblePageletRestData[] GetAllPageletsFromRest(IPTSession session)
session
-
public EnsemblePageletRestData[] GetAllPageletsFromRest(int maxResults, IPTSession session)
maxResults
- Max results to return in the responsesession
-
public EnsemblePageletRestData[] GetPageletWithNameFromRest(java.lang.String pageletName, IPTSession session)
session
-
public EnsemblePageletRestData GetPageletWithIdFromRest(int id, IPTSession session)
id
- session
-
protected void EnsembleAuthenticate(RestRequest request, IPTSession session)
request
- session
- protected boolean VerifyEnsemblePageletListResponse(IRestResponse response)
response
-
protected boolean VerifyEnsemblePageletEntryResponse(IRestResponse response)
response
-
protected EnsemblePageletRestData GetSinglePageletData(IRestResponse response)
response
-
protected EnsemblePageletRestData[] GetPageletListData(IRestResponse response)
response
-
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |