/*
|
* 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 java.util.Collection;
|
import java.util.LinkedList;
|
import java.util.List;
|
import java.util.concurrent.TimeUnit;
|
import java.util.concurrent.TimeoutException;
|
|
import org.opends.sdk.requests.*;
|
import org.opends.sdk.responses.*;
|
import org.opends.sdk.schema.Schema;
|
|
import com.sun.opends.sdk.util.FutureResultTransformer;
|
|
|
|
/**
|
* An heart beat connection factory can be used to create connections
|
* that sends a periodic search request to a Directory Server.
|
*/
|
final class HeartBeatConnectionFactory extends
|
AbstractConnectionFactory<AsynchronousConnection>
|
{
|
private final SearchRequest heartBeat;
|
|
private final long timeout;
|
|
private final TimeUnit unit;
|
|
private final List<AsynchronousConnectionImpl> activeConnections;
|
|
private final ConnectionFactory<?> parentFactory;
|
|
|
|
// FIXME: use a single global scheduler?
|
|
/**
|
* Creates a new heart-beat connection factory which will create
|
* connections using the provided connection factory and periodically
|
* ping any created connections in order to detect that they are still
|
* alive.
|
*
|
* @param connectionFactory
|
* The connection factory to use for creating connections.
|
* @param timeout
|
* The time to wait between keepalive pings.
|
* @param unit
|
* The time unit of the timeout argument.
|
*/
|
HeartBeatConnectionFactory(ConnectionFactory<?> connectionFactory,
|
long timeout, TimeUnit unit)
|
{
|
this(connectionFactory, timeout, unit, DEFAULT_SEARCH);
|
}
|
|
|
|
private static final SearchRequest DEFAULT_SEARCH = Requests
|
.newSearchRequest("", SearchScope.BASE_OBJECT, "(objectClass=*)",
|
"1.1");
|
|
|
|
/**
|
* Creates a new heart-beat connection factory which will create
|
* connections using the provided connection factory and periodically
|
* ping any created connections using the specified search request in
|
* order to detect that they are still alive.
|
*
|
* @param connectionFactory
|
* The connection factory to use for creating connections.
|
* @param timeout
|
* The time to wait between keepalive pings.
|
* @param unit
|
* The time unit of the timeout argument.
|
* @param heartBeat
|
* The search request to use when pinging connections.
|
*/
|
HeartBeatConnectionFactory(ConnectionFactory<?> connectionFactory,
|
long timeout, TimeUnit unit, SearchRequest heartBeat)
|
{
|
this.heartBeat = heartBeat;
|
this.timeout = timeout;
|
this.unit = unit;
|
this.activeConnections = new LinkedList<AsynchronousConnectionImpl>();
|
this.parentFactory = connectionFactory;
|
|
new HeartBeatThread().start();
|
}
|
|
|
|
/**
|
* An asynchronous connection that sends heart beats and supports all
|
* operations.
|
*/
|
private final class AsynchronousConnectionImpl implements
|
AsynchronousConnection, ConnectionEventListener, ResultHandler<Result>
|
{
|
private final AsynchronousConnection connection;
|
private long lastSuccessfulPing;
|
private FutureResult<Result> lastPingFuture;
|
|
|
private AsynchronousConnectionImpl(AsynchronousConnection connection)
|
{
|
this.connection = connection;
|
}
|
|
|
|
public void abandon(AbandonRequest request)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
connection.abandon(request);
|
}
|
|
|
|
public FutureResult<Result> add(AddRequest request,
|
ResultHandler<Result> handler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.add(request, handler);
|
}
|
|
|
|
public FutureResult<BindResult> bind(BindRequest request,
|
ResultHandler<? super BindResult> handler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.bind(request, handler);
|
}
|
|
|
|
public void close()
|
{
|
synchronized (activeConnections)
|
{
|
connection.removeConnectionEventListener(this);
|
activeConnections.remove(this);
|
}
|
connection.close();
|
}
|
|
|
|
public void close(UnbindRequest request, String reason)
|
throws NullPointerException
|
{
|
synchronized (activeConnections)
|
{
|
connection.removeConnectionEventListener(this);
|
activeConnections.remove(this);
|
}
|
connection.close(request, reason);
|
}
|
|
|
|
public FutureResult<CompareResult> compare(CompareRequest request,
|
ResultHandler<? super CompareResult> handler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.compare(request, handler);
|
}
|
|
|
|
public FutureResult<Result> delete(DeleteRequest request,
|
ResultHandler<Result> handler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.delete(request, handler);
|
}
|
|
|
|
public <R extends Result> FutureResult<R> extendedRequest(
|
ExtendedRequest<R> request, ResultHandler<? super R> handler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.extendedRequest(request, handler);
|
}
|
|
|
|
public FutureResult<Result> modify(ModifyRequest request,
|
ResultHandler<Result> handler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.modify(request, handler);
|
}
|
|
|
|
public FutureResult<Result> modifyDN(ModifyDNRequest request,
|
ResultHandler<Result> handler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.modifyDN(request, handler);
|
}
|
|
|
|
public FutureResult<Result> search(SearchRequest request,
|
ResultHandler<Result> resultHandler,
|
SearchResultHandler searchResultHandler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.search(request, resultHandler,
|
searchResultHandler);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public FutureResult<SearchResultEntry> readEntry(DN name,
|
Collection<String> attributeDescriptions,
|
ResultHandler<? super SearchResultEntry> resultHandler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.readEntry(name, attributeDescriptions,
|
resultHandler);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public FutureResult<SearchResultEntry> searchSingleEntry(
|
SearchRequest request,
|
ResultHandler<? super SearchResultEntry> resultHandler)
|
throws UnsupportedOperationException, IllegalStateException,
|
NullPointerException
|
{
|
return connection.searchSingleEntry(request, resultHandler);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public FutureResult<RootDSE> readRootDSE(
|
ResultHandler<RootDSE> handler)
|
throws UnsupportedOperationException, IllegalStateException
|
{
|
return connection.readRootDSE(handler);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public FutureResult<Schema> readSchemaForEntry(DN name,
|
ResultHandler<Schema> handler)
|
throws UnsupportedOperationException, IllegalStateException
|
{
|
return connection.readSchemaForEntry(name, handler);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public FutureResult<Schema> readSchema(DN name,
|
ResultHandler<Schema> handler)
|
throws UnsupportedOperationException, IllegalStateException
|
{
|
return connection.readSchema(name, handler);
|
}
|
|
|
|
public void addConnectionEventListener(
|
ConnectionEventListener listener) throws IllegalStateException,
|
NullPointerException
|
{
|
connection.addConnectionEventListener(listener);
|
}
|
|
|
|
public void removeConnectionEventListener(
|
ConnectionEventListener listener) throws NullPointerException
|
{
|
connection.removeConnectionEventListener(listener);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isClosed()
|
{
|
return connection.isClosed();
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isValid()
|
{
|
return connection.isValid() && (lastSuccessfulPing <= 0 ||
|
System.currentTimeMillis() - lastSuccessfulPing <
|
unit.toMillis(timeout) * 2);
|
}
|
|
public void connectionReceivedUnsolicitedNotification(
|
GenericExtendedResult notification)
|
{
|
// Do nothing
|
}
|
|
|
|
public void connectionErrorOccurred(
|
boolean isDisconnectNotification, ErrorResultException error)
|
{
|
synchronized (activeConnections)
|
{
|
connection.removeConnectionEventListener(this);
|
activeConnections.remove(this);
|
}
|
}
|
|
public void handleErrorResult(ErrorResultException error) {
|
connection.close(Requests.newUnbindRequest(),
|
"Heartbeat retured error: " + error);
|
}
|
|
public void handleResult(Result result) {
|
lastSuccessfulPing = System.currentTimeMillis();
|
}
|
}
|
|
|
|
private final class HeartBeatThread extends Thread
|
{
|
private HeartBeatThread()
|
{
|
super("Heart Beat Thread");
|
this.setDaemon(true);
|
}
|
|
|
|
public void run()
|
{
|
long startTime;
|
while(true)
|
{
|
startTime = System.currentTimeMillis();
|
synchronized (activeConnections)
|
{
|
for (AsynchronousConnectionImpl connection : activeConnections)
|
{
|
if(connection.lastPingFuture == null ||
|
connection.lastPingFuture.isDone())
|
{
|
connection.lastPingFuture =
|
connection.search(heartBeat, connection, null);
|
}
|
}
|
}
|
try
|
{
|
sleep(unit.toMillis(timeout) -
|
(System.currentTimeMillis() - startTime));
|
}
|
catch (InterruptedException e)
|
{
|
// Ignore
|
}
|
}
|
}
|
}
|
|
|
|
private final class FutureResultImpl
|
extends
|
FutureResultTransformer<AsynchronousConnection, AsynchronousConnection>
|
implements FutureResult<AsynchronousConnection>,
|
ResultHandler<AsynchronousConnection>
|
{
|
|
private FutureResultImpl(
|
ResultHandler<? super AsynchronousConnection> handler)
|
{
|
super(handler);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
protected AsynchronousConnection transformResult(
|
AsynchronousConnection connection) throws ErrorResultException
|
{
|
AsynchronousConnectionImpl heartBeatConnection = new AsynchronousConnectionImpl(
|
connection);
|
synchronized (activeConnections)
|
{
|
connection.addConnectionEventListener(heartBeatConnection);
|
activeConnections.add(heartBeatConnection);
|
}
|
return heartBeatConnection;
|
}
|
|
}
|
|
|
|
public FutureResult<AsynchronousConnection> getAsynchronousConnection(
|
ResultHandler<? super AsynchronousConnection> handler)
|
{
|
FutureResultImpl future = new FutureResultImpl(handler);
|
future.setFutureResult(parentFactory
|
.getAsynchronousConnection(future));
|
return future;
|
}
|
}
|
