Skip navigation links

oracle.stellent.wcm.core.idc
Class AbstractIdcApi

java.lang.Object
oracle.stellent.wcm.core.idc.AbstractIdcApi

Direct Known Subclasses:

AdminApi, ContentCheckinApi, ContentInfoApi, ContentRetrievalApi, SecurityApi, ServiceApi, SiteStructureApi, SiteStudioApi

public abstract class AbstractIdcApi

extends java.lang.Object

Base class for all RIDC APIs. RIDC API subclasses usually contain specific methods for their business case.

Nested Class Summary

static interface

AbstractIdcApi.IdcApiCallback Allow a hook into the processing of the Idc Api calls

Constructor Summary

protected

AbstractIdcApi(oracle.stellent.ridc.IdcClient idcClient)

Method Summary

protected oracle.stellent.ridc.protocol.ServiceResponse	executeService(oracle.stellent.ridc.IdcContext context, oracle.stellent.ridc.model.DataBinder dataBinder) Execute the service using the databinder.
protected oracle.stellent.ridc.protocol.ServiceResponse	executeService(oracle.stellent.ridc.IdcContext context, java.util.Map<java.lang.String,java.lang.String> parameters) Execute the service using the provided map of parameters.
AbstractIdcApi.IdcApiCallback	getApiCallback()
oracle.stellent.ridc.IdcClient	getIdcClient()
protected oracle.stellent.ridc.model.DataBinder	getResponseBinder(oracle.stellent.ridc.protocol.ServiceResponse response) Retrieve the data binder from the response and handle all errors
protected oracle.stellent.ridc.model.DataBinder	packService(java.util.Map<java.lang.String,java.lang.String> parameters)
void	setApiCallback(AbstractIdcApi.IdcApiCallback apiCallback) Set the API callback
boolean	validateLocalDataInBinder(oracle.stellent.ridc.model.DataBinder binder, java.lang.String... localDataNames) Validate binder and make sure that local values exist in the binder
boolean	validateResultSetInBinder(oracle.stellent.ridc.model.DataBinder binder, java.lang.String... resultSetNames) Validate the binder and make sure that a set of resultsets exist in the binder

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIdcApi

protected AbstractIdcApi(oracle.stellent.ridc.IdcClient idcClient)

Method Detail

getIdcClient

public oracle.stellent.ridc.IdcClient getIdcClient()

Returns:

the IdcClient associated with this API

getApiCallback

public AbstractIdcApi.IdcApiCallback getApiCallback()

Returns:

the API callback or null if not set

setApiCallback

public void setApiCallback(AbstractIdcApi.IdcApiCallback apiCallback)

Set the API callback

Parameters:

apiCallback - the api callback

packService

protected oracle.stellent.ridc.model.DataBinder packService(java.util.Map<java.lang.String,java.lang.String> parameters)

executeService

protected oracle.stellent.ridc.protocol.ServiceResponse executeService(oracle.stellent.ridc.IdcContext context,
                                                                       java.util.Map<java.lang.String,java.lang.String> parameters)
                                                                throws oracle.stellent.ridc.IdcClientException

Execute the service using the provided map of parameters.

Parameters:

context - the user context

parameters - the parameters

Returns:

the response from the server

Throws:

oracle.stellent.ridc.IdcClientException

executeService

protected oracle.stellent.ridc.protocol.ServiceResponse executeService(oracle.stellent.ridc.IdcContext context,
                                                                       oracle.stellent.ridc.model.DataBinder dataBinder)
                                                                throws oracle.stellent.ridc.IdcClientException

Execute the service using the databinder.

Parameters:

context - the user context

dataBinder - the populated databinder

Returns:

the response from the server

Throws:

oracle.stellent.ridc.IdcClientException

validateResultSetInBinder

public boolean validateResultSetInBinder(oracle.stellent.ridc.model.DataBinder binder,
                                         java.lang.String... resultSetNames)
                                  throws oracle.stellent.ridc.IdcClientException

Validate the binder and make sure that a set of resultsets exist in the binder

Parameters:

binder - the response from the server

resultSetNames - the result set names to verify

Returns:

true if the result set names are present

Throws:

oracle.stellent.ridc.IdcClientException

validateLocalDataInBinder

public boolean validateLocalDataInBinder(oracle.stellent.ridc.model.DataBinder binder,
                                         java.lang.String... localDataNames)
                                  throws oracle.stellent.ridc.IdcClientException

Validate binder and make sure that local values exist in the binder

Parameters:

binder - the response from the server

localDataNames - the local data names

Returns:

true if the names are present in the local data

Throws:

oracle.stellent.ridc.IdcClientException

getResponseBinder

protected oracle.stellent.ridc.model.DataBinder getResponseBinder(oracle.stellent.ridc.protocol.ServiceResponse response)
                                                           throws oracle.stellent.ridc.IdcClientException

Retrieve the data binder from the response and handle all errors

Parameters:

response - the response

Returns:

the binder

Throws:

oracle.stellent.ridc.IdcClientException - if an error occurs

Skip navigation links