IDMConnectionFactory.java

/**
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015 ForgeRock AS.
 */

package org.forgerock.openidm.router;

import org.forgerock.json.resource.Connection;
import org.forgerock.json.resource.ConnectionFactory;
import org.forgerock.json.resource.ResourceException;
import org.forgerock.util.promise.Promise;

/**
 * An ConnectionFactory extension that also permits obtaining an "external" Connection
 * which does not wrap the Context with an internal ClientContext.
 */
public interface IDMConnectionFactory extends ConnectionFactory {
    /**
     * Returns a <em><external</em> connection to the JSON resource provider associated
     * with this connection factory. The connection returned by this method
     * can be used immediately.
     *
     * @return An external connection to the JSON resource provider associated with this connection factory.
     * @throws ResourceException If the connection request failed for some reason.
     */
    Connection getExternalConnection() throws ResourceException;

    /**
     * Asynchronously obtains a <em>external</em> connection to the JSON resource provider
     * associated with this connection factory. The returned {@code Promise} can be used
     * to retrieve the completed connection.
     *
     * @return A promise which can be used to retrieve the connection.
     */
    Promise<Connection, ResourceException> getExternalConnectionAsync();
}