Users MUST provide an implementation to configure the provided HttpRouter. The HttpRouter exposes a DSL which results in a configured Finagle Service[-Request, +Response] to serve on the ListeningServer.

Default com.twitter.inject.TwitterModule for providing a com.twitter.finagle.filter.LogFormatter.

ONLY INTENDED FOR USE BY THE FRAMEWORK.

Default modules can be overridden in production by overriding methods in your App or Server.

We take special care to make sure the module is not null, since a common bug is overriding the default methods using a val instead of a def

ONLY INTENDED FOR USE BY THE FRAMEWORK.

ONLY INTENDED FOR USE BY THE FRAMEWORK.

After postWarmup, all external servers have been started, and we can now enable our health endpoint.

Callback to register multiple Awaitable instances for the server to await (block) on.

Callback to register an Awaitable instance for the server to await (block) on.

All registered Awaitable instances are entangled by the server such that if any registered Awaitable exits it will trigger all registered Awaitable instances to exit.

After warmup but before accepting traffic promote to old gen (which triggers gc).

Serve the Service[-Request, +Response] from the configured HttpRouter.

Serve the Service[-Request, +Response] from the configured HttpRouter.

This method allows for further configuration of the http server for parameters not exposed by this trait or for overriding defaults provided herein, e.g.,

override def configureHttpServer(server: Http.Server): Http.Server = { server .withMaxInitialLineSize(2048) }

This method allows for further configuration of the https server for parameters not exposed by this trait or for overriding defaults provided herein, e.g.,

override def configureHttpsServer(server: Http.Server): Http.Server = { server .withMaxInitialLineSize(2048) .withTransport.tls(....) }

com.twitter.logging.Logging.configureLoggerFactories() removes all added JUL handlers and adds only handlers defined by com.twitter.logging.Logging.loggerFactories.

Logging.configureLoggerFactories would thus remove the installed SLF4J BridgeHandler from com.twitter.server.TwitterServer. Therefore, we override with a no-op to prevent the SLF4J BridgeHandler from being removed.

A Java-friendly method for creating a named Flag.

A Java-friendly way to create a "mandatory" Flag. "Mandatory" flags MUST have a value provided as an application argument (as they have no default value to be used).

Default server announcement String for the HTTP server used as the Flag default value for httpAnnounceFlag. This can be overridden to provide a different default programmatically when a flag value cannot be passed. An empty String value is an indication to not perform any announcement of the server.

In general, users should prefer setting the httpAnnounceFlag Flag value.

Default external HTTP port used as the Flag default value for httpPortFlag. This can be overridden to provide a different default programmatically when a flag value cannot be passed. The format of this value is expected to be a String in the form of ":port".

In general, users should prefer setting the httpPortFlag Flag value.

Default server name for the external HTTP interface used as the Flag default value for httpServerNameFlag. This can be overridden to provide a different default programmatically when a flag value cannot be passed.

In general, users should prefer setting the httpServerNameFlag Flag value.

Default server announcement String for the HTTPS server used as the Flag default value for httpsAnnounceFlag. This can be overridden to provide a different default programmatically when a flag value cannot be passed. An empty String value is an indication to not perform any announcement of the server.

In general, users should prefer setting the httpsAnnounceFlag Flag value.

Default external HTTPS port used as the Flag default value for httpsPortFlag. This can be overridden to provide a different default programmatically when a flag value cannot be passed. The format of this value is expected to be a String in the form of ":port".

In general, users should prefer setting the httpsPortFlag Flag value.

Default server name for serving the external HTTPS interface used as the Flag default value for httpsServerNameFlag. This can be overridden to provide a different default programmatically when a flag value cannot be passed.

In general, users should prefer setting the httpsServerNameFlag Flag value.

Default maximum request message size this server can receive used as the Flag default value for maxRequestSizeFlag. This can be overridden to provide a different default programmatically when a flag value cannot be passed. The format of this flag is expected to be a String which is parsable into a com.twitter.util.StorageUnit.

In general, users should prefer setting the maxRequestSizeFlag Flag value.

