oracle.stellent.ridc
Class IdcClientManager

java.lang.Object
  oracle.stellent.ridc.IdcClientManager

public class IdcClientManager
extends java.lang.Object

Manages the IDC clients. Can be used to create new clients by URL and also store and manage instances of the clients by name.

Constructor Summary

IdcClientManager()

Method Summary

void	addClient(java.lang.String name, IdcClient client) Register a client with a given name
IdcClient	createClient(java.lang.String url) Create a new client instance based on the given URL.
IdcClient	getClient(java.lang.String name) Retrieve a client by name
java.util.Collection<java.lang.String>	getClientNames()
ConnectionPoolManager	getConnectionPoolManager()
IdcClientProvider	getProvider(java.lang.String protocol) Retrieve a provider by protocol name
void	registerProvider(java.lang.String protocol, IdcClientProvider provider) Register a provider.
void	removeClient(java.lang.String name) Remove a client by name

Methods inherited from class java.lang.Object

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

Constructor Detail

IdcClientManager

public IdcClientManager()

Method Detail

registerProvider

public void registerProvider(java.lang.String protocol,
                             IdcClientProvider provider)

Register a provider. A provider is responsible for handling the lifecycle of an IdcClient object.

Parameters:

protocol - the protocol of the URL to create the client (i.e. idc, http, etc.)

provider - the provider implementation

getProvider

public IdcClientProvider getProvider(java.lang.String protocol)

Retrieve a provider by protocol name

Parameters:

protocol - the protocol name

Returns:

the client provider or null if not found

getConnectionPoolManager

public ConnectionPoolManager getConnectionPoolManager()

Returns:

an instance of the connection pool mananger

createClient

public IdcClient createClient(java.lang.String url)
                       throws IdcClientException

Create a new client instance based on the given URL.

Parameters:

url - the url to the Content Server

Returns:

the IdcClient instance

Throws:

IdcClientException - if the client cannot be created

getClient

public IdcClient getClient(java.lang.String name)

Retrieve a client by name

Parameters:

name - the client name

Returns:

the client or null if not found

addClient

public void addClient(java.lang.String name,
                      IdcClient client)

Register a client with a given name

Parameters:

name - the client name

client - the client instance

removeClient

public void removeClient(java.lang.String name)

Remove a client by name

Parameters:

name - the client name

getClientNames

public java.util.Collection<java.lang.String> getClientNames()