Class GrpcServletRegistration

java.lang.Object
org.springframework.boot.web.servlet.RegistrationBean
org.springframework.boot.web.servlet.DynamicRegistrationBean<jakarta.servlet.ServletRegistration.Dynamic>
org.springframework.boot.grpc.server.GrpcServletRegistration
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.boot.web.servlet.ServletContextInitializer, org.springframework.core.Ordered

public class GrpcServletRegistration extends org.springframework.boot.web.servlet.DynamicRegistrationBean<jakarta.servlet.ServletRegistration.Dynamic>
DynamicRegistrationBean that can be used to register a GrpcServlet.
Since:
4.0.0
  • Field Summary

    Fields inherited from interface org.springframework.core.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 jakarta.servlet.ServletRegistration.Dynamic
    addRegistration(String description, jakarta.servlet.ServletContext servletContext)
     
    protected void
    configure(jakarta.servlet.ServletRegistration.Dynamic registration)
     
    protected String
     

    Methods inherited from class org.springframework.boot.web.servlet.DynamicRegistrationBean

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

    Methods inherited from class org.springframework.boot.web.servlet.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 jakarta.servlet.ServletRegistration.Dynamic addRegistration(String description, jakarta.servlet.ServletContext servletContext)
      Specified by:
      addRegistration in class org.springframework.boot.web.servlet.DynamicRegistrationBean<jakarta.servlet.ServletRegistration.Dynamic>
    • configure

      protected void configure(jakarta.servlet.ServletRegistration.Dynamic registration)
      Overrides:
      configure in class org.springframework.boot.web.servlet.DynamicRegistrationBean<jakarta.servlet.ServletRegistration.Dynamic>
    • getDescription

      protected String getDescription()
      Specified by:
      getDescription in class org.springframework.boot.web.servlet.RegistrationBean