Package com.linecorp.armeria.server.docs

Class DocService

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Service<HttpRequest,HttpResponse>>

com.linecorp.armeria.server.DecoratingService<HttpRequest,HttpResponse,HttpRequest,HttpResponse>

com.linecorp.armeria.server.SimpleDecoratingService<HttpRequest,HttpResponse>

com.linecorp.armeria.server.SimpleDecoratingHttpService

com.linecorp.armeria.server.docs.DocService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public final class DocService
extends SimpleDecoratingHttpService

An HttpService that provides information about the Services running in a Server. It does not require any configuration besides adding it to a VirtualHost; it discovers all the eligible Services automatically.

How is the documentation generated?

DocService looks up the DocServicePlugins available in the current JVM using Java SPI (Service Provider Interface). The DocServicePlugin implementations will generate ServiceSpecifications for the Services they support.

See Also:

• DocServiceBuilder.include(DocServiceFilter)
• DocServiceBuilder.exclude(DocServiceFilter)

Constructor Summary

Constructors

Constructor	Description
DocService()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
static DocServiceBuilder	builder()	Returns a new DocServiceBuilder.
HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves an incoming Request.
void	serviceAdded(ServiceConfig cfg)	Invoked when this service has been added to a Server with the specified configuration.

Methods inherited from class com.linecorp.armeria.server.SimpleDecoratingHttpService

exchangeType, options

Methods inherited from class com.linecorp.armeria.server.DecoratingService

shouldCachePath

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap, unwrapAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.HttpService

decorate, decorate

Methods inherited from interface com.linecorp.armeria.server.Service

as, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Constructor Details

DocService

public DocService()

Creates a new instance.

Method Details

builder

public static DocServiceBuilder builder()

Returns a new DocServiceBuilder.

serviceAdded

public void serviceAdded(ServiceConfig cfg)
                  throws Exception

Description copied from interface: Service

Invoked when this service has been added to a Server with the specified configuration. Please note that this method can be invoked more than once if this service has been added more than once.

Specified by:

serviceAdded in interface Service<HttpRequest,HttpResponse>

Overrides:

serviceAdded in class DecoratingService<HttpRequest,HttpResponse,HttpRequest,HttpResponse>

Throws:

Exception

serve

public HttpResponse serve(ServiceRequestContext ctx,
 HttpRequest req)
                   throws Exception

Description copied from interface: Service

Serves an incoming Request.

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception