Package com.predic8.membrane.core.transport.http

Class Connection

java.lang.Object

com.predic8.membrane.core.transport.http.Connection

All Implemented Interfaces:

MessageObserver, NonRelevantBodyObserver, Closeable, AutoCloseable

public class Connection
extends Object
implements Closeable, MessageObserver, NonRelevantBodyObserver

A Connection is an outbound TCP/IP connection, possibly managed by a ConnectionManager.

It is symbiotic to an Exchange during the exchange's HTTP client call, which starts in HttpClient.call(Exchange) and ends when the HTTP response body has fully been read (or never, if Request.isBindTargetConnectionToIncoming() is true).

The connection will be registered by the HttpClient as a MessageObserver on the Response to get notified when the HTTP response body has fully been read and it should deassociate itself from the exchange.

Field Summary

Fields

Modifier and Type	Field	Description
final String	host
InputStream	in
final ConnectionManager	mgr
OutputStream	out
Socket	socket

Method Summary

Modifier and Type	Method	Description
void	bodyChunk(byte[] buffer, int offset, int length)	Observes a piece of the body.
void	bodyChunk(Chunk chunk)	Observes a piece of the body.
void	bodyComplete(AbstractBody body)	Notification that the body has fully been received.
void	bodyRequested(AbstractBody body)
void	close()
protected void	finalize()
String[]	getApplicationProtocols()
final int	getCompletedExchanges()
String	getHost()
final long	getLastUse()
final int	getMaxExchanges()
ProxyConfiguration	getProxyConfiguration()
SSLProvider	getProxySSLProvider()
String	getSniServerName()
SSLProvider	getSslProvider()
final long	getTimeout()
boolean	isClosed()
boolean	isSame(String host, int port)
static Connection	open(String host, int port, String localHost, SSLProvider sslProvider, int connectTimeout)
static Connection	open(String host, int port, String localHost, SSLProvider sslProvider, ConnectionManager mgr, int connectTimeout)
static Connection	open(String host, int port, String localHost, SSLProvider sslProvider, ConnectionManager mgr, int connectTimeout, String sniServername, ProxyConfiguration proxy, SSLProvider proxySSLProvider, String[] applicationProtocols)
void	release()	See ConnectionManager for documentation.
final void	setMaxExchanges(int maxExchanges)
final void	setTimeout(long timeout)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

mgr

public final ConnectionManager mgr

host

public final String host

socket

public Socket socket

in

public InputStream in

out

public OutputStream out

Method Details

open

public static Connection open(String host,
 int port,
 String localHost,
 SSLProvider sslProvider,
 int connectTimeout)
                       throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

open

public static Connection open(String host,
 int port,
 String localHost,
 SSLProvider sslProvider,
 ConnectionManager mgr,
 int connectTimeout,
 @Nullable
 String sniServername,
 @Nullable
 ProxyConfiguration proxy,
 @Nullable
 SSLProvider proxySSLProvider,
 @Nullable
 String[] applicationProtocols)
                       throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

open

public static Connection open(String host,
 int port,
 String localHost,
 SSLProvider sslProvider,
 ConnectionManager mgr,
 int connectTimeout)
                       throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

isSame

public boolean isSame(String host,
 int port)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

isClosed

public boolean isClosed()

release

public void release()
             throws IOException

See ConnectionManager for documentation.

Throws:

IOException

bodyChunk

public void bodyChunk(Chunk chunk)

Description copied from interface: MessageObserver

Observes a piece of the body.

Specified by:

bodyChunk in interface MessageObserver

bodyChunk

public void bodyChunk(byte[] buffer,
 int offset,
 int length)

Description copied from interface: MessageObserver

Observes a piece of the body. Note that the buffer content may change after the method completes.

Specified by:

bodyChunk in interface MessageObserver

bodyRequested

public void bodyRequested(AbstractBody body)

Specified by:

bodyRequested in interface MessageObserver

bodyComplete

public void bodyComplete(AbstractBody body)

Description copied from interface: MessageObserver

Notification that the body has fully been received.

Note that this event may run instantaneously (during the call to Message.addObserver(MessageObserver)), as the body may have already been fully received when registering the observer.

This is the last event that will be fired on any MessageObserver.

Specified by:

bodyComplete in interface MessageObserver

setTimeout

public final void setTimeout(long timeout)

getTimeout

public final long getTimeout()

getMaxExchanges

public final int getMaxExchanges()

setMaxExchanges

public final void setMaxExchanges(int maxExchanges)

getCompletedExchanges

public final int getCompletedExchanges()

getLastUse

public final long getLastUse()

getHost

public String getHost()

toString

public String toString()

Overrides:

toString in class Object

getSniServerName

public String getSniServerName()

getProxyConfiguration

public ProxyConfiguration getProxyConfiguration()

getProxySSLProvider

public SSLProvider getProxySSLProvider()

getSslProvider

public SSLProvider getSslProvider()

getApplicationProtocols

public String[] getApplicationProtocols()