Package org.identityconnectors.framework.api

Class ConnectorInfoManagerFactory

  • public abstract class ConnectorInfoManagerFactory
extends Object
    An application's primary entry point into connectors. Allows an application to load the connector classes from a set of bundles.

    • Constructor Detail

      • ConnectorInfoManagerFactory

        public ConnectorInfoManagerFactory()

    • Method Detail

      • getInstance

        public static ConnectorInfoManagerFactory getInstance()
        Returns the instance of this factory.
        Returns:
        The instance of this factory

      • getLocalManager

        public abstract ConnectorInfoManager getLocalManager​(URL... urls)
        Creates the ConnectorInfoManager from a list of bundle URLs.

        NOTE: The results from this call are automatically cached and keyed by the list of URLs passed in. To clear the cache, call clearLocalCache().

        Parameters:
        urls - The list of bundle URLs. This list may consist of directories consisting of un-jarred bundles and/or bundle jars.
        Returns:
        The manager
        Throws:
        ConfigurationException - If there was any problem with any of the bundles.

      • getRemoteManager

        public abstract ConnectorInfoManager getRemoteManager​(RemoteFrameworkConnectionInfo info)
        Creates the ConnectorInfoManager for a remote framework.

        NOTE: The results from this call are automatically cached and keyed by the RemoteFrameworkConnectionInfo passed in. To clear the cache, call clearRemoteCache().

        Parameters:
        info - The connection information.
        Returns:
        The manager
        Throws:
        RuntimeException - If there was any problem connecting

      • getUnCheckedRemoteManager

        public abstract ConnectorInfoManager getUnCheckedRemoteManager​(RemoteFrameworkConnectionInfo info)
        Creates the ConnectorInfoManager for a remote framework but the connection is not checked and not initialised.

        NOTICE: This method is an early specification of the Events API for 1.2.x.x version. Use carefully, this package may change before the final 1.2.0.0 release.

        As now the ConnectorInfoManager MUST implement the Runnable to connect to the remote connector server. NOTE: The results from this call are automatically cached and keyed by the RemoteFrameworkConnectionInfo passed in. To clear the cache, call clearRemoteCache().

        Parameters:
        info - The connection information.
        Returns:
        The manager
        Since:
        1.2

      • clearLocalCache

        public abstract void clearLocalCache()
        Clears the local bundle manager cache. NOTE: Avoid using this method outside of unit testing.

      • clearRemoteCache

        public abstract void clearRemoteCache()
        Clears the remote cache. There should be an admin page function which exposes this method for the case where you drop in a new connector in the connector server and reset it.