Package com.linecorp.armeria.spring
Class GrpcServiceRegistrationBean
java.lang.Object
com.linecorp.armeria.spring.AbstractServiceRegistrationBean<HttpServiceWithRoutes,GrpcServiceRegistrationBean,GrpcExampleRequest,GrpcExampleHeaders>
com.linecorp.armeria.spring.GrpcServiceRegistrationBean
@Deprecated public class GrpcServiceRegistrationBean extends AbstractServiceRegistrationBean<HttpServiceWithRoutes,GrpcServiceRegistrationBean,GrpcExampleRequest,GrpcExampleHeaders>
Deprecated.
Use
ArmeriaServerConfigurator
and DocServiceConfigurator
.
> @Bean
> public ArmeriaServerConfigurator myService() {
> return server -> {
> server.service(GrpcService.builder()
> .addService(new HelloService())
> .supportedSerializationFormats(
> GrpcSerializationFormats.values())
> .enableUnframedRequests(true)
> .build(),
> LoggingService.newDecorator());
> };
> }
> @Bean
> public DocServiceConfigurator myServiceDoc() {
> return docServiceBuilder -> {
> docServiceBuilder.exampleRequestForMethod(HelloServiceGrpc.SERVICE_NAME, "Hello",
> HelloRequest.newBuilder()
> .setName("Armeria").build())
> .exampleHttpHeaders(HelloServiceGrpc.SERVICE_NAME,
> HttpHeaders.of("my-header", "headerVal"));
> };
}
A bean with information for registering a gRPC service.
It enables Micrometer metric collection of the service automatically.
> @Bean
> public GrpcServiceRegistrationBean helloService() {
> return new GrpcServiceRegistrationBean()
> .setServiceName("helloService")
> .setService(GrpcService.builder()
> .addService(new HelloService())
> .supportedSerializationFormats(GrpcSerializationFormats.values())
> .enableUnframedRequests(true)
> .build())
> .setDecorators(LoggingService.newDecorator())
> .addExampleRequests(GrpcExampleRequest.of(
> HelloServiceGrpc.SERVICE_NAME, "Hello",
> HelloRequest.newBuilder().setName("Armeria").build()))
> .addExampleHeaders(GrpcExampleHeaders.of(HelloServiceGrpc.SERVICE_NAME,
> HttpHeaders.of("my-header", "headerVal")));
> }
-
Constructor Summary
Constructors Constructor Description GrpcServiceRegistrationBean()
Deprecated. -
Method Summary
Modifier and Type Method Description GrpcServiceRegistrationBean
addExampleHeaders(String serviceName, HttpHeaders exampleHeaders)
GrpcServiceRegistrationBean
addExampleHeaders(String serviceName, CharSequence name, String value)
GrpcServiceRegistrationBean
addExampleHeaders(String serviceName, String methodName, @NotNull HttpHeaders... exampleHeaders)
GrpcServiceRegistrationBean
addExampleHeaders(String serviceName, String methodName, @NotNull Iterable<? extends HttpHeaders> exampleHeaders)
Deprecated.GrpcServiceRegistrationBean
addExampleHeaders(String serviceName, String methodName, HttpHeaders exampleHeaders)
GrpcServiceRegistrationBean
addExampleHeaders(String serviceName, String methodName, CharSequence name, String value)
GrpcServiceRegistrationBean
addExampleRequests(String serviceName, String methodName, Object exampleRequest)
Methods inherited from class com.linecorp.armeria.spring.AbstractServiceRegistrationBean
addExampleHeaders, addExampleHeaders, addExampleHeaders, addExampleRequests, addExampleRequests, addExampleRequests, getDecorators, getExampleHeaders, getExampleRequests, getService, getServiceName, setDecorators, setDecorators, setExampleHeaders, setExampleHeaders, setExampleHeaders, setExampleRequests, setExampleRequests, setExampleRequests, setService, setServiceName
-
Constructor Details
-
GrpcServiceRegistrationBean
public GrpcServiceRegistrationBean()Deprecated.
-
-
Method Details
-
addExampleRequests
@Deprecated public GrpcServiceRegistrationBean addExampleRequests(String serviceName, String methodName, Object exampleRequest)Deprecated.Adds an example request forAbstractServiceRegistrationBean.getService()
. -
addExampleHeaders
@Deprecated public GrpcServiceRegistrationBean addExampleHeaders(String serviceName, HttpHeaders exampleHeaders)Deprecated.Adds an example HTTP header for all service methods. -
addExampleHeaders
@Deprecated public GrpcServiceRegistrationBean addExampleHeaders(String serviceName, CharSequence name, String value)Deprecated.Adds an example HTTP header for all service methods. -
addExampleHeaders
@Deprecated public GrpcServiceRegistrationBean addExampleHeaders(String serviceName, String methodName, CharSequence name, String value)Deprecated.Adds an example HTTP header for the specified method. -
addExampleHeaders
@Deprecated public GrpcServiceRegistrationBean addExampleHeaders(String serviceName, String methodName, HttpHeaders exampleHeaders)Deprecated.Adds an example HTTP header for the specified method. -
addExampleHeaders
@Deprecated public GrpcServiceRegistrationBean addExampleHeaders(String serviceName, String methodName, @NotNull @NotNull Iterable<? extends HttpHeaders> exampleHeaders)Deprecated.Adds example HTTP headers for the specified method. -
addExampleHeaders
@Deprecated public GrpcServiceRegistrationBean addExampleHeaders(String serviceName, String methodName, @NotNull @NotNull HttpHeaders... exampleHeaders)Deprecated.Adds example HTTP headers for the specified method.
-