Uses of Interface
com.linecorp.armeria.server.ServiceRequestContext

Packages that use ServiceRequestContext

Package	Description
com.linecorp.armeria.client	Client core.
com.linecorp.armeria.internal.server.annotation	Various classes used internally.
com.linecorp.armeria.server	Server core.
com.linecorp.armeria.server.annotation	Annotations for building a RESTful service.
com.linecorp.armeria.server.auth	HTTP authorization service.
com.linecorp.armeria.server.composition	Service composition.
com.linecorp.armeria.server.cors	Cross-Origin Resource Sharing (CORS) support.
com.linecorp.armeria.server.docs	Documentation service.
com.linecorp.armeria.server.encoding	HTTP content encoding service.
com.linecorp.armeria.server.file	HTTP static file service.
com.linecorp.armeria.server.healthcheck	HTTP health check service for load balancers.
com.linecorp.armeria.server.logging	Logging and metric-collecting service decorators.
com.linecorp.armeria.server.metric	Metric-collecting service decorators and exporters.
com.linecorp.armeria.server.throttling	Request throttling service decorators and strategies.

Uses of ServiceRequestContext in com.linecorp.armeria.client

Methods in com.linecorp.armeria.client that return ServiceRequestContext

Modifier and Type	Method and Description
ServiceRequestContext	DefaultClientRequestContext.root()
ServiceRequestContext	ClientRequestContextWrapper.root()
ServiceRequestContext	ClientRequestContext.root() Returns the ServiceRequestContext whose Service invokes the Client Request which created this ClientRequestContext, or null if this client request was not made in the context of a server request.

Uses of ServiceRequestContext in com.linecorp.armeria.internal.server.annotation

Methods in com.linecorp.armeria.internal.server.annotation with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
HttpResponse	AnnotatedService.serve(ServiceRequestContext ctx, HttpRequest req)

Uses of ServiceRequestContext in com.linecorp.armeria.server

Classes in com.linecorp.armeria.server that implement ServiceRequestContext

Modifier and Type	Class and Description
class	DefaultServiceRequestContext Default ServiceRequestContext implementation.
class	ServiceRequestContextWrapper Wraps an existing ServiceRequestContext.

Methods in com.linecorp.armeria.server that return ServiceRequestContext

Modifier and Type	Method and Description
ServiceRequestContext	ServiceRequestContextBuilder.build() Returns a new ServiceRequestContext created with the properties of this builder.
static ServiceRequestContext	ServiceRequestContext.current() Returns the server-side context of the Request that is being handled in the current thread.
static ServiceRequestContext	ServiceRequestContext.currentOrNull() Returns the server-side context of the Request that is being handled in the current thread.
ServiceRequestContext	ServiceRequestContextWrapper.newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)
ServiceRequestContext	ServiceRequestContext.newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)
ServiceRequestContext	DefaultServiceRequestContext.newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)
static ServiceRequestContext	ServiceRequestContext.of(HttpRequest request) Returns a new ServiceRequestContext created from the specified HttpRequest.

Methods in com.linecorp.armeria.server with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
protected HttpResponse	AbstractHttpService.doDelete(ServiceRequestContext ctx, HttpRequest req) Handles a DELETE request.
protected void	AbstractHttpService.doDelete(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use AbstractHttpService.doDelete(ServiceRequestContext, HttpRequest).
protected HttpResponse	AbstractHttpService.doGet(ServiceRequestContext ctx, HttpRequest req) Handles a GET request.
protected void	AbstractHttpService.doGet(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use AbstractHttpService.doGet(ServiceRequestContext, HttpRequest).
protected HttpResponse	AbstractHttpService.doHead(ServiceRequestContext ctx, HttpRequest req) Handles a HEAD request.
protected void	AbstractHttpService.doHead(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use AbstractHttpService.doHead(ServiceRequestContext, HttpRequest).
protected HttpResponse	AbstractHttpService.doOptions(ServiceRequestContext ctx, HttpRequest req) Handles an OPTIONS request.
protected void	AbstractHttpService.doOptions(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use AbstractHttpService.doOptions(ServiceRequestContext, HttpRequest).
protected HttpResponse	AbstractHttpService.doPatch(ServiceRequestContext ctx, HttpRequest req) Handles a PATCH request.
protected void	AbstractHttpService.doPatch(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use AbstractHttpService.doPatch(ServiceRequestContext, HttpRequest).
protected HttpResponse	AbstractHttpService.doPost(ServiceRequestContext ctx, HttpRequest req) Handles a POST request.
protected void	AbstractHttpService.doPost(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use AbstractHttpService.doPost(ServiceRequestContext, HttpRequest).
protected HttpResponse	AbstractHttpService.doPut(ServiceRequestContext ctx, HttpRequest req) Handles a PUT request.
protected void	AbstractHttpService.doPut(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use AbstractHttpService.doPut(ServiceRequestContext, HttpRequest).
protected HttpResponse	AbstractHttpService.doTrace(ServiceRequestContext ctx, HttpRequest req) Handles a TRACE request.
protected void	AbstractHttpService.doTrace(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use AbstractHttpService.doTrace(ServiceRequestContext, HttpRequest).
HttpResponse	DecoratingHttpServiceFunction.serve(HttpService delegate, ServiceRequestContext ctx, HttpRequest req) Serves an incoming HttpRequest.
RpcResponse	DecoratingRpcServiceFunction.serve(RpcService delegate, ServiceRequestContext ctx, RpcRequest req) Serves an incoming RpcRequest.
HttpResponse	RedirectService.serve(ServiceRequestContext ctx, HttpRequest req) NB: For now we redirect all methods.
HttpResponse	HttpService.serve(ServiceRequestContext ctx, HttpRequest req)
HttpResponse	AbstractHttpService.serve(ServiceRequestContext ctx, HttpRequest req) Serves the specified HttpRequest by delegating it to the matching 'doMETHOD()' method.
O	Service.serve(ServiceRequestContext ctx, I req) Serves an incoming Request.
RpcResponse	RpcService.serve(ServiceRequestContext ctx, RpcRequest req)

Method parameters in com.linecorp.armeria.server with type arguments of type ServiceRequestContext

Modifier and Type	Method and Description
static <T> T	ServiceRequestContext.mapCurrent(Function<? super ServiceRequestContext,T> mapper, Supplier<T> defaultValueSupplier) Maps the server-side context of the Request that is being handled in the current thread.

Constructors in com.linecorp.armeria.server with parameters of type ServiceRequestContext

Constructor and Description
ServiceRequestContextWrapper(ServiceRequestContext delegate) Creates a new instance.

Constructor parameters in com.linecorp.armeria.server with type arguments of type ServiceRequestContext

Constructor and Description
RedirectService(Function<? super ServiceRequestContext,String> locationFunction) Creates a new instance that redirects to the location returned by locationFunction, preserving the query string in the request URI.
RedirectService(Function<? super ServiceRequestContext,String> locationFunction, boolean preserveQueryString) Creates a new instance that redirects to the location returned by locationFunction.
RedirectService(HttpStatus redirectStatus, Function<? super ServiceRequestContext,String> locationFunction) Creates a new instance that redirects to the location returned by locationFunction, preserving the query string in the request URI.
RedirectService(HttpStatus redirectStatus, Function<? super ServiceRequestContext,String> locationFunction, boolean preserveQueryString) Creates a new instance that redirects to the location returned by locationFunction.

Uses of ServiceRequestContext in com.linecorp.armeria.server.annotation

Methods in com.linecorp.armeria.server.annotation with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
Object	StringRequestConverterFunction.convertRequest(ServiceRequestContext ctx, AggregatedHttpRequest request, Class<?> expectedResultType) Converts the specified AggregatedHttpRequest to a String.
Object	RequestConverterFunction.convertRequest(ServiceRequestContext ctx, AggregatedHttpRequest request, Class<?> expectedResultType) Converts the specified request to an object of expectedResultType.
Object	JacksonRequestConverterFunction.convertRequest(ServiceRequestContext ctx, AggregatedHttpRequest request, Class<?> expectedResultType) Converts the specified AggregatedHttpRequest to an object of expectedResultType.
Object	ByteArrayRequestConverterFunction.convertRequest(ServiceRequestContext ctx, AggregatedHttpRequest request, Class<?> expectedResultType) Converts the specified AggregatedHttpRequest to an object of expectedResultType.
HttpResponse	StringResponseConverterFunction.convertResponse(ServiceRequestContext ctx, ResponseHeaders headers, Object result, HttpHeaders trailers)
HttpResponse	ServerSentEventResponseConverterFunction.convertResponse(ServiceRequestContext ctx, ResponseHeaders headers, Object result, HttpHeaders trailers)
HttpResponse	ResponseConverterFunction.convertResponse(ServiceRequestContext ctx, ResponseHeaders headers, Object result, HttpHeaders trailers) Returns HttpResponse instance corresponds to the given result.
HttpResponse	NullToNoContentResponseConverterFunction.convertResponse(ServiceRequestContext ctx, ResponseHeaders headers, Object result, HttpHeaders trailers)
HttpResponse	JacksonResponseConverterFunction.convertResponse(ServiceRequestContext ctx, ResponseHeaders headers, Object result, HttpHeaders trailers)
HttpResponse	ByteArrayResponseConverterFunction.convertResponse(ServiceRequestContext ctx, ResponseHeaders headers, Object result, HttpHeaders trailers)
HttpResponse	ExceptionHandlerFunction.handleException(ServiceRequestContext ctx, HttpRequest req, Throwable cause) Returns an HttpResponse which would be sent back to the client who sent the req.

Uses of ServiceRequestContext in com.linecorp.armeria.server.auth

Methods in com.linecorp.armeria.server.auth with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
O	AuthFailureHandler.authFailed(Service<I,O> delegate, ServiceRequestContext ctx, I req, Throwable cause) Invoked when the authorization of the specified Request has failed.
CompletionStage<Boolean>	Authorizer.authorize(ServiceRequestContext ctx, T data) Authorizes the given data.
O	AuthSuccessHandler.authSucceeded(Service<I,O> delegate, ServiceRequestContext ctx, I req) Invoked when the authorization of the specified Request has succeeded.
HttpResponse	AuthService.serve(ServiceRequestContext ctx, HttpRequest req)

Uses of ServiceRequestContext in com.linecorp.armeria.server.composition

Methods in com.linecorp.armeria.server.composition with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
O	AbstractCompositeService.serve(ServiceRequestContext ctx, I req)

Uses of ServiceRequestContext in com.linecorp.armeria.server.cors

Methods in com.linecorp.armeria.server.cors with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
HttpResponse	CorsService.serve(ServiceRequestContext ctx, HttpRequest req)

Uses of ServiceRequestContext in com.linecorp.armeria.server.docs

Method parameters in com.linecorp.armeria.server.docs with type arguments of type ServiceRequestContext

Modifier and Type	Method and Description
DocServiceBuilder	DocServiceBuilder.injectedScriptSupplier(BiFunction<ServiceRequestContext,HttpRequest,String> supplier) Adds a supplier for Javascript scripts to inject into the <head /> of the debug page HTML.

Uses of ServiceRequestContext in com.linecorp.armeria.server.encoding

Methods in com.linecorp.armeria.server.encoding with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
HttpResponse	EncodingService.serve(ServiceRequestContext ctx, HttpRequest req)

Uses of ServiceRequestContext in com.linecorp.armeria.server.file

Methods in com.linecorp.armeria.server.file with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
protected HttpResponse	FileService.doGet(ServiceRequestContext ctx, HttpRequest req)

Uses of ServiceRequestContext in com.linecorp.armeria.server.healthcheck

Methods in com.linecorp.armeria.server.healthcheck with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
protected HttpResponse	HttpHealthCheckService.doGet(ServiceRequestContext ctx, HttpRequest req) Deprecated.
protected HttpResponse	HttpHealthCheckService.doHead(ServiceRequestContext ctx, HttpRequest req) Deprecated.
protected HttpResponse	ManagedHttpHealthCheckService.doPut(ServiceRequestContext ctx, HttpRequest req) Deprecated.
CompletionStage<HealthCheckUpdateResult>	HealthCheckUpdateHandler.handle(ServiceRequestContext ctx, HttpRequest req) Determines if the healthiness of the Server needs to be changed or not from the given HttpRequest.
protected CompletionStage<Optional<Boolean>>	ManagedHttpHealthCheckService.mode(ServiceRequestContext ctx, HttpRequest req) Deprecated. Judge the turning mode.
protected AggregatedHttpResponse	HttpHealthCheckService.newHealthyResponse(ServiceRequestContext ctx) Deprecated. Creates a new response which is sent when the Server is healthy.
protected AggregatedHttpResponse	HttpHealthCheckService.newUnhealthyResponse(ServiceRequestContext ctx) Deprecated. Creates a new response which is sent when the Server is unhealthy.
HttpResponse	HealthCheckService.serve(ServiceRequestContext ctx, HttpRequest req)

Uses of ServiceRequestContext in com.linecorp.armeria.server.logging

Methods in com.linecorp.armeria.server.logging with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
HttpResponse	LoggingService.serve(ServiceRequestContext ctx, HttpRequest req)
HttpResponse	ContentPreviewingService.serve(ServiceRequestContext ctx, HttpRequest req)

Method parameters in com.linecorp.armeria.server.logging with type arguments of type ServiceRequestContext

Modifier and Type	Method and Description
LoggingServiceBuilder	LoggingServiceBuilder.sampler(Sampler<? super ServiceRequestContext> sampler) Sets the Sampler that determines which request needs logging.

Uses of ServiceRequestContext in com.linecorp.armeria.server.metric

Methods in com.linecorp.armeria.server.metric with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
protected HttpResponse	PrometheusExpositionService.doGet(ServiceRequestContext ctx, HttpRequest req)
protected HttpResponse	PrometheusExpositionService.doPost(ServiceRequestContext ctx, HttpRequest req)
HttpResponse	MetricCollectingService.serve(ServiceRequestContext ctx, HttpRequest req)

Uses of ServiceRequestContext in com.linecorp.armeria.server.throttling

Methods in com.linecorp.armeria.server.throttling with parameters of type ServiceRequestContext

Modifier and Type	Method and Description
abstract CompletionStage<Boolean>	ThrottlingStrategy.accept(ServiceRequestContext ctx, T request) Returns whether a given request should be treated as failed before it is handled actually.
CompletionStage<Boolean>	RateLimitingThrottlingStrategy.accept(ServiceRequestContext ctx, T request)
protected HttpResponse	ThrottlingService.onFailure(ServiceRequestContext ctx, HttpRequest req, Throwable cause) Invoked when req is throttled.
protected abstract O	AbstractThrottlingService.onFailure(ServiceRequestContext ctx, I req, Throwable cause) Invoked when req is throttled.
protected RpcResponse	ThrottlingRpcService.onFailure(ServiceRequestContext ctx, RpcRequest req, Throwable cause) Invoked when req is throttled.
protected O	AbstractThrottlingService.onSuccess(ServiceRequestContext ctx, I req) Invoked when req is not throttled.
O	AbstractThrottlingService.serve(ServiceRequestContext ctx, I req)

Method parameters in com.linecorp.armeria.server.throttling with type arguments of type ServiceRequestContext

Modifier and Type	Method and Description
static <T extends Request> ThrottlingStrategy<T>	ThrottlingStrategy.of(BiFunction<ServiceRequestContext,T,CompletionStage<Boolean>> function) Creates a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.
static <T extends Request> ThrottlingStrategy<T>	ThrottlingStrategy.of(BiFunction<ServiceRequestContext,T,CompletionStage<Boolean>> function, String strategyName) Creates a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.