A B C D E F G I M N O P R S T V

A

AbstractMetricCollectingInterceptor - Class in net.devh.boot.grpc.common.metric

An abstract gRPC interceptor that will collect metrics for micrometer.

AbstractMetricCollectingInterceptor(MeterRegistry) - Constructor for class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Creates a new gRPC interceptor that will collect metrics into the given MeterRegistry.

AbstractMetricCollectingInterceptor(MeterRegistry, UnaryOperator<Counter.Builder>, UnaryOperator<Timer.Builder>, Status.Code...) - Constructor for class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Creates a new gRPC interceptor that will collect metrics into the given MeterRegistry and uses the given customizer to configure the Counters and Timers.

AbstractMetricCollectingInterceptor.MetricSet - Class in net.devh.boot.grpc.common.metric

Container for all metrics of a certain call.

AnnotationGrpcCodecDiscoverer - Class in net.devh.boot.grpc.common.codec

A GrpcCodecDiscoverer that searches for beans with the GrpcCodec annotations.

AnnotationGrpcCodecDiscoverer() - Constructor for class net.devh.boot.grpc.common.codec.AnnotationGrpcCodecDiscoverer

asTimerFunction(Supplier<Timer.Builder>) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Creates a new timer function using the given template.

AUTHORIZATION_HEADER - Static variable in class net.devh.boot.grpc.common.security.SecurityConstants

A convenience constant that contains the key for the HTTP Authorization Header.

B

BASIC_AUTH_PREFIX - Static variable in class net.devh.boot.grpc.common.security.SecurityConstants

The prefix for basic auth as used in the SecurityConstants.AUTHORIZATION_HEADER.

BEARER_AUTH_PREFIX - Static variable in class net.devh.boot.grpc.common.security.SecurityConstants

The prefix for bearer auth as used in the SecurityConstants.AUTHORIZATION_HEADER.

C

CLOUD_DISCOVERY_METADATA_PORT - Static variable in class net.devh.boot.grpc.common.util.GrpcUtils

The cloud discovery metadata key used to identify the grpc port.

CodecType - Enum in net.devh.boot.grpc.common.codec

The type of the codec.

counterCustomizer - Variable in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

D

DEFAULT_DEFINITIONS - Static variable in class net.devh.boot.grpc.common.codec.GrpcCodecDefinition

The default encodings used by gRPC.

defaultCompressorRegistry(GrpcCodecDiscoverer) - Method in class net.devh.boot.grpc.common.autoconfigure.GrpcCommonCodecAutoConfiguration

defaultDecompressorRegistry(GrpcCodecDiscoverer) - Method in class net.devh.boot.grpc.common.autoconfigure.GrpcCommonCodecAutoConfiguration

defaultGrpcCodecDiscoverer() - Method in class net.devh.boot.grpc.common.autoconfigure.GrpcCommonCodecAutoConfiguration

E

eagerInitializedCodes - Variable in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

extractMethodName(MethodDescriptor<?, ?>) - Static method in class net.devh.boot.grpc.common.util.GrpcUtils

Extracts the method name from the given method.

extractServiceName(MethodDescriptor<?, ?>) - Static method in class net.devh.boot.grpc.common.util.GrpcUtils

Extracts the service name from the given method.

F

findGrpcCodecs() - Method in class net.devh.boot.grpc.common.codec.AnnotationGrpcCodecDiscoverer

findGrpcCodecs() - Method in interface net.devh.boot.grpc.common.codec.GrpcCodecDiscoverer

Find the grpc codecs that should uses by the client/server.

G

getCodec() - Method in class net.devh.boot.grpc.common.codec.GrpcCodecDefinition

getCodecType() - Method in class net.devh.boot.grpc.common.codec.GrpcCodecDefinition

getRequestCounter() - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor.MetricSet

getResponseCounter() - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor.MetricSet

getTimerFunction() - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor.MetricSet

GrpcCodec - Annotation Type in net.devh.boot.grpc.common.codec

Annotation that marks gRPC codecs that should be registered with a gRPC server.

GrpcCodecDefinition - Class in net.devh.boot.grpc.common.codec

Container class that contains all relevant information about a grpc codec.

GrpcCodecDefinition(Codec, boolean, CodecType) - Constructor for class net.devh.boot.grpc.common.codec.GrpcCodecDefinition

Creates a new GrpcCodecDefinition.

GrpcCodecDiscoverer - Interface in net.devh.boot.grpc.common.codec

An interface for a bean that will be used to find grpc codecs.

GrpcCommonCodecAutoConfiguration - Class in net.devh.boot.grpc.common.autoconfigure

The auto configuration used by Spring-Boot that contains all codec related beans for clients/servers.

GrpcCommonCodecAutoConfiguration() - Constructor for class net.devh.boot.grpc.common.autoconfigure.GrpcCommonCodecAutoConfiguration

GrpcCommonTraceAutoConfiguration - Class in net.devh.boot.grpc.common.autoconfigure

GrpcCommonTraceAutoConfiguration() - Constructor for class net.devh.boot.grpc.common.autoconfigure.GrpcCommonTraceAutoConfiguration

grpcTracing(Tracing) - Method in class net.devh.boot.grpc.common.autoconfigure.GrpcCommonTraceAutoConfiguration

GrpcUtils - Class in net.devh.boot.grpc.common.util

Utility class that contains methods to extract some information from grpc classes.

GZIP_DEFINITION - Static variable in class net.devh.boot.grpc.common.codec.GrpcCodecDefinition

The codec definition for gzip.

I

IDENTITY_DEFINITION - Static variable in class net.devh.boot.grpc.common.codec.GrpcCodecDefinition

The codec definition for identity (no-op).

INTER_PROCESS_DISABLE - Static variable in class net.devh.boot.grpc.common.util.GrpcUtils

