ConnectorInfoManager.java

/*
 * ====================
 * 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://opensource.org/licenses/cddl1.php
 * 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 http://opensource.org/licenses/cddl1.php.
 * 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.util.List;

/**
 * Maintains a list of <code>ConnectorInfo</code> instances, each of which
 * describes a connector that is available.
 *
 * @see ConnectorInfoManagerFactory
 */
public interface ConnectorInfoManager {

    /**
     * Returns the list of <code>ConnectorInfo</code> instances.
     *
     * @return the list of <code>ConnectorInfo</code> instances.
     */
    public List<ConnectorInfo> getConnectorInfos();

    /**
     * Returns the <code>ConnectorInfo</code> that is associated with the
     * specified <code>ConnectorKey</code>.
     *
     * @param key
     *            The key of a connector.
     * @return The <code>ConnectorInfo</code> or <code>null</code> if none was
     *         associated with the specified key.
     */
    public ConnectorInfo findConnectorInfo(ConnectorKey key);
}