Package oracle.stellent.ridc

Class IdcClientManager

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 Details

  • Constructor Details

    • IdcClientManager

      @Exported public IdcClientManager()

  • Method Details

    • registerDmsFilter

      @Concealed protected void registerDmsFilter()

    • loadServices

      @Concealed 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

      @Exported public void registerProvider(IdcClientProvider provider)

    • registerProvider

      @Exported 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

      @Exported 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

      @Exported 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

      @Exported public ConnectionPoolManager getConnectionPoolManager()
      Returns:
      an instance of the connection pool manager

    • getFilterManager

      @Exported public IdcFilterManager getFilterManager()
      Returns:
      an instance of the filter manager

    • createClient

      @Exported 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

      @Exported public IdcClient getClient(String name)
      Retrieve a client by name
      Parameters:
      name - the client name
      Returns:
      the client or null if not found

    • addClient

      @Exported public void addClient(String name, IdcClient client)
      Register a client with a given name
      Parameters:
      name - the client name
      client - the client instance

    • removeClient

      @Exported public void removeClient(String name)
      Remove a client by name
      Parameters:
      name - the client name

    • getClientNames

      @Exported public Collection<String> getClientNames()