oracle.stellent.ridc

Class IdcClient<TConfig extends IdcClientConfig,TProtocol extends Protocol,TConnection extends Connection>

java.lang.Object

oracle.stellent.ridc.IdcClient<TConfig,TProtocol,TConnection>

Direct Known Subclasses:

IdcHttpClient, IntradocClient, JaxWSClient

@Exported
public abstract class IdcClient<TConfig extends IdcClientConfig,TProtocol extends Protocol,TConnection extends Connection>
extends Object

Represents a connection to a single Content Server.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdcClient(IdcClientManager clientManager, TConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
DataBinder	createBinder()
protected abstract ConnectionManager<TConnection,TConfig>	createConnectionManager() Create the connection manager
protected ConnectionPool<TConnection>	createConnectionPool()
protected abstract TProtocol	createProtocol(ServiceRequest<TConnection> serviceRequest) Create the protocol to handle the request
protected ServiceRequest<TConnection>	createRequest(IdcContext userContext, DataBinder dataBinder, TConnection connection, IdcRequestConfig requestConfig) Create the service request object
protected ServiceResponse	createResponse(ServiceRequest<TConnection> request, Protocol protocol, ServiceResponse response) Analyze the response from the protocol and return
IdcClientManager	getClientManager()
TConfig	getConfig()
ConnectionManager<TConnection,TConfig>	getConnectionManager()
ConnectionPool<TConnection>	getConnectionPool()
DataFactory	getDataFactory()
String	getVersion()
void	initialize() Initialize the client.
boolean	isCompatible(String version) Tests to see if version of RIDC library is compatible with requested version
boolean	isInitialized()
void	logout(IdcContext userContext) Logout
void	logout(IdcContext userContext, IdcRequestConfig requestConfig) Logout
ServiceResponse	sendRequest(IdcContext userContext, DataBinder dataBinder) Execute the request; sends the request to the Content Server and reads the response.
ServiceResponse	sendRequest(IdcContext userContext, DataBinder dataBinder, IdcRequestConfig requestConfig) Execute the request; sends the request to the Content Server and reads the response.
void	setDataFactory(DataFactory dataFactory) Set the data factory for this client
void	setInitialized(boolean initialized)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdcClient

protected IdcClient(IdcClientManager clientManager,
                    TConfig clientConfig)

Method Detail

setInitialized

public void setInitialized(boolean initialized)

initialize

public void initialize()
                throws IdcClientException

Initialize the client. This should be called before any calls to other public methods in the client.

Throws:

IdcClientException

isInitialized

public boolean isInitialized()

Returns:

true if this client has been successfully initialized

getClientManager

public IdcClientManager getClientManager()

Returns:

the IdcClientManager used when the class was created

getDataFactory

public DataFactory getDataFactory()

Returns:

the data factory used to create data objects for this client

createBinder

public DataBinder createBinder()

Returns:

a new data binder

setDataFactory

public void setDataFactory(DataFactory dataFactory)

Set the data factory for this client

Parameters:

dataFactory - the factory used to create the data model objects

getConfig

public TConfig getConfig()

Returns:

the client configuration

getConnectionPool

public ConnectionPool<TConnection> getConnectionPool()
                                              throws ProtocolException

Returns:

the threading model for this client

Throws:

ProtocolException - if the pool cannot be created

getConnectionManager

public ConnectionManager<TConnection,TConfig> getConnectionManager()

Returns:

the manager to create new protocol connections

sendRequest

public ServiceResponse sendRequest(IdcContext userContext,
                                   DataBinder dataBinder)
                            throws IdcClientException

Execute the request; sends the request to the Content Server and reads the response.

Parameters:

userContext - the user context

dataBinder - the data binder object

Returns:

the response

Throws:

IdcClientException

sendRequest

public ServiceResponse sendRequest(IdcContext userContext,
                                   DataBinder dataBinder,
                                   IdcRequestConfig requestConfig)
                            throws IdcClientException

Execute the request; sends the request to the Content Server and reads the response.

Parameters:

userContext - the user context

dataBinder - the data binder object

requestConfig - the request specific configuration / overrides

Returns:

the response

Throws:

IdcClientException

logout

public void logout(IdcContext userContext)
            throws IdcClientException

Logout

Parameters:

userContext - the user context

Throws:

IdcClientException

logout

public void logout(IdcContext userContext,
                   IdcRequestConfig requestConfig)
            throws IdcClientException

Logout

Parameters:

userContext - the user context

requestConfig - the request specific configuration / overrides

Throws:

IdcClientException

createProtocol

protected abstract TProtocol createProtocol(ServiceRequest<TConnection> serviceRequest)
                                     throws ProtocolException

Create the protocol to handle the request

Parameters:

serviceRequest - the service request

Returns:

the protocol handler

Throws:

ProtocolException

createConnectionManager

protected abstract ConnectionManager<TConnection,TConfig> createConnectionManager()

Create the connection manager

Returns:

a new connection manager

createRequest

protected ServiceRequest<TConnection> createRequest(IdcContext userContext,
                                                    DataBinder dataBinder,
                                                    TConnection connection,
                                                    IdcRequestConfig requestConfig)

Create the service request object

Parameters:

userContext - the user context

dataBinder - the data binder

connection - the connection

requestConfig - the request specific configuration / overrides

Returns:

a new service request object

createResponse

protected ServiceResponse createResponse(ServiceRequest<TConnection> request,
                                         Protocol protocol,
                                         ServiceResponse response)

Analyze the response from the protocol and return

Parameters:

request - the request object

protocol - the protocol handler

response - the response from the protocol handler

Returns:

the service response object to return to the user

createConnectionPool

protected ConnectionPool<TConnection> createConnectionPool()
                                                    throws ProtocolException

Returns:

the threading model to use for this client

Throws:

ProtocolException - if the pool cannot be created

getVersion

public String getVersion()

Returns:

Version of RIDC library

isCompatible

public boolean isCompatible(String version)

Tests to see if version of RIDC library is compatible with requested version

Parameters:

version - required version of library

Returns:

true if library is compatible