/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
* add the following below this CDDL HEADER, with the fields enclosed
|
* by brackets "[]" replaced with your own identifying information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2009 Sun Microsystems, Inc.
|
*/
|
|
package org.opends.sdk;
|
|
|
|
import org.opends.sdk.responses.Responses;
|
import org.opends.sdk.responses.Result;
|
|
|
|
/**
|
* This class provides a skeletal implementation of the {@code
|
* ConnectionFactory} interface, to minimize the effort required to
|
* implement this interface.
|
*
|
* @param <C>
|
* The type of asynchronous connection returned by this
|
* connection factory.
|
*/
|
public abstract class AbstractConnectionFactory<C extends AsynchronousConnection>
|
implements ConnectionFactory<C>
|
{
|
/**
|
* Creates a new abstract connection factory.
|
*/
|
protected AbstractConnectionFactory()
|
{
|
// Nothing to do.
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public abstract FutureResult<? extends C> getAsynchronousConnection(
|
ResultHandler<? super C> handler);
|
|
|
|
/**
|
* {@inheritDoc}
|
* <p>
|
* The default implementation is to convert the asynchronous
|
* connection returned from {@code
|
* blockingGetAsynchronousConnection()} to a synchronous connection
|
* using a {@link SynchronousConnection} as per the following code:
|
*
|
* <pre>
|
* return new SynchronousConnection(blockingGetAsynchronousConnection());
|
* </pre>
|
*
|
* Implementations should override this method if they wish to return
|
* a different type of synchronous connection.
|
*
|
* @return A connection to the Directory Server associated with this
|
* connection factory.
|
* @throws ErrorResultException
|
* If the connection request failed for some reason.
|
*/
|
public Connection getConnection() throws ErrorResultException
|
{
|
return new SynchronousConnection(
|
blockingGetAsynchronousConnection());
|
}
|
|
|
|
/**
|
* Invokes {@code getAsynchronousConnection}, blocking until the
|
* asynchronous connection is obtained or the attempt fails.
|
*
|
* @return An asynchronous connection obtained using {@code
|
* getAsynchronousConnection}.
|
* @throws ErrorResultException
|
* If the connection request failed for some reason.
|
*/
|
protected final C blockingGetAsynchronousConnection()
|
throws ErrorResultException
|
{
|
FutureResult<? extends C> future = getAsynchronousConnection(null);
|
try
|
{
|
return future.get();
|
}
|
catch (InterruptedException e)
|
{
|
// Cancel the request if possible.
|
future.cancel(false);
|
|
Result result = Responses.newResult(
|
ResultCode.CLIENT_SIDE_CONNECT_ERROR).setCause(e)
|
.setDiagnosticMessage(e.getLocalizedMessage());
|
throw ErrorResultException.wrap(result);
|
}
|
}
|
}
|