The constant for the grpc server port, -1 represents don't start an inter process server.

InterceptorOrder - Class in net.devh.boot.grpc.common.util

A util class with constants that can be used to configure the order of interceptors.

isAdvertised() - Method in class net.devh.boot.grpc.common.codec.GrpcCodecDefinition

isForCompression() - Method in enum net.devh.boot.grpc.common.codec.CodecType

Whether the associated codec should be used for compression.

isForDecompression() - Method in enum net.devh.boot.grpc.common.codec.CodecType

Whether the associated codec should be used for decompression.

M

METRIC_NAME_CLIENT_PROCESSING_DURATION - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The total time taken for the client to complete the call, including network delay

METRIC_NAME_CLIENT_REQUESTS_SENT - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The total number of requests sent

METRIC_NAME_CLIENT_RESPONSES_RECEIVED - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The total number of responses received

METRIC_NAME_SERVER_PROCESSING_DURATION - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The total time taken for the server to complete the call.

METRIC_NAME_SERVER_REQUESTS_RECEIVED - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The total number of requests received

METRIC_NAME_SERVER_RESPONSES_SENT - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The total number of responses sent

MetricConstants - Class in net.devh.boot.grpc.common.metric

Utility class that contains constants that are used multiple times by different classes.

MetricSet(Counter, Counter, Function<Status.Code, Timer>) - Constructor for class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor.MetricSet

Creates a new metric set with the given meter instances.

metricsFor(MethodDescriptor<?, ?>) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Gets or creates a AbstractMetricCollectingInterceptor.MetricSet for the given gRPC method.

MetricUtils - Class in net.devh.boot.grpc.common.metric

Utility class that contains methods to create Meter instances for MethodDescriptors.

N

net.devh.boot.grpc.common.autoconfigure - package net.devh.boot.grpc.common.autoconfigure

The Spring-Boot auto configuration classes that setup the gRPC environment with features that can be used by both the client and the server.

net.devh.boot.grpc.common.codec - package net.devh.boot.grpc.common.codec

Classes related to the gRPC codec usage for both the server and the client.

net.devh.boot.grpc.common.metric - package net.devh.boot.grpc.common.metric

Shared code for grpc metric collection related classes.

net.devh.boot.grpc.common.security - package net.devh.boot.grpc.common.security

Contains classes and utilities that related to security that are used by both the client and the server.

net.devh.boot.grpc.common.util - package net.devh.boot.grpc.common.util

Utilities for both the server and the client.

newMetricsFor(MethodDescriptor<?, ?>) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Creates a AbstractMetricCollectingInterceptor.MetricSet for the given gRPC method.

newProcessingDurationTiming(MeterRegistry) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor.MetricSet

Uses the given registry to create a Timer.Sample that will be reported if the returned consumer is invoked.

newRequestCounterFor(MethodDescriptor<?, ?>) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Creates a new request counter for the given method.

newResponseCounterFor(MethodDescriptor<?, ?>) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Creates a new response counter for the given method.

newTimerFunction(MethodDescriptor<?, ?>) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Creates a new timer for a given code for the given method.

O

ORDER_FIRST - Static variable in class net.devh.boot.grpc.common.util.InterceptorOrder

The order value for interceptors that should be executed first.

ORDER_GLOBAL_EXCEPTION_HANDLING - Static variable in class net.devh.boot.grpc.common.util.InterceptorOrder

The order value for global exception handling interceptors.

ORDER_LAST - Static variable in class net.devh.boot.grpc.common.util.InterceptorOrder

The order value for interceptors that should be executed last.

ORDER_SECURITY_AUTHENTICATION - Static variable in class net.devh.boot.grpc.common.util.InterceptorOrder

The order value for security interceptors related to authentication.

ORDER_SECURITY_AUTHORISATION - Static variable in class net.devh.boot.grpc.common.util.InterceptorOrder

The order value for security interceptors related to authorization checks.

ORDER_SECURITY_EXCEPTION_HANDLING - Static variable in class net.devh.boot.grpc.common.util.InterceptorOrder

The order value for interceptors related security exception handling.

ORDER_TRACING_METRICS - Static variable in class net.devh.boot.grpc.common.util.InterceptorOrder

The order value for tracing and metrics collecting interceptors.

P

prepareCounterFor(MethodDescriptor<?, ?>, String, String) - Static method in class net.devh.boot.grpc.common.metric.MetricUtils

Creates a new counter builder for the given method.

prepareTimerFor(MethodDescriptor<?, ?>, String, String) - Static method in class net.devh.boot.grpc.common.metric.MetricUtils

Creates a new timer builder for the given method.

preregisterMethod(MethodDescriptor<?, ?>) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Pre-registers the given method.

preregisterService(ServiceDescriptor) - Method in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

Pre-registers the all methods provided by the given service.

R

registry - Variable in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

S

SecurityConstants - Class in net.devh.boot.grpc.common.security

A helper class with constants related to grpc security.

setApplicationContext(ApplicationContext) - Method in class net.devh.boot.grpc.common.codec.AnnotationGrpcCodecDiscoverer

T

TAG_METHOD_NAME - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The metrics tag key that belongs to the called method name.

TAG_METHOD_TYPE - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The metrics tag key that belongs to the type of the called method.

TAG_SERVICE_NAME - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The metrics tag key that belongs to the called service name.

TAG_STATUS_CODE - Static variable in class net.devh.boot.grpc.common.metric.MetricConstants

The metrics tag key that belongs to the result status code.

timerCustomizer - Variable in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

V

valueOf(String) - Static method in enum net.devh.boot.grpc.common.codec.CodecType

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.devh.boot.grpc.common.codec.CodecType

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I M N O P R S T V