io.servicetalk.grpc.api.GrpcClientFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of servicetalk-grpc-api Show documentation
Show all versions of servicetalk-grpc-api Show documentation
A networking framework that evolves with your application
/*
* Copyright © 2019 Apple Inc. and the ServiceTalk project authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.servicetalk.grpc.api;
import java.util.Set;
import javax.annotation.Nullable;
import static io.servicetalk.grpc.api.GrpcMessageEncodings.none;
import static java.util.Collections.singleton;
import static java.util.Collections.unmodifiableSet;
import static java.util.Objects.requireNonNull;
/**
* A factory for creating clients that follows the specified gRPC {@link Client}
* contract.
*
* @param gRPC service that any client built from this
* factory represents.
* @param Blocking gRPC service that any client
* built from this builder represents.
* @param Type for client filter
* @param Type of filterable client.
* @param Type of {@link GrpcClientFilterFactory}
*/
public abstract class GrpcClientFactory,
BlockingClient extends BlockingGrpcClient,
Filter extends FilterableClient, FilterableClient extends FilterableGrpcClient,
FilterFactory extends GrpcClientFilterFactory> {
@Nullable
private FilterFactory filterFactory;
private Set supportedEncodings = unmodifiableSet(singleton(none()));
/**
* Create a new client that follows the specified gRPC
* {@link Client} contract using the passed {@link GrpcClientCallFactory}.
*
* @param clientCallFactory {@link GrpcClientCallFactory} to use for creating client calls.
* The returned {@link Client} should own the lifecycle of this factory.
* @return A new gRPC client following the specified
* gRPC {@link Client} contract.
*/
final Client newClientForCallFactory(GrpcClientCallFactory clientCallFactory) {
if (filterFactory == null) {
return newClient(clientCallFactory);
}
return newClient(newFilter(newClient(clientCallFactory), filterFactory));
}
/**
* Create a new client that follows the specified gRPC
* {@link BlockingClient} contract using the passed {@link GrpcClientCallFactory}.
*
* @param clientCallFactory {@link GrpcClientCallFactory} to use for creating client calls.
* The returned {@link Client} should own the lifecycle of this factory.
* @return A new gRPC client following the specified
* gRPC {@link BlockingClient} contract.
*/
final BlockingClient newBlockingClientForCallFactory(GrpcClientCallFactory clientCallFactory) {
if (filterFactory == null) {
return newBlockingClient(clientCallFactory);
}
return newClient(newFilter(
newBlockingClient(clientCallFactory).asClient(), filterFactory))
.asBlockingClient();
}
/**
* Appends the passed {@link 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
*
*
* @param before the factory to apply before this factory is applied
* @return {@code this}
*/
public GrpcClientFactory
appendClientFilter(FilterFactory before) {
if (filterFactory == null) {
filterFactory = before;
} else {
this.filterFactory = appendClientFilterFactory(filterFactory, requireNonNull(before));
}
return this;
}
/**
* Sets the supported message encodings for this client factory.
* By default only {@link GrpcMessageEncodings#none()} is supported
*
* @param supportedEncodings {@link GrpcMessageEncoding} supported encodings for this client.
* @return {@code this}
*/
public GrpcClientFactory
supportedEncodings(final Set supportedEncodings) {
this.supportedEncodings = unmodifiableSet(supportedEncodings);
return this;
}
/**
* Return the list of supported {@link GrpcMessageEncoding}s for this client factory.
* @return the list of supported {@link GrpcMessageEncoding}s for this client factory
*/
protected Set supportedEncodings() {
return supportedEncodings;
}
/**
* Appends the passed {@link FilterFactory} to this client factory.
*
* @param existing Existing {@link FilterFactory}.
* @param append {@link FilterFactory} to append to {@code existing}.
* @return a composed factory that first applies the {@code before} factory and then applies {@code existing}
* factory
*/
protected abstract FilterFactory appendClientFilterFactory(FilterFactory existing, FilterFactory append);
/**
* Create a new client that follows the specified gRPC
* {@link Client} contract using the passed {@link GrpcClientCallFactory}.
*
* @param clientCallFactory {@link GrpcClientCallFactory} to use for creating client calls.
* The returned {@link Client} should own the lifecycle of this factory.
* @return A new gRPC client following the specified
* gRPC {@link Client} contract.
*/
protected abstract Client newClient(GrpcClientCallFactory clientCallFactory);
/**
* Create a new {@link Filter} using the passed {@link Client} and {@link FilterFactory}.
*
* @param client {@link Client} to use for creating a {@link Filter} through the {@link FilterFactory}.
* @param filterFactory {@link FilterFactory}
* @return A {@link Filter} filtering the passed {@link Client}.
*/
protected abstract Filter newFilter(Client client, FilterFactory filterFactory);
/**
* Create a new {@link Client} using the passed {@link FilterableClient}.
*
* @param filterableClient {@link FilterableClient} to create a {@link Client} from.
* @return A new gRPC client following the specified
* gRPC {@link Client} contract.
*/
protected abstract Client newClient(FilterableClient filterableClient);
/**
* Create a new client that follows the specified gRPC
* {@link BlockingClient} contract using the passed {@link GrpcClientCallFactory}.
*
* @param clientCallFactory {@link GrpcClientCallFactory} to use for creating client calls.
* The returned {@link Client} should own the lifecycle of this factory.
* @return A new gRPC client following the specified
* gRPC {@link BlockingClient} contract.
*/
protected abstract BlockingClient newBlockingClient(GrpcClientCallFactory clientCallFactory);
}