Package oracle.wcc.ridc.adfca.framework

Class RidcConnectionProvider

java.lang.Object
oracle.wcc.ridc.adfca.framework.RidcConnectionProvider
public class RidcConnectionProvider extends Object

  • Constructor Details

    • RidcConnectionProvider

      public RidcConnectionProvider()

  • Method Details

    • getConnection

      public static RidcConnection getConnection(String connectionName) throws NamingException, IdcClientException
      Obtain from registry of RidcConnection singletons, the RidcConnection with the specified name. The registry of connections (ConcurrentHashMap) is stored in the ADF Application Scope.

      Once a named connection is obtained for the first time and initialized, any subsequent changes to that connection by way of MBean operations will not take effect until either

      1. The application/server is restarted
      2. The connections map is disposed through the RidcConnectionProvider.dispose() method and any existing connection objects held by application code are nullified. Subsequent call to getConnection(..) would result in a fresh connection with latest available properties.

      This method is thread-safe.

      Parameters:
      connectionName - The name of the RIDC ADF Connection
      Returns:
      A singleton RidcConnection instance obtained from the registry for the specified connection name.
      Throws:
      NamingException
      IdcClientException

    • __internalGetConnection

      protected static RidcConnection __internalGetConnection(oracle.adf.share.ADFContext adfContext, String connectionName) throws NamingException
      Lookup from the ADF Connections Context the connection with the specified connection name and return it should it be an instance of an RIDC Connection
      Parameters:
      adfContext - the ADF Context
      connectionName - the name of the RIDC ADF Connection
      Returns:
      a new RidcConnectionImpl matching the specified connection name if it was found; an exception otherwise
      Throws:
      NamingException

    • initializeConnection

      protected static void initializeConnection(RidcConnection conn) throws IdcClientException
      Initialize the RIDC Connection.

      This involves ...

      • best-attempt at validating the connection definition
      • creating the IdcClientManager
      • creating the IdcClient based on the connection url
      • setting the appropriate connection properties on the IdcClient's associated config object

      Parameters:
      conn - The RIDC Connection to initialize
      Throws:
      IdcClientException

    • setConnectionProperties

      protected static void setConnectionProperties(RidcConnection conn, IdcClient client)
      Set the IdcClient's protocol configuration configuration properties.

      Called from initializeConnection(), this method works through the connection's properties and invokes the appropriate setters on the IdcClient's underlying protocol-specific configuration object.

      Parameters:
      conn - The RIDC Connection object to obtain properties from
      client - The IdcClient instance to set properties on

    • setSessionPoolProperties

      protected static void setSessionPoolProperties(RidcConnection conn, IdcClient client)
      Set the Session Pool configuration properties.

      Called from initializeConnection(), this method ensures session pool support if required has suitable configuration

      Parameters:
      conn - The RIDC Connection object
      client - The IdcClient instance

    • dispose

      public static void dispose()
      Dispose the RIDC connections registry object stored in the ADF Application scope.

      Note
      Any existing connection objects stored/held by application code must be released. Such connection objects are not automatically refreshed, nor are they marked dirty.
      Any subsequent call to the getConnection(..) method will result in a fresh connection with latest available properties.

    • listRidcConnections

      public static String[] listRidcConnections() throws NamingException
      Lists all the RIDC connections in the current ADFContext.
      Returns:
      The list of content source names.
      Throws:
      NamingException - If an error occurs listing the connections.

    • validateConnectionDefinition

      protected static void validateConnectionDefinition(RidcConnection conn)
      Performs a best-effort attempt at validating the RIDC Connection object's underlying properties.
      Parameters:
      conn - The RIDC Connection object to validate properties from