Default shutdown timeout used as the Flag default value for shutdownTimeoutFlag. This represents the deadline for the closing of this server which can be overridden to provide a different default programmatically when a flag value cannot be passed.

In general, users should prefer setting the shutdownTimeoutFlag Flag value.

<invalid inheritdoc annotation>

Utility to run a com.twitter.inject.utils.Handler. This is generally used for running a warmup handler in TwitterServer.warmup.

Utility to run a com.twitter.inject.utils.Handler. This is generally used for running a warmup handler in TwitterServer.warmup.

The address to which the underlying Http ListeningServer is bound

Returns the bound port representing the external HTTP interface of this server.

Default com.twitter.inject.TwitterModule for providing an HttpResponseClassifier.

Configuration of the Service[Request, Response] to serve on the ListeningServer is defined by configuring the HttpRouter and not by implementation of this method, thus this method overridden to be final and set to a NilService.

The address to which the underlying Https ListeningServer is bound

Returns the bound port representing the external HTTPS interface of this server.

Default com.twitter.inject.TwitterModule for providing a com.twitter.util.jackson.ScalaObjectMapper.

Production modules from Java.

ONLY INTENDED FOR USE IN TESTING.

Override modules from Java which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.

Name used for registration in the com.twitter.util.registry.Library

ONLY INTENDED FOR USE BY THE FRAMEWORK.

DO NOT BLOCK

Default com.twitter.inject.TwitterModule for providing implementations, com.twitter.finatra.http.marshalling.DefaultMessageBodyReader, com.twitter.finatra.http.marshalling.DefaultMessageBodyWriter.

Production modules.

Called prior to application exiting.

Called prior to application exiting after onExit.

Called prior to application initialization.

ONLY INTENDED FOR USE IN TESTING.

Override modules which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.

After creation of the Injector. Before any other lifecycle methods.

Called after the main method.

If you override this method to create and bind any external interface or to instantiate any awaitable it is expected that you add the Awaitable (or com.twitter.finagle.ListeningServer) to the list of Awaitables using the await[T <: Awaitable[_(awaitable: T): Unit function.

Called before the main method.

Resolve all Finagle clients before warmup method called

Callback method which is executed specifically in the postInjectorStartup lifecycle phase of this server.

This is AFTER the injector is created but BEFORE server warmup has been performed.

This method is thus suitable for starting and awaiting on PubSub publishers or subscribers.

The server is NOT signaled to be started until AFTER this method has executed thus it is imperative that this method is NOT BLOCKED as it will cause the server to not complete startup.

This method can be used to start long-lived processes that run in separate threads from the main() thread. It is expected that you manage these threads manually, e.g., by using a com.twitter.util.FuturePool.

If you override this method to instantiate any com.twitter.util.Awaitable it is expected that you add the com.twitter.util.Awaitable to the list of Awaitables using the await[T <: Awaitable[_]](awaitable: T): Unit function if you want the server to exit when the com.twitter.util.Awaitable exits.

Any exceptions thrown in this method will result in the server exiting.

Callback method which is executed after the injector is created and all lifecycle methods have fully completed but before awaiting on any Awaitables. It is NOT expected that you block in this method as you will prevent completion of the server lifecycle.

The server is signaled as STARTED prior to the execution of this callback as all lifecycle methods have successfully completed and the admin and any external interfaces have started.

This method can be used to start long-lived processes that run in separate threads from the main() thread. It is expected that you manage these threads manually, e.g., by using a com.twitter.util.FuturePool.

Any exceptions thrown in this method will result in the server exiting.

Default com.twitter.inject.TwitterModule for providing a com.twitter.finagle.stats.StatsReceiver.

If false, the underlying Netty pipeline collects HttpChunks into the body of each Request Set to true if you wish to stream parse requests using request.reader.read

Returns the bound port representing the external Thrift interface of this server.

Default com.twitter.inject.TwitterModule for providing a com.twitter.util.validation.ScalaValidator.

Callback method run before TwitterServer.postWarmup, used for performing warm up of this server. Override, but do not call super.warmup() as you will trigger a lint rule violation.

Any exceptions thrown in this method will result in the app exiting.