Package com.linecorp.armeria.spring
Class HttpServiceRegistrationBean
java.lang.Object
com.linecorp.armeria.spring.AbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
com.linecorp.armeria.spring.HttpServiceRegistrationBean
public class HttpServiceRegistrationBean extends AbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
A bean with information for registering an http service.
It enables Micrometer metric collection of the service automatically.
> @Bean
> public HttpServiceRegistrationBean okService() {
> return new HttpServiceRegistrationBean()
> .setServiceName("okService")
> .setService(new OkService())
> .setRoute(Route.builder().path("/ok").methods(HttpMethod.GET, HttpMethod.POST).build())
> .setDecorators(LoggingService.newDecorator());
> }
-
Constructor Summary
Constructors Constructor Description HttpServiceRegistrationBean()
-
Method Summary
Modifier and Type Method Description HttpServiceRegistrationBean
addExampleHeaders(@NotNull Iterable<? extends HttpHeaders> exampleHeaders)
Adds example HTTP headers for all service methods.HttpServiceRegistrationBean
addExampleHeaders(HttpHeaders exampleHeaders)
Adds an example HTTP header for all service methods.HttpServiceRegistrationBean
addExampleHeaders(HttpHeaders... exampleHeaders)
Adds example HTTP headers for all service methods.HttpServiceRegistrationBean
addExampleRequests(@NotNull Iterable<? extends Object> exampleRequests)
Adds example requests forAbstractServiceRegistrationBean.getService()
.HttpServiceRegistrationBean
addExampleRequests(@NotNull Object exampleRequest)
Adds an example request forAbstractServiceRegistrationBean.getService()
.HttpServiceRegistrationBean
addExampleRequests(Object... exampleRequests)
Adds example requests forAbstractServiceRegistrationBean.getService()
.@NotNull Route
getRoute()
Returns theRoute
that this service map to.HttpServiceRegistrationBean
setExampleHeaders(@NotNull HttpHeaders... exampleHeaders)
Sets example HTTP headers for all service methods.HttpServiceRegistrationBean
setExampleHeaders(@NotNull Iterable<? extends HttpHeaders> exampleHeaders)
Sets example HTTP headers for all service methods.HttpServiceRegistrationBean
setExampleHeaders(@NotNull Collection<? extends HttpHeaders> exampleHeaders)
Sets example HTTP headers for all service methods.HttpServiceRegistrationBean
setExampleRequests(@NotNull Iterable<? extends Object> exampleRequests)
Sets example requests forAbstractServiceRegistrationBean.getService()
.HttpServiceRegistrationBean
setExampleRequests(@NotNull Collection<? extends Object> exampleRequests)
Sets example requests forAbstractServiceRegistrationBean.getService()
.HttpServiceRegistrationBean
setExampleRequests(Object... exampleRequests)
Sets example requests forAbstractServiceRegistrationBean.getService()
.HttpServiceRegistrationBean
setPathPattern(@NotNull String pathPattern)
Sets the path pattern of the service.HttpServiceRegistrationBean
setRoute(@NotNull Route route)
Sets aRoute
that this service map to.Methods inherited from class com.linecorp.armeria.spring.AbstractServiceRegistrationBean
getDecorators, getExampleHeaders, getExampleRequests, getService, getServiceName, setDecorators, setDecorators, setService, setServiceName
-
Constructor Details
-
HttpServiceRegistrationBean
public HttpServiceRegistrationBean()
-
-
Method Details
-
getRoute
Returns theRoute
that this service map to. -
setRoute
Sets aRoute
that this service map to. -
setPathPattern
Sets the path pattern of the service. -
setExampleRequests
public HttpServiceRegistrationBean setExampleRequests(@NotNull @NotNull Collection<? extends Object> exampleRequests)Description copied from class:AbstractServiceRegistrationBean
Sets example requests forAbstractServiceRegistrationBean.getService()
.- Overrides:
setExampleRequests
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
setExampleRequests
public HttpServiceRegistrationBean setExampleRequests(@NotNull @NotNull Iterable<? extends Object> exampleRequests)Description copied from class:AbstractServiceRegistrationBean
Sets example requests forAbstractServiceRegistrationBean.getService()
.- Overrides:
setExampleRequests
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
setExampleRequests
Description copied from class:AbstractServiceRegistrationBean
Sets example requests forAbstractServiceRegistrationBean.getService()
.- Overrides:
setExampleRequests
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
addExampleRequests
public HttpServiceRegistrationBean addExampleRequests(@NotNull @NotNull Iterable<? extends Object> exampleRequests)Description copied from class:AbstractServiceRegistrationBean
Adds example requests forAbstractServiceRegistrationBean.getService()
.- Overrides:
addExampleRequests
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
addExampleRequests
Description copied from class:AbstractServiceRegistrationBean
Adds example requests forAbstractServiceRegistrationBean.getService()
.- Overrides:
addExampleRequests
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
addExampleRequests
Description copied from class:AbstractServiceRegistrationBean
Adds an example request forAbstractServiceRegistrationBean.getService()
.- Overrides:
addExampleRequests
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
setExampleHeaders
public HttpServiceRegistrationBean setExampleHeaders(@NotNull @NotNull Collection<? extends HttpHeaders> exampleHeaders)Description copied from class:AbstractServiceRegistrationBean
Sets example HTTP headers for all service methods.- Overrides:
setExampleHeaders
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
setExampleHeaders
public HttpServiceRegistrationBean setExampleHeaders(@NotNull @NotNull Iterable<? extends HttpHeaders> exampleHeaders)Description copied from class:AbstractServiceRegistrationBean
Sets example HTTP headers for all service methods.- Overrides:
setExampleHeaders
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
setExampleHeaders
public HttpServiceRegistrationBean setExampleHeaders(@NotNull @NotNull HttpHeaders... exampleHeaders)Description copied from class:AbstractServiceRegistrationBean
Sets example HTTP headers for all service methods.- Overrides:
setExampleHeaders
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
addExampleHeaders
public HttpServiceRegistrationBean addExampleHeaders(@NotNull @NotNull Iterable<? extends HttpHeaders> exampleHeaders)Description copied from class:AbstractServiceRegistrationBean
Adds example HTTP headers for all service methods.- Overrides:
addExampleHeaders
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
addExampleHeaders
Description copied from class:AbstractServiceRegistrationBean
Adds example HTTP headers for all service methods.- Overrides:
addExampleHeaders
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-
addExampleHeaders
Description copied from class:AbstractServiceRegistrationBean
Adds an example HTTP header for all service methods.- Overrides:
addExampleHeaders
in classAbstractServiceRegistrationBean<HttpService,HttpServiceRegistrationBean,Object,HttpHeaders>
-