org.grpcmock.definitions.stub

Class ClientStreamingMethodStubBuilderImpl<ReqT,RespT>

java.lang.Object

org.grpcmock.definitions.stub.ClientStreamingMethodStubBuilderImpl<ReqT,RespT>

All Implemented Interfaces:

BuilderStep, FirstRequestMatcherBuilderStep<ClientStreamingMethodStubBuilderStep<ReqT,RespT>,ReqT>, HeadersMatcherBuilderStep<ClientStreamingMethodStubBuilderStep<ReqT,RespT>>, ClientStreamingMethodStubBuilderStep<ReqT,RespT>, MethodStubBuilder<ReqT,RespT>, NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>, NextSingleResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>, NextStreamRequestProxyResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>, SingleResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,RespT>, StreamRequestProxyResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

public final class ClientStreamingMethodStubBuilderImpl<ReqT,RespT>
extends Object
implements ClientStreamingMethodStubBuilderStep<ReqT,RespT>, NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>

Author:

Fadelis

Constructor Summary

Constructors

Constructor and Description
ClientStreamingMethodStubBuilderImpl(io.grpc.MethodDescriptor<ReqT,RespT> method)

Method Summary

Modifier and Type	Method and Description
MethodStub<ReqT,RespT>	build()
NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>	nextWillProxyTo(Function<io.grpc.stub.StreamObserver<RespT>,io.grpc.stub.StreamObserver<ReqT>> streamRequestResponseProxy) Defines a proxying response, which will proxy the request to given Response for subsequent request call to this stub.
NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>	nextWillReturn(ExceptionResponseActionBuilder response) Defines a exception Response for subsequent request call to this stub.
NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>	nextWillReturn(ObjectResponseActionBuilder<RespT> response) Defines a single Response for subsequent request call to this stub.
NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>	willProxyTo(Function<io.grpc.stub.StreamObserver<RespT>,io.grpc.stub.StreamObserver<ReqT>> streamRequestResponseProxy) Defines a proxying response, which will proxy the request to given Response.
NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>	willReturn(ExceptionResponseActionBuilder response) Defines a exception Response that will terminate the request.
NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>	willReturn(ObjectResponseActionBuilder<RespT> response) Defines a single Response that will be returned for the request and complete it.
ClientStreamingMethodStubBuilderStep<ReqT,RespT>	withFirstRequest(Predicate<ReqT> requestPredicate) Adds a request matcher for the stub, which will trigger only if incoming first request satisfies given Predicate.
<T> ClientStreamingMethodStubBuilderStep<ReqT,RespT>	withHeader(io.grpc.Metadata.Key<T> headerKey, Predicate<T> predicate) Adds a header matcher for the stub, which will trigger only if the given header has value satisfying given Predicate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.grpcmock.definitions.matcher.steps.HeadersMatcherBuilderStep

withHeader, withHeader, withHeader, withHeader, withoutHeader, withoutHeader

Methods inherited from interface org.grpcmock.definitions.matcher.steps.FirstRequestMatcherBuilderStep

withFirstRequest

Methods inherited from interface org.grpcmock.definitions.stub.steps.SingleResponseBuilderStep

willReturn, willReturn

Methods inherited from interface org.grpcmock.definitions.stub.steps.NextSingleResponseBuilderStep

nextWillReturn, nextWillReturn

Constructor Detail

ClientStreamingMethodStubBuilderImpl

public ClientStreamingMethodStubBuilderImpl(@Nonnull
                                            io.grpc.MethodDescriptor<ReqT,RespT> method)

Method Detail

withHeader

public <T> ClientStreamingMethodStubBuilderStep<ReqT,RespT> withHeader(@Nonnull
                                                                       io.grpc.Metadata.Key<T> headerKey,
                                                                       @Nonnull
                                                                       Predicate<T> predicate)

Description copied from interface: HeadersMatcherBuilderStep

Adds a header matcher for the stub, which will trigger only if the given header has value satisfying given Predicate.

Subsequent matchers for the same header will replace the old one.

Specified by:

withHeader in interface HeadersMatcherBuilderStep<ClientStreamingMethodStubBuilderStep<ReqT,RespT>>

withFirstRequest

public ClientStreamingMethodStubBuilderStep<ReqT,RespT> withFirstRequest(@Nonnull
                                                                         Predicate<ReqT> requestPredicate)

Description copied from interface: FirstRequestMatcherBuilderStep

Adds a request matcher for the stub, which will trigger only if incoming first request satisfies given Predicate.

This is used for client or bidi streaming method calls. Only the first request can be used for matching, as a stub needs to be selected at this point or the call will be rejected.

Subsequent request matchers will replace the old one.

Specified by:

withFirstRequest in interface FirstRequestMatcherBuilderStep<ClientStreamingMethodStubBuilderStep<ReqT,RespT>,ReqT>

willReturn

public NextClientStreamingMethodResponseBuilderStep<ReqT,RespT> willReturn(@Nonnull
                                                                           ObjectResponseActionBuilder<RespT> response)

Description copied from interface: SingleResponseBuilderStep

Defines a single Response that will be returned for the request and complete it.

Specified by:

willReturn in interface SingleResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,RespT>

willReturn

public NextClientStreamingMethodResponseBuilderStep<ReqT,RespT> willReturn(@Nonnull
                                                                           ExceptionResponseActionBuilder response)

Description copied from interface: SingleResponseBuilderStep

Defines a exception Response that will terminate the request.

Specified by:

willReturn in interface SingleResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,RespT>

nextWillReturn

public NextClientStreamingMethodResponseBuilderStep<ReqT,RespT> nextWillReturn(@Nonnull
                                                                               ObjectResponseActionBuilder<RespT> response)

Description copied from interface: NextSingleResponseBuilderStep

Defines a single Response for subsequent request call to this stub.

If there are more requests coming in to this stub than responses defined, the last response defined will be returned for those requests.

Specified by:

nextWillReturn in interface NextSingleResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

nextWillReturn

public NextClientStreamingMethodResponseBuilderStep<ReqT,RespT> nextWillReturn(@Nonnull
                                                                               ExceptionResponseActionBuilder response)

Description copied from interface: NextSingleResponseBuilderStep

Defines a exception Response for subsequent request call to this stub.

If there are more requests coming in to this stub than responses defined, the last response defined will be returned for those requests.

Specified by:

nextWillReturn in interface NextSingleResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

willProxyTo

public NextClientStreamingMethodResponseBuilderStep<ReqT,RespT> willProxyTo(@Nonnull
                                                                            Function<io.grpc.stub.StreamObserver<RespT>,io.grpc.stub.StreamObserver<ReqT>> streamRequestResponseProxy)

Description copied from interface: StreamRequestProxyResponseBuilderStep

Defines a proxying response, which will proxy the request to given Response. The user is responsible that the request is completed correctly.

Should be used when there needs to be more logic in the response method than returning a simple response. For example:

 .willProxyTo((responseObserver) -> new StreamObserver() {

    public void onNext(V value) {
      // handle incoming requests
    }

    public void onError(Throwable throwable) {
      // handle error;
    }

    public void onCompleted() {
      // send response on completion
      responseObserver.onNext(responseObject);
      responseObserver.onCompleted();
    }
 });
 

Specified by:

willProxyTo in interface StreamRequestProxyResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

nextWillProxyTo

public NextClientStreamingMethodResponseBuilderStep<ReqT,RespT> nextWillProxyTo(@Nonnull
                                                                                Function<io.grpc.stub.StreamObserver<RespT>,io.grpc.stub.StreamObserver<ReqT>> streamRequestResponseProxy)

Description copied from interface: NextStreamRequestProxyResponseBuilderStep

Defines a proxying response, which will proxy the request to given Response for subsequent request call to this stub. The user is responsible that the request is completed correctly.

Should be used when there needs to be more logic in the response method than returning a simple response. For example:

 .nextWillProxyTo((responseObserver) -> new StreamObserver() {

    public void onNext(V value) {
      // handle incoming requests
    }

    public void onError(Throwable throwable) {
      // handle error;
    }

    public void onCompleted() {
      // send response on completion
      responseObserver.onNext(responseObject);
      responseObserver.onCompleted();
    }
 });
 

Specified by:

nextWillProxyTo in interface NextStreamRequestProxyResponseBuilderStep<NextClientStreamingMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

build

public MethodStub<ReqT,RespT> build()

Specified by:

build in interface MethodStubBuilder<ReqT,RespT>