Package 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>>

java.lang.Object

io.servicetalk.grpc.api.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 java.lang.Object

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

Constructor Summary

Constructors

Constructor	Description
GrpcClientFactory()

Method Summary

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

Methods inherited from class java.lang.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 GrpcClientFactory 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

supportedMessageCodings

public GrpcClientFactory<Client,BlockingClient,Filter,FilterableClient,FilterFactory> supportedMessageCodings(java.util.List<ContentCodec> codings)

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

Parameters:

codings - The supported encodings ContentCodecs for this client.

Returns:

this

supportedMessageCodings

protected java.util.List<ContentCodec> supportedMessageCodings()

Return the supported ContentCodecs for this client factory.

Returns:

the supported ContentCodecs for this client factory

appendClientFilterFactory

protected abstract FilterFactory appendClientFilterFactory(FilterFactory existing,
                                                           FilterFactory append)

Appends the passed GrpcClientFactory to this client factory.

Parameters:

existing - Existing GrpcClientFactory.

append - GrpcClientFactory 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 GrpcClientFactory contract using the passed GrpcClientCallFactory.

Parameters:

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

Returns:

A new gRPC client following the specified gRPC GrpcClientFactory contract.

newFilter

protected abstract Filter newFilter(Client client,
                                    FilterFactory filterFactory)

Create a new GrpcClientFactory using the passed GrpcClientFactory and GrpcClientFactory.

Parameters:

client - GrpcClientFactory to use for creating a GrpcClientFactory through the GrpcClientFactory.

filterFactory - GrpcClientFactory

Returns:

A GrpcClientFactory filtering the passed GrpcClientFactory.

newClient

protected abstract Client newClient(FilterableClient filterableClient)

Create a new GrpcClientFactory using the passed GrpcClientFactory.

Parameters:

filterableClient - GrpcClientFactory to create a GrpcClientFactory from.

Returns:

A new gRPC client following the specified gRPC GrpcClientFactory contract.

newBlockingClient

protected abstract BlockingClient newBlockingClient(GrpcClientCallFactory clientCallFactory)

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

Parameters:

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

Returns:

A new gRPC client following the specified gRPC GrpcClientFactory contract.