Module io.helidon.grpc.server

Package io.helidon.grpc.server

Class ServiceDescriptor.Builder

java.lang.Object

io.helidon.grpc.server.ServiceDescriptor.Builder

All Implemented Interfaces:

Builder<ServiceDescriptor>, ServiceDescriptor.Rules, Supplier<ServiceDescriptor>

Enclosing class:

ServiceDescriptor

public static final class ServiceDescriptor.Builder
extends Object
implements ServiceDescriptor.Rules, Builder<ServiceDescriptor>

A ServiceDescriptor builder.

Method Summary

Modifier and Type	Method	Description
<V> ServiceDescriptor.Builder	addContextValue(io.grpc.Context.Key<V> key, V value)	Add value to the Context for the service.
<ReqT,ResT> ServiceDescriptor.Builder	bidirectional(String name, io.grpc.stub.ServerCalls.BidiStreamingMethod<ReqT,ResT> method)	Register bi-directional streaming method for the service.
<ReqT,ResT> ServiceDescriptor.Builder	bidirectional(String name, io.grpc.stub.ServerCalls.BidiStreamingMethod<ReqT,ResT> method, MethodDescriptor.Configurer<ReqT,ResT> configurer)	Register bi-directional streaming method for the service.
ServiceDescriptor	build()	Build the instance from this builder.
<ReqT,ResT> ServiceDescriptor.Builder	clientStreaming(String name, io.grpc.stub.ServerCalls.ClientStreamingMethod<ReqT,ResT> method)	Register client streaming method for the service.
<ReqT,ResT> ServiceDescriptor.Builder	clientStreaming(String name, io.grpc.stub.ServerCalls.ClientStreamingMethod<ReqT,ResT> method, MethodDescriptor.Configurer<ReqT,ResT> configurer)	Register client streaming method for the service.
ServiceDescriptor.Builder	healthCheck(HealthCheck healthCheck)	Register the service HealthCheck.
ServiceDescriptor.Builder	intercept(int priority, io.grpc.ServerInterceptor... interceptors)	Add one or more ServerInterceptor instances that will intercept calls to this service.
ServiceDescriptor.Builder	intercept(io.grpc.ServerInterceptor... interceptors)	Add one or more ServerInterceptor instances that will intercept calls to this service.
ServiceDescriptor.Builder	intercept(String methodName, int priority, io.grpc.ServerInterceptor... interceptors)	Register one or more interceptors for a named method of the service.
ServiceDescriptor.Builder	intercept(String methodName, io.grpc.ServerInterceptor... interceptors)	Register one or more interceptors for a named method of the service.
ServiceDescriptor.Builder	marshallerSupplier(MarshallerSupplier marshallerSupplier)	Register the MarshallerSupplier for the service.
String	name()	Obtain the name fo the service this configuration configures.
ServiceDescriptor.Builder	name(String name)	Set the name for the service.
ServiceDescriptor.Builder	proto(com.google.protobuf.Descriptors.FileDescriptor proto)	Register the proto for the service.
<ReqT,ResT> ServiceDescriptor.Builder	serverStreaming(String name, io.grpc.stub.ServerCalls.ServerStreamingMethod<ReqT,ResT> method)	Register server streaming method for the service.
<ReqT,ResT> ServiceDescriptor.Builder	serverStreaming(String name, io.grpc.stub.ServerCalls.ServerStreamingMethod<ReqT,ResT> method, MethodDescriptor.Configurer<ReqT,ResT> configurer)	Register server streaming method for the service.
String	toString()
<ReqT,ResT> ServiceDescriptor.Builder	unary(String name, io.grpc.stub.ServerCalls.UnaryMethod<ReqT,ResT> method)	Register unary method for the service.
<ReqT,ResT> ServiceDescriptor.Builder	unary(String name, io.grpc.stub.ServerCalls.UnaryMethod<ReqT,ResT> method, MethodDescriptor.Configurer<ReqT,ResT> configurer)	Register unary method for the service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

name

public String name()

Description copied from interface: ServiceDescriptor.Rules

Obtain the name fo the service this configuration configures.

Specified by:

name in interface ServiceDescriptor.Rules

Returns:

the name fo the service this configuration configures

name

public ServiceDescriptor.Builder name(String name)

Description copied from interface: ServiceDescriptor.Rules

Set the name for the service.

Specified by:

name in interface ServiceDescriptor.Rules

Parameters:

name - the service name

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

proto

public ServiceDescriptor.Builder proto(com.google.protobuf.Descriptors.FileDescriptor proto)

Description copied from interface: ServiceDescriptor.Rules

Register the proto for the service.

Specified by:

proto in interface ServiceDescriptor.Rules

Parameters:

proto - the service proto

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

marshallerSupplier

public ServiceDescriptor.Builder marshallerSupplier(MarshallerSupplier marshallerSupplier)

Description copied from interface: ServiceDescriptor.Rules

Register the MarshallerSupplier for the service.

Specified by:

marshallerSupplier in interface ServiceDescriptor.Rules

Parameters:

marshallerSupplier - the MarshallerSupplier for the service

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

unary

public <ReqT,ResT> ServiceDescriptor.Builder unary(String name,
                                                         io.grpc.stub.ServerCalls.UnaryMethod<ReqT,ResT> method)

Description copied from interface: ServiceDescriptor.Rules

Register unary method for the service.

Specified by:

unary in interface ServiceDescriptor.Rules

Type Parameters:

ReqT - the method request type

ResT - the method response type

Parameters:

name - the name of the method

method - the unary method to register

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

unary

public <ReqT,ResT> ServiceDescriptor.Builder unary(String name,
                                                         io.grpc.stub.ServerCalls.UnaryMethod<ReqT,ResT> method,
                                                         MethodDescriptor.Configurer<ReqT,ResT> configurer)

Description copied from interface: ServiceDescriptor.Rules

Register unary method for the service.

Specified by:

unary in interface ServiceDescriptor.Rules

Type Parameters:

ReqT - the method request type

ResT - the method response type

Parameters:

name - the name of the method

method - the unary method to register

configurer - the method configurer

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

serverStreaming

public <ReqT,ResT> ServiceDescriptor.Builder serverStreaming(String name,
                                                                   io.grpc.stub.ServerCalls.ServerStreamingMethod<ReqT,ResT> method)

Description copied from interface: ServiceDescriptor.Rules

Register server streaming method for the service.

Specified by:

serverStreaming in interface ServiceDescriptor.Rules

Type Parameters:

ReqT - the method request type

ResT - the method response type

Parameters:

name - the name of the method

method - the server streaming method to register

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

serverStreaming

public <ReqT,ResT> ServiceDescriptor.Builder serverStreaming(String name,
                                                                   io.grpc.stub.ServerCalls.ServerStreamingMethod<ReqT,ResT> method,
                                                                   MethodDescriptor.Configurer<ReqT,ResT> configurer)

Description copied from interface: ServiceDescriptor.Rules

Register server streaming method for the service.

Specified by:

serverStreaming in interface ServiceDescriptor.Rules

Type Parameters:

ReqT - the method request type

ResT - the method response type

Parameters:

name - the name of the method

method - the server streaming method to register

configurer - the method configurer

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

clientStreaming

public <ReqT,ResT> ServiceDescriptor.Builder clientStreaming(String name,
                                                                   io.grpc.stub.ServerCalls.ClientStreamingMethod<ReqT,ResT> method)

Description copied from interface: ServiceDescriptor.Rules

Register client streaming method for the service.

Specified by:

clientStreaming in interface ServiceDescriptor.Rules

Type Parameters:

ReqT - the method request type

ResT - the method response type

Parameters:

name - the name of the method

method - the client streaming method to register

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

clientStreaming

public <ReqT,ResT> ServiceDescriptor.Builder clientStreaming(String name,
                                                                   io.grpc.stub.ServerCalls.ClientStreamingMethod<ReqT,ResT> method,
                                                                   MethodDescriptor.Configurer<ReqT,ResT> configurer)

Description copied from interface: ServiceDescriptor.Rules

Register client streaming method for the service.

Specified by:

clientStreaming in interface ServiceDescriptor.Rules

Type Parameters:

ReqT - the method request type

ResT - the method response type

Parameters:

name - the name of the method

method - the client streaming method to register

configurer - the method configurer

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

bidirectional

public <ReqT,ResT> ServiceDescriptor.Builder bidirectional(String name,
                                                                 io.grpc.stub.ServerCalls.BidiStreamingMethod<ReqT,ResT> method)

Description copied from interface: ServiceDescriptor.Rules

Register bi-directional streaming method for the service.

Specified by:

bidirectional in interface ServiceDescriptor.Rules

Type Parameters:

ReqT - the method request type

ResT - the method response type

Parameters:

name - the name of the method

method - the bi-directional streaming method to register

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

bidirectional

public <ReqT,ResT> ServiceDescriptor.Builder bidirectional(String name,
                                                                 io.grpc.stub.ServerCalls.BidiStreamingMethod<ReqT,ResT> method,
                                                                 MethodDescriptor.Configurer<ReqT,ResT> configurer)

Description copied from interface: ServiceDescriptor.Rules

Register bi-directional streaming method for the service.

Specified by:

bidirectional in interface ServiceDescriptor.Rules

Type Parameters:

ReqT - the method request type

ResT - the method response type

Parameters:

name - the name of the method

method - the bi-directional streaming method to register

configurer - the method configurer

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

intercept

public ServiceDescriptor.Builder intercept(io.grpc.ServerInterceptor... interceptors)

Description copied from interface: ServiceDescriptor.Rules

Add one or more ServerInterceptor instances that will intercept calls to this service.

If the added interceptors are annotated with the Priority annotation then that value will be used to assign a priority to use when applying the interceptor otherwise a priority of InterceptorPriorities.USER will be used.

Specified by:

intercept in interface ServiceDescriptor.Rules

Parameters:

interceptors - one or more ServerInterceptors to add

Returns:

this builder to allow fluent method chaining

intercept

public ServiceDescriptor.Builder intercept(int priority,
                                           io.grpc.ServerInterceptor... interceptors)

Description copied from interface: ServiceDescriptor.Rules

Add one or more ServerInterceptor instances that will intercept calls to this service.

The added interceptors will be applied using the specified priority.

Specified by:

intercept in interface ServiceDescriptor.Rules

Parameters:

priority - the priority to assign to the interceptors

interceptors - one or more ServerInterceptors to add

Returns:

this builder to allow fluent method chaining

intercept

public ServiceDescriptor.Builder intercept(String methodName,
                                           io.grpc.ServerInterceptor... interceptors)

Description copied from interface: ServiceDescriptor.Rules

Register one or more interceptors for a named method of the service.

If the added interceptors are annotated with the Priority annotation then that value will be used to assign a priority to use when applying the interceptor otherwise a priority of InterceptorPriorities.USER will be used.

Specified by:

intercept in interface ServiceDescriptor.Rules

Parameters:

methodName - the name of the method to intercept

interceptors - the interceptor(s) to register

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

intercept

public ServiceDescriptor.Builder intercept(String methodName,
                                           int priority,
                                           io.grpc.ServerInterceptor... interceptors)

Description copied from interface: ServiceDescriptor.Rules

Register one or more interceptors for a named method of the service.

The added interceptors will be applied using the specified priority.

Specified by:

intercept in interface ServiceDescriptor.Rules

Parameters:

methodName - the name of the method to intercept

priority - the priority to assign to the interceptors

interceptors - the interceptor(s) to register

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

addContextValue

public <V> ServiceDescriptor.Builder addContextValue(io.grpc.Context.Key<V> key,
                                                     V value)

Description copied from interface: ServiceDescriptor.Rules

Add value to the Context for the service.

Specified by:

addContextValue in interface ServiceDescriptor.Rules

Type Parameters:

V - the type of the value

Parameters:

key - the key for the context value

value - the value to add

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

healthCheck

public ServiceDescriptor.Builder healthCheck(HealthCheck healthCheck)

Description copied from interface: ServiceDescriptor.Rules

Register the service HealthCheck.

Specified by:

healthCheck in interface ServiceDescriptor.Rules

Parameters:

healthCheck - the service HealthCheck

Returns:

this ServiceDescriptor.Rules instance for fluent call chaining

build

public ServiceDescriptor build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<ServiceDescriptor>

Returns:

instance of the built type

toString

public String toString()

Overrides:

toString in class Object