io.servicetalk.grpc.api

Class GrpcClientFactory<Client extends GrpcClient<BlockingClient>,BlockingClient extends BlockingGrpcClient<Client>,Filter extends FilterableClient,FilterableClient extends FilterableGrpcClient,FilterFactory extends GrpcClientFilterFactory<Filter,FilterableClient>>

Object

GrpcClientFactory<Client,BlockingClient,Filter,FilterableClient,FilterFactory>

Type Parameters:

Client - gRPC service that any client built from this factory represents.

BlockingClient - Blocking gRPC service that any client built from this builder represents.

Filter - Type for client filter

FilterableClient - Type of filterable client.

FilterFactory - Type of GrpcClientFilterFactory

public abstract class GrpcClientFactory<Client extends GrpcClient<BlockingClient>,BlockingClient extends BlockingGrpcClient<Client>,Filter extends FilterableClient,FilterableClient extends FilterableGrpcClient,FilterFactory extends GrpcClientFilterFactory<Filter,FilterableClient>>
extends Object

A factory for creating clients that follows the specified gRPC Client contract.

Constructor Summary

Constructors

Constructor and Description
GrpcClientFactory()

Method Summary

Modifier and Type	Method and Description
GrpcClientFactory<Client,BlockingClient,Filter,FilterableClient,FilterFactory>	appendClientFilter(FilterFactory before) Appends the passed FilterFactory to this factory.
protected abstract FilterFactory	appendClientFilterFactory(FilterFactory existing, FilterFactory append) Appends the passed FilterFactory to this client factory.
protected abstract BlockingClient	newBlockingClient(GrpcClientCallFactory clientCallFactory) Create a new client that follows the specified gRPC BlockingClient contract using the passed GrpcClientCallFactory.
protected abstract Client	newClient(FilterableClient filterableClient) Create a new Client using the passed FilterableClient.
protected abstract Client	newClient(GrpcClientCallFactory clientCallFactory) Create a new client that follows the specified gRPC Client contract using the passed GrpcClientCallFactory.
protected abstract Filter	newFilter(Client client, FilterFactory filterFactory) Create a new Filter using the passed Client and FilterFactory.
protected Set<GrpcMessageEncoding>	supportedEncodings() Return the list of supported GrpcMessageEncodings for this client factory.
GrpcClientFactory<Client,BlockingClient,Filter,FilterableClient,FilterFactory>	supportedEncodings(Set<GrpcMessageEncoding> supportedEncodings) Sets the supported message encodings for this client factory.

Methods inherited from class Object

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

Constructor Detail

GrpcClientFactory

public GrpcClientFactory()

Method Detail

appendClientFilter

public GrpcClientFactory<Client,BlockingClient,Filter,FilterableClient,FilterFactory> appendClientFilter(FilterFactory before)

Appends the passed FilterFactory to this factory.

The order of execution of these filters are in order of append. If 3 filters are added as follows:

     filter1.append(filter2).append(filter3)
 

making a request to a client wrapped by this filter chain the order of invocation of these filters will be:

     filter1 => filter2 => filter3 => client
 

Parameters:

before - the factory to apply before this factory is applied

Returns:

this

supportedEncodings

public GrpcClientFactory<Client,BlockingClient,Filter,FilterableClient,FilterFactory> supportedEncodings(Set<GrpcMessageEncoding> supportedEncodings)

Sets the supported message encodings for this client factory. By default only GrpcMessageEncodings.none() is supported

Parameters:

supportedEncodings - GrpcMessageEncoding supported encodings for this client.

Returns:

this

supportedEncodings

protected Set<GrpcMessageEncoding> supportedEncodings()

Return the list of supported GrpcMessageEncodings for this client factory.

Returns:

the list of supported GrpcMessageEncodings for this client factory

appendClientFilterFactory

protected abstract FilterFactory appendClientFilterFactory(FilterFactory existing,
                                                           FilterFactory append)

Appends the passed FilterFactory to this client factory.

Parameters:

existing - Existing FilterFactory.

append - FilterFactory to append to existing.

Returns:

a composed factory that first applies the before factory and then applies existing factory

newClient

protected abstract Client newClient(GrpcClientCallFactory clientCallFactory)

Create a new client that follows the specified gRPC Client contract using the passed GrpcClientCallFactory.

Parameters:

clientCallFactory - GrpcClientCallFactory to use for creating client calls. The returned Client should own the lifecycle of this factory.

Returns:

A new gRPC client following the specified gRPC Client contract.

newFilter

protected abstract Filter newFilter(Client client,
                                    FilterFactory filterFactory)

Create a new Filter using the passed Client and FilterFactory.

Parameters:

client - Client to use for creating a Filter through the FilterFactory.

filterFactory - FilterFactory

Returns:

A Filter filtering the passed Client.

newClient

protected abstract Client newClient(FilterableClient filterableClient)

Create a new Client using the passed FilterableClient.

Parameters:

filterableClient - FilterableClient to create a Client from.

Returns:

A new gRPC client following the specified gRPC Client contract.

newBlockingClient

protected abstract BlockingClient newBlockingClient(GrpcClientCallFactory clientCallFactory)

Create a new client that follows the specified gRPC BlockingClient contract using the passed GrpcClientCallFactory.

Parameters:

clientCallFactory - GrpcClientCallFactory to use for creating client calls. The returned Client should own the lifecycle of this factory.

Returns:

A new gRPC client following the specified gRPC BlockingClient contract.