A connection pool that validates connections before making them available for use.

Connections that have just been opened are not validated. Connections that are released will be validated.

Validation by reading from the EndPoint is not reliable, since the TCP FIN may arrive just after the validation read.

This class validates connections by putting them in a "quarantine" for a configurable timeout, where they cannot be used to send requests. When the timeout expires, the quarantined connection is made idle and therefore available to send requests.

The existing HttpClient mechanism to detect server closes will trigger and close quarantined connections, before they are made idle (and reusable) again.

There still is a small chance that the timeout expires, the connection is made idle and available again, it is used to send a request exactly when the server decides to close. This case is however unavoidable and may be mitigated by tuning the idle timeout of the servers to be larger than that of the client.

Modifier and Type	Class and Description
private class	ValidatingConnectionPool.Holder

Modifier and Type	Field and Description
private static final Logger	LOG Hides org.eclipse.jetty.client.AbstractConnectionPool.LOG.
private final Map<Connection, ValidatingConnectionPool.Holder>	quarantine
private final Scheduler	scheduler
private final long	timeout

Constructor Summary

Access	Constructor and Description
public	ValidatingConnectionPool(Destination destination, int maxConnections, Scheduler scheduler, long timeout)

Method Summary

Modifier and Type	Method and Description
public void	dump(Appendable The appendable to dump to out, String The indent to apply after any new lines. indent) Overrides org.eclipse.jetty.client.AbstractConnectionPool.dump. Implements org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines.
public int	getValidatingConnectionCount()
public boolean	release(Connection the connection to release connection) Overrides org.eclipse.jetty.client.AbstractConnectionPool.release. Implements org.eclipse.jetty.client.ConnectionPool.release. Returns the given connection, previously obtained via `acquire(boolean)`, back to this ConnectionPool.
public boolean	remove(Connection the connection to remove connection) Overrides org.eclipse.jetty.client.AbstractConnectionPool.remove. Implements org.eclipse.jetty.client.ConnectionPool.remove. Removes the given connection from this ConnectionPool.
public String	toString() Overrides org.eclipse.jetty.client.AbstractConnectionPool.toString. Returns a string representation of the object.

Field Detail

LOG	back to summary
private static final Logger LOG Hides org.eclipse.jetty.client.AbstractConnectionPool.LOG.

quarantine	back to summary
private final Map<Connection, ValidatingConnectionPool.Holder> quarantine

scheduler	back to summary
private final Scheduler scheduler

timeout	back to summary
private final long timeout

Constructor Detail

ValidatingConnectionPool	back to summary
public ValidatingConnectionPool(Destination destination, int maxConnections, Scheduler scheduler, long timeout)

Method Detail

dump	back to summary
public void dump(Appendable out, String indent) throws IOException Overrides org.eclipse.jetty.client.AbstractConnectionPool.dump. Implements org.eclipse.jetty.util.component.Dumpable.dump. Doc from org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped. Parameters out:Appendable The appendable to dump to indent:String The indent to apply after any new lines. Annotations @Override Exceptions IOException: if unable to write to Appendable

dump

back to summary

public void dump(Appendable out, String indent) throws IOException

Overrides org.eclipse.jetty.client.AbstractConnectionPool.dump.

Implements org.eclipse.jetty.util.component.Dumpable.dump.

Doc from org.eclipse.jetty.util.component.Dumpable.dump.

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Parameters

out:Appendable: The appendable to dump to
indent:String: The indent to apply after any new lines.

Annotations

@Override

Exceptions

IOException:: if unable to write to Appendable

getValidatingConnectionCount	back to summary
public int getValidatingConnectionCount() Annotations @ManagedAttribute:The number of validating connections readonly:true

release back to summary

release	back to summary
public boolean release(Connection connection) Overrides org.eclipse.jetty.client.AbstractConnectionPool.release. Implements org.eclipse.jetty.client.ConnectionPool.release. Doc from org.eclipse.jetty.client.ConnectionPool.release. Returns the given connection, previously obtained via `acquire(boolean)`, back to this ConnectionPool. Parameters connection:Connection the connection to release Returns:boolean true if the connection has been released, false if the connection should be closed Annotations @Override

public boolean release(Connection connection)

Overrides org.eclipse.jetty.client.AbstractConnectionPool.release.

Implements org.eclipse.jetty.client.ConnectionPool.release.

Doc from org.eclipse.jetty.client.ConnectionPool.release.

Returns the given connection, previously obtained via acquire(boolean), back to this ConnectionPool.

Parameters

connection:Connection: the connection to release

Returns:boolean

true if the connection has been released, false if the connection should be closed

Annotations

@Override

remove	back to summary
public boolean remove(Connection connection) Overrides org.eclipse.jetty.client.AbstractConnectionPool.remove. Implements org.eclipse.jetty.client.ConnectionPool.remove. Doc from org.eclipse.jetty.client.ConnectionPool.remove. Removes the given connection from this ConnectionPool. Parameters connection:Connection the connection to remove Returns:boolean true if the connection was removed from this ConnectionPool Annotations @Override

remove

back to summary

public boolean remove(Connection connection)

Overrides org.eclipse.jetty.client.AbstractConnectionPool.remove.

Implements org.eclipse.jetty.client.ConnectionPool.remove.

Doc from org.eclipse.jetty.client.ConnectionPool.remove.

Removes the given connection from this ConnectionPool.

Parameters

connection:Connection: the connection to remove

Returns:boolean

true if the connection was removed from this ConnectionPool

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides org.eclipse.jetty.client.AbstractConnectionPool.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides org.eclipse.jetty.client.AbstractConnectionPool.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.eclipse.jetty.client back to summary

private Class ValidatingConnectionPool.Holder

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.eclipse.jetty.client.ValidatingConnectionPool.Holder

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
private final Connection	connection
private final long	creationNanoTime
private final AtomicBoolean	done
public Scheduler.Task	task

Constructor Summary

Access	Constructor and Description
public	Holder(Connection connection)

Method Summary

Modifier and Type	Method and Description
public boolean	cancel()
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

connection	back to summary
private final Connection connection

creationNanoTime	back to summary
private final long creationNanoTime

done	back to summary
private final AtomicBoolean done

task	back to summary
public Scheduler.Task task

Constructor Detail

Holder	back to summary
public Holder(Connection connection)

Method Detail

cancel	back to summary
public boolean cancel()

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class ValidatingConnectionPool

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ValidatingConnectionPool.Holder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail