Package com.linecorp.armeria.server.tomcat

Class TomcatService

java.lang.Object

com.linecorp.armeria.server.tomcat.TomcatService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public abstract class TomcatService
extends Object
implements HttpService

An HttpService that dispatches its requests to a web application running in an embedded Tomcat.

See Also:

• TomcatServiceBuilder

Method Summary

Modifier and Type	Method	Description
static TomcatServiceBuilder	builder(File docBase)	Creates a new TomcatServiceBuilder with the web application at the specified document base, which can be a directory or a JAR/WAR file.
static TomcatServiceBuilder	builder(File rootDirOrDocBase, String relativePath)	Creates a new TomcatServiceBuilder with the web application at the specified document base, which can be a directory or a JAR/WAR file.
static TomcatServiceBuilder	builder(Path docBase)	Creates a new TomcatServiceBuilder with the web application at the specified document base, which can be a directory or a JAR/WAR file.
static TomcatServiceBuilder	builder(Path rootDirOrDocBase, String relativePath)	Creates a new TomcatServiceBuilder with the web application at the specified document base, which can be a directory or a JAR/WAR file.
abstract @Nullable Connector	connector()	Returns Tomcat Connector.
ExchangeType	exchangeType(RoutingContext routingContext)	Determines an ExchangeType for this HttpService from the given RoutingContext.
static TomcatService	of(File docBase)	Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.
static TomcatService	of(File rootDir, String relativeDocBase)	Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.
static TomcatService	of(Path docBase)	Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.
static TomcatService	of(Path rootDir, String relativeDocBase)	Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.
static TomcatService	of(Connector connector)	Creates a new TomcatService from an existing Tomcat Connector instance.
static TomcatService	of(Connector connector, String hostname)	Creates a new TomcatService from an existing Tomcat Connector instance.
static TomcatService	of(Tomcat tomcat)	Creates a new TomcatService from an existing Tomcat instance.
final HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves an incoming Request.

Methods inherited from class java.lang.Object

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

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

decorate, decorate

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

as, serviceAdded, shouldCachePath, unwrap

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

equalsIgnoreWrapper, unwrapAll

Method Details

of

public static TomcatService of(File docBase)

Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.

of

public static TomcatService of(Path docBase)

Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.

of

public static TomcatService of(File rootDir,
 String relativeDocBase)

Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.

of

public static TomcatService of(Path rootDir,
 String relativeDocBase)

Creates a new TomcatService with the web application at the specified document base, which can be a directory or a JAR/WAR file.

of

public static TomcatService of(Tomcat tomcat)

Creates a new TomcatService from an existing Tomcat instance. If the specified Tomcat instance is not configured properly, the returned TomcatService may respond with '503 Service Not Available' error.

Returns:

a new TomcatService, which will not manage the provided Tomcat instance.

of

public static TomcatService of(Connector connector)

Creates a new TomcatService from an existing Tomcat Connector instance. If the specified Connector instance is not configured properly, the returned TomcatService may respond with '503 Service Not Available' error.

Returns:

a new TomcatService, which will not manage the provided Connector instance.

of

public static TomcatService of(Connector connector,
 String hostname)

Creates a new TomcatService from an existing Tomcat Connector instance. If the specified Connector instance is not configured properly, the returned TomcatService may respond with '503 Service Not Available' error.

Returns:

a new TomcatService, which will not manage the provided Connector instance.

builder

public static TomcatServiceBuilder builder(File docBase)

Creates a new TomcatServiceBuilder with the web application at the specified document base, which can be a directory or a JAR/WAR file.

builder

public static TomcatServiceBuilder builder(Path docBase)

Creates a new TomcatServiceBuilder with the web application at the specified document base, which can be a directory or a JAR/WAR file.

builder

public static TomcatServiceBuilder builder(File rootDirOrDocBase,
 String relativePath)

Creates a new TomcatServiceBuilder with the web application at the specified document base, which can be a directory or a JAR/WAR file.

builder

public static TomcatServiceBuilder builder(Path rootDirOrDocBase,
 String relativePath)

Creates a new TomcatServiceBuilder with the web application at the specified document base, which can be a directory or a JAR/WAR file.

connector

@Nullable
public abstract @Nullable Connector connector()

Returns Tomcat Connector.

Returns:

the Tomcat Connector, or null if the Connector is not available yet.

serve

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

Description copied from interface: Service

Serves an incoming Request.

Specified by:

serve in interface HttpService

Specified by:

serve in interface Service<HttpRequest,HttpResponse>

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception

exchangeType

public ExchangeType exchangeType(RoutingContext routingContext)

Description copied from interface: HttpService

Determines an ExchangeType for this HttpService from the given RoutingContext. By default, ExchangeType.BIDI_STREAMING is set.

Note that an HttpRequest will be aggregated before serving the HttpService if ExchangeType.UNARY or ExchangeType.RESPONSE_STREAMING is set.

Specified by:

exchangeType in interface HttpService