org.identityconnectors.framework.api.ConnectorInfoManagerFactory Maven / Gradle / Ivy
/*
* ====================
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
* except in compliance with the License.
*
* You can obtain a copy of the License at
* http://IdentityConnectors.dev.java.net/legal/license.txt
* See the License for the specific language governing permissions and limitations
* under the License.
*
* When distributing the Covered Code, include this CDDL Header Notice in each file
* and include the License file at identityconnectors/legal/license.txt.
* If applicable, add the following below this CDDL Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
* ====================
*/
package org.identityconnectors.framework.api;
import java.net.URL;
import org.identityconnectors.framework.common.exceptions.ConfigurationException;
import org.identityconnectors.framework.common.exceptions.ConnectorException;
/**
* An application's primary entry point into connectors.
* Allows an application to load the connector classes from a set of bundles.
*/
public abstract class ConnectorInfoManagerFactory {
//At some point we might make this pluggable, but for now, hard-code
private static final String IMPL_NAME =
"org.identityconnectors.framework.impl.api.ConnectorInfoManagerFactoryImpl";
private static ConnectorInfoManagerFactory _instance;
/**
* Returns the instance of this factory.
* @return The instance of this factory
*/
public static synchronized ConnectorInfoManagerFactory getInstance() {
if (_instance == null) {
try {
Class clazz = Class.forName(IMPL_NAME);
Object object = clazz.newInstance();
_instance = ConnectorInfoManagerFactory.class.cast(object);
}
catch (Exception e) {
throw ConnectorException.wrap(e);
}
}
return _instance;
}
/**
* 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 {@link #clearLocalCache}.
*
* @param urls The list of bundle URLs. This list may consist of
* directories consisting of un-jarred bundles and/or bundle
* jars.
*
* @return The manager
* @throws ConfigurationException If there was any problem
* with any of the bundles.
*/
public abstract ConnectorInfoManager getLocalManager(URL... urls)
throws ConfigurationException;
/**
* 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 {@link #clearRemoteCache}.
*
* @param info The connection information.
*
* @return The manager
* @throws RuntimeException If there was any problem connecting
*/
public abstract ConnectorInfoManager getRemoteManager(RemoteFrameworkConnectionInfo info)
throws RuntimeException;
/**
* Clears the local bundle manager cache.
* NOTE: Avoid using this method outside of unit testing.
*/
public abstract void clearLocalCache();
/**
* 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.
*/
public abstract void clearRemoteCache();
}