IdcClientManager (Oracle Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC))

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

Direct Known Subclasses:

SimpleIdcClientManager
```
public class IdcClientManager
extends 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.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HTTP_PROTOCOL`
`static String`	`HTTPS_PROTOCOL`
`static String`	`IDC_PROTOCOL`
`static String`	`IDCS_PROTOCOL`
`static String`	`JAXWS_PROTOCOL`
`static String`	`WSDL_URL_IDENTIFIER`

Constructor Summary

Constructors
Constructor and Description

IdcClientManager()

Constructors
Constructor and Description
`IdcClientManager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClient(String name, IdcClient client)` Register a client with a given name
`IdcClient`	`createClient(String url)` Create a new client instance based on the given URL.
`IdcClient`	`getClient(String name)` Retrieve a client by name
`Collection<String>`	`getClientNames()`
`ConnectionPoolManager`	`getConnectionPoolManager()`
`IdcFilterManager`	`getFilterManager()`
`IdcClientProvider`	`getProvider(String protocol)` Retrieve a provider by protocol name
`IdcClientProvider`	`getProvider(String protocol, String url)` Returns the provider based on the protocol as well as the URL.
`<T> Iterable<T>`	`loadServices(Class<T> service)` Loads implementations of a specific interface or class.
`protected void`	`registerDmsFilter()`
`void`	`registerProvider(IdcClientProvider provider)`
`void`	`registerProvider(String protocol, IdcClientProvider provider)` Register a provider.
`void`	`removeClient(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

- Field Detail
  - WSDL_URL_IDENTIFIER
```
public static final String WSDL_URL_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - IDC_PROTOCOL
```
public static final String IDC_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - IDCS_PROTOCOL
```
public static final String IDCS_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - HTTP_PROTOCOL
```
public static final String HTTP_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - HTTPS_PROTOCOL
```
public static final String HTTPS_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - JAXWS_PROTOCOL
```
public static final String JAXWS_PROTOCOL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IdcClientManager
```
public IdcClientManager()
```
- Method Detail
  - registerDmsFilter
```
protected void registerDmsFilter()
```
  - loadServices
```
public <T> Iterable<T> loadServices(Class<T> service)
```
    Loads implementations of a specific interface or class.
    The default implementation of this method uses ServiceLoader.load(Class), but this can be overriden in subclasses to use a different mechanism
    
    Parameters:
    
    service - The interface or abstract class representing the service
    
    Returns:
    
    A new service loader
  - registerProvider
```
public void registerProvider(IdcClientProvider provider)
```
  - registerProvider
```
public void registerProvider(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(String protocol)
```
    Retrieve a provider by protocol name
    
    Parameters:
    
    protocol - the protocol name
    
    Returns:
    
    the client provider or null if not found
  - getProvider
```
public IdcClientProvider getProvider(String protocol,
                                     String url)
```
    Returns the provider based on the protocol as well as the URL.
    
    Parameters:
    
    protocol - the protocol name
    
    url - the url that the client is accessing
    
    Returns:
    
    the provider, or null
  - getConnectionPoolManager
```
public ConnectionPoolManager getConnectionPoolManager()
```
    Returns:
    
    an instance of the connection pool manager
  - getFilterManager
```
public IdcFilterManager getFilterManager()
```
    Returns:
    
    an instance of the filter manager
  - createClient
```
public IdcClient createClient(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(String name)
```
    Retrieve a client by name
    
    Parameters:
    
    name - the client name
    
    Returns:
    
    the client or null if not found
  - addClient
```
public void addClient(String name,
                      IdcClient client)
```
    Register a client with a given name
    
    Parameters:
    
    name - the client name
    
    client - the client instance
  - removeClient
```
public void removeClient(String name)
```
    Remove a client by name
    
    Parameters:
    
    name - the client name
  - getClientNames
```
public Collection<String> getClientNames()
```

Class IdcClientManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WSDL_URL_IDENTIFIER

IDC_PROTOCOL

IDCS_PROTOCOL

HTTP_PROTOCOL

HTTPS_PROTOCOL

JAXWS_PROTOCOL

Constructor Detail

IdcClientManager

Method Detail

registerDmsFilter

loadServices

registerProvider

registerProvider

getProvider

getProvider

getConnectionPoolManager

getFilterManager

createClient

getClient

addClient

removeClient

getClientNames