Module io.helidon.grpc.server

Package io.helidon.grpc.server

Class ServiceDescriptor

java.lang.Object

io.helidon.grpc.server.ServiceDescriptor

public class ServiceDescriptor
extends Object

Encapsulates all metadata necessary to create and deploy a gRPC service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ServiceDescriptor.Aware	Allows users to specify that they would like to have access to a ServiceDescriptor within their ServerInterceptor implementation.
static class	ServiceDescriptor.Builder	A ServiceDescriptor builder.
static interface	ServiceDescriptor.Configurer	An interface implemented by classs that can configure a ServiceDescriptor.Rules.
static interface	ServiceDescriptor.Rules	Fluent configuration interface for the ServiceDescriptor.

Field Summary

Fields

Modifier and Type	Field	Description
static io.grpc.Context.Key<ServiceDescriptor>	SERVICE_DESCRIPTOR_KEY	The Context.Key to use to obtain the ServiceDescriptor.

Method Summary

Modifier and Type	Method	Description
static ServiceDescriptor.Builder	builder(io.grpc.BindableService service)	Create a ServiceDescriptor.Builder.
static ServiceDescriptor.Builder	builder(GrpcService service)	Create a ServiceDescriptor.Builder.
static ServiceDescriptor.Builder	builder(Class serviceClass, String name)	Create a ServiceDescriptor.Builder.
Map<io.grpc.Context.Key<?>,Object>	context()	Return context map.
boolean	equals(Object o)
String	fullName()	Returns the service name prefixed with package directive if one exists.
int	hashCode()
HealthCheck	healthCheck()	Return a HealthCheck for this service.
PriorityBag<io.grpc.ServerInterceptor>	interceptors()	Return service interceptors.
MethodDescriptor	method(String name)	Return MethodDescriptor for a specified method name.
Collection<MethodDescriptor>	methods()	Return service methods.
String	name()	Return service name.
String	packageName()	Returns package name from proto file.
com.google.protobuf.Descriptors.FileDescriptor	proto()	Return a proto file descriptor.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERVICE_DESCRIPTOR_KEY

public static final io.grpc.Context.Key<ServiceDescriptor> SERVICE_DESCRIPTOR_KEY

The Context.Key to use to obtain the ServiceDescriptor.

Method Detail

name

public String name()

Return service name.

Returns:

service name

fullName

public String fullName()

Returns the service name prefixed with package directive if one exists.

Returns:

service name prefixed with package directive if one exists.

packageName

public String packageName()

Returns package name from proto file.

Returns:

package name from proto file

method

public MethodDescriptor method(String name)

Return MethodDescriptor for a specified method name.

Parameters:

name - method name

Returns:

method descriptor for the specified name

methods

public Collection<MethodDescriptor> methods()

Return service methods.

Returns:

service methods

interceptors

public PriorityBag<io.grpc.ServerInterceptor> interceptors()

Return service interceptors.

Returns:

service interceptors

context

public Map<io.grpc.Context.Key<?>,Object> context()

Return context map.

Returns:

context map

healthCheck

public HealthCheck healthCheck()

Return a HealthCheck for this service.

Returns:

a health check

proto

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

Return a proto file descriptor.

Returns:

a proto file descriptor

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static ServiceDescriptor.Builder builder(Class serviceClass,
                                                String name)

Create a ServiceDescriptor.Builder.

Parameters:

serviceClass - the Class representing the service

name - the name of the service

Returns:

a ServiceDescriptor.Builder

builder

public static ServiceDescriptor.Builder builder(GrpcService service)

Create a ServiceDescriptor.Builder.

Parameters:

service - the GrpcService to use to initialise the builder

Returns:

a ServiceDescriptor.Builder

builder

public static ServiceDescriptor.Builder builder(io.grpc.BindableService service)

Create a ServiceDescriptor.Builder.

Parameters:

service - the BindableService to use to initialise the builder

Returns:

a ServiceDescriptor.Builder