io.servicetalk.http.api

Class DelegatingHttpServiceContext

java.lang.Object

io.servicetalk.http.api.HttpServiceContext

io.servicetalk.http.api.DelegatingHttpServiceContext

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, HttpConnectionContext, ConnectionContext

public class DelegatingHttpServiceContext
extends HttpServiceContext

An implementation of HttpServiceContext that delegates all calls to a provided HttpServiceContext. Any method can be overridden to change this default behavior.

Nested Class Summary

Nested classes/interfaces inherited from interface io.servicetalk.http.api.HttpConnectionContext

HttpConnectionContext.HttpProtocol

Nested classes/interfaces inherited from interface io.servicetalk.transport.api.ConnectionContext

ConnectionContext.Protocol

Constructor Summary

Constructors

Constructor and Description
DelegatingHttpServiceContext(HttpServiceContext other) New instance.

Method Summary

Modifier and Type	Method and Description
Completable	closeAsync() Used to close/shutdown a resource.
Completable	closeAsyncGracefully() Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
HttpExecutionContext	executionContext() Get the ExecutionContext for this ConnectionContext.
java.net.SocketAddress	localAddress() The SocketAddress to which the associated connection is bound.
Completable	onClose() Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
HttpConnectionContext.HttpProtocol	protocol() Get the ConnectionContext.Protocol for this ConnectionContext.
java.net.SocketAddress	remoteAddress() The SocketAddress to which the associated connection is connected.
<T> T	socketOption(java.net.SocketOption<T> option) Get the SocketOption value of type T for this ConnectionContext.
javax.net.ssl.SSLSession	sslSession() Get the SSLSession for this connection.

Methods inherited from class io.servicetalk.http.api.HttpServiceContext

blockingStreamingResponseFactory, headersFactory, responseFactory, streamingResponseFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingHttpServiceContext

public DelegatingHttpServiceContext(HttpServiceContext other)

New instance.

Parameters:

other - HttpServiceContext to delegate all calls.

Method Detail

localAddress

public java.net.SocketAddress localAddress()

Description copied from interface: ConnectionContext

The SocketAddress to which the associated connection is bound.

Returns:

The SocketAddress to which the associated connection is bound.

remoteAddress

public java.net.SocketAddress remoteAddress()

Description copied from interface: ConnectionContext

The SocketAddress to which the associated connection is connected.

Returns:

The SocketAddress to which the associated connection is connected.

sslSession

@Nullable
public javax.net.ssl.SSLSession sslSession()

Description copied from interface: ConnectionContext

Get the SSLSession for this connection.

Returns:

The SSLSession if SSL/TLS is enabled, or null otherwise.

executionContext

public HttpExecutionContext executionContext()

Description copied from interface: ConnectionContext

Get the ExecutionContext for this ConnectionContext.

The ExecutionContext.ioExecutor() will represent the thread responsible for IO for this ConnectionContext. Note that this maybe different that what was used to create this object because at this time a specific IoExecutor has been selected.

Returns:

the ExecutionContext for this ConnectionContext.

socketOption

@Nullable
public <T> T socketOption(java.net.SocketOption<T> option)

Description copied from interface: ConnectionContext

Get the SocketOption value of type T for this ConnectionContext.

Type Parameters:

T - the type of the SocketOption value.

Parameters:

option - SocketOption to get.

Returns:

the SocketOption value of type T for this ConnectionContext or null if this SocketOption is not supported by this ConnectionContext.

See Also:

StandardSocketOptions, ServiceTalkSocketOptions

protocol

public HttpConnectionContext.HttpProtocol protocol()

Description copied from interface: ConnectionContext

Get the ConnectionContext.Protocol for this ConnectionContext.

Returns:

the ConnectionContext.Protocol for this ConnectionContext.

onClose

public Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Returns:

the Completable that is notified on close.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Returns:

A CompletableSource that is notified once the close is complete.

closeAsyncGracefully

public Completable closeAsyncGracefully()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing. This provides a hint that implementations can use to stop accepting new work and finish in flight work. This method is implemented on a "best effort" basis and may be equivalent to AsyncCloseable.closeAsync().

Note: Implementations may or may not apply a timeout for this operation to complete, if a caller does not want to wait indefinitely, and are unsure if the implementation applies a timeout, it is advisable to apply a timeout and force a call to AsyncCloseable.closeAsync().

Returns:

A Completable that is notified once the close is complete.