Skip navigation links

Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1.1)

E17274-02


oracle.stellent.ridc
Class IdcClientManager

java.lang.Object
  extended by 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.


Field Summary
static java.lang.String HTTP_PROTOCOL
           
static java.lang.String HTTPS_PROTOCOL
           
static java.lang.String IDC_PROTOCOL
           
static java.lang.String IDCS_PROTOCOL
           
static java.lang.String JAXWS_PROTOCOL
           
static java.lang.String WSDL_URL_IDENTIFIER
           

 

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
 IdcClientProvider getProvider(java.lang.String protocol, java.lang.String url)
          Returns the provider based on the protocol as well as the URL.
 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

 

Field Detail

WSDL_URL_IDENTIFIER

public static final java.lang.String WSDL_URL_IDENTIFIER
See Also:
Constant Field Values

IDC_PROTOCOL

public static final java.lang.String IDC_PROTOCOL
See Also:
Constant Field Values

IDCS_PROTOCOL

public static final java.lang.String IDCS_PROTOCOL
See Also:
Constant Field Values

HTTP_PROTOCOL

public static final java.lang.String HTTP_PROTOCOL
See Also:
Constant Field Values

HTTPS_PROTOCOL

public static final java.lang.String HTTPS_PROTOCOL
See Also:
Constant Field Values

JAXWS_PROTOCOL

public static final java.lang.String JAXWS_PROTOCOL
See Also:
Constant Field Values

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

getProvider

public IdcClientProvider getProvider(java.lang.String protocol,
                                     java.lang.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

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()

Skip navigation links

Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1.1)

E17274-02


Copyright © 2008, 2011, Oracle and/or its affiliates. All rights reserved.