/*
|
* 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/opendj3/legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* 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/opendj3/legal-notices/CDDLv1_0.txt. 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 2010 Sun Microsystems, Inc.
|
* Portions copyright 2011 ForgeRock AS.
|
*/
|
|
package org.forgerock.opendj.ldap;
|
|
|
|
import com.forgerock.opendj.ldap.InternalConnection;
|
import com.forgerock.opendj.util.CompletedFutureResult;
|
|
|
|
/**
|
* A special {@code ConnectionFactory} which waits for internal connection
|
* requests and binds them to a {@link ServerConnection} created using the
|
* provided {@link ServerConnectionFactory}.
|
* <p>
|
* When processing requests, {@code ServerConnection} implementations are passed
|
* an integer as the first parameter. This integer represents a pseudo
|
* {@code requestID} which is incremented for each successive internal request
|
* on a per connection basis. The request ID may be useful for logging purposes.
|
* <p>
|
* An {@code InternalConnectionFactory} does not require
|
* {@code ServerConnection} implementations to return a result when processing
|
* requests. However, it is recommended that implementations do always return
|
* results even for abandoned requests. This is because application client
|
* threads may block indefinitely waiting for results.
|
*
|
* @param <C>
|
* The type of client context.
|
*/
|
final class InternalConnectionFactory<C> implements ConnectionFactory
|
{
|
|
private final ServerConnectionFactory<C, Integer> factory;
|
|
private final C clientContext;
|
|
|
|
InternalConnectionFactory(final ServerConnectionFactory<C, Integer> factory,
|
final C clientContext)
|
{
|
this.factory = factory;
|
this.clientContext = clientContext;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public Connection getConnection() throws ErrorResultException,
|
InterruptedException
|
{
|
final ServerConnection<Integer> serverConnection = factory
|
.handleAccept(clientContext);
|
return new InternalConnection(serverConnection);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public FutureResult<Connection> getConnectionAsync(
|
final ResultHandler<? super Connection> handler)
|
{
|
final ServerConnection<Integer> serverConnection;
|
try
|
{
|
serverConnection = factory.handleAccept(clientContext);
|
}
|
catch (final ErrorResultException e)
|
{
|
if (handler != null)
|
{
|
handler.handleErrorResult(e);
|
}
|
return new CompletedFutureResult<Connection>(e);
|
}
|
|
final InternalConnection connection = new InternalConnection(
|
serverConnection);
|
if (handler != null)
|
{
|
handler.handleResult(connection);
|
}
|
return new CompletedFutureResult<Connection>(connection);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public String toString()
|
{
|
final StringBuilder builder = new StringBuilder();
|
builder.append("InternalConnectionFactory(");
|
builder.append(String.valueOf(clientContext));
|
builder.append(',');
|
builder.append(String.valueOf(factory));
|
builder.append(')');
|
return builder.toString();
|
}
|
}
|
