Class GrpcServletRegistration

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

org.springframework.boot.web.servlet.DynamicRegistrationBean<ServletRegistration.Dynamic>

org.springframework.boot.grpc.server.GrpcServletRegistration

All Implemented Interfaces:

Aware, BeanNameAware, ServletContextInitializer, Ordered

public class GrpcServletRegistration
extends DynamicRegistrationBean<ServletRegistration.Dynamic>

DynamicRegistrationBean that can be used to register a GrpcServlet.

Since:

4.0.0

Author:

David Syer, Chris Bono, Toshiaki Maki, Phillip Webb

Field Summary

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
GrpcServletRegistration(org.springframework.grpc.server.service.GrpcServiceDiscoverer serviceDiscoverer, org.springframework.grpc.server.service.GrpcServiceConfigurer serviceConfigurer)	Create a new GrpcServletRegistration instance.
GrpcServletRegistration(org.springframework.grpc.server.service.GrpcServiceDiscoverer serviceDiscoverer, org.springframework.grpc.server.service.GrpcServiceConfigurer serviceConfigurer, @Nullable Consumer<io.grpc.servlet.jakarta.ServletServerBuilder> serverBuilderCustomizer)	Create a new GrpcServletRegistration instance.

Method Summary

Modifier and Type	Method	Description
protected ServletRegistration.Dynamic	addRegistration(String description, ServletContext servletContext)
protected void	configure(ServletRegistration.Dynamic registration)
protected String	getDescription()	Return a description of the registration.

Methods inherited from class DynamicRegistrationBean

addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setBeanName, setIgnoreRegistrationFailure, setInitParameters, setName

Methods inherited from class RegistrationBean

getOrder, isEnabled, onStartup, setEnabled, setOrder

Methods inherited from class Object

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

Constructor Details

GrpcServletRegistration

public GrpcServletRegistration(org.springframework.grpc.server.service.GrpcServiceDiscoverer serviceDiscoverer,
 org.springframework.grpc.server.service.GrpcServiceConfigurer serviceConfigurer)

Create a new GrpcServletRegistration instance.

Parameters:

serviceDiscoverer - the gRPC service discoverer

serviceConfigurer - the gRPC service configurer

GrpcServletRegistration

public GrpcServletRegistration(org.springframework.grpc.server.service.GrpcServiceDiscoverer serviceDiscoverer,
 org.springframework.grpc.server.service.GrpcServiceConfigurer serviceConfigurer,
 @Nullable Consumer<io.grpc.servlet.jakarta.ServletServerBuilder> serverBuilderCustomizer)

Create a new GrpcServletRegistration instance.

Parameters:

serviceDiscoverer - the gRPC service discoverer

serviceConfigurer - the gRPC service configurer

serverBuilderCustomizer - an optional customizer to configure the ServletServerBuilder

Method Details

addRegistration

protected ServletRegistration.Dynamic addRegistration(String description,
 ServletContext servletContext)

Specified by:

addRegistration in class DynamicRegistrationBean<ServletRegistration.Dynamic>

configure

protected void configure(ServletRegistration.Dynamic registration)

Overrides:

configure in class DynamicRegistrationBean<ServletRegistration.Dynamic>

getDescription

protected String getDescription()

Description copied from class: RegistrationBean

Return a description of the registration. For example "Servlet resourceServlet"

Specified by:

getDescription in class RegistrationBean

Returns:

a description of the registration