Package com.linecorp.armeria.server.jetty

Class JettyServiceBuilder

java.lang.Object

com.linecorp.armeria.server.jetty.AbstractJettyServiceBuilder

com.linecorp.armeria.server.jetty.JettyServiceBuilder

public final class JettyServiceBuilder
extends AbstractJettyServiceBuilder

Builds a JettyService. Use JettyService.of(Server) if you have a configured Jetty Server instance.

Method Summary

Modifier and Type	Method	Description
JettyServiceBuilder	attr(String name, Object attribute)	Puts the specified attribute into the Jetty Server.
JettyServiceBuilder	bean(Object bean)	Adds the specified bean to the Jetty Server.
JettyServiceBuilder	bean(Object bean, boolean managed)	Adds the specified bean to the Jetty Server.
JettyService	build()	Returns a newly-created JettyService based on the properties of this builder.
JettyServiceBuilder	configurator(Consumer<? super Server> configurator)	Adds a Consumer that performs additional configuration operations against the Jetty Server created by a JettyService.
JettyServiceBuilder	customizer(Consumer<? super Server> customizer)	Adds a Consumer that performs additional configuration operations against the Jetty Server created by a JettyService.
JettyServiceBuilder	dumpAfterStart(boolean dumpAfterStart)	Sets whether the Jetty Server needs to dump its configuration after it started up.
JettyServiceBuilder	dumpBeforeStop(boolean dumpBeforeStop)	Sets whether the Jetty Server needs to dump its configuration before it shuts down.
JettyServiceBuilder	eventListener(EventListener eventListener)	Adds the specified event listener to the Jetty Server.
JettyServiceBuilder	handler(Handler handler)	Sets the Handler of the Jetty Server.
JettyServiceBuilder	handlerWrapper(HandlerWrapper handlerWrapper)	Adds the specified HandlerWrapper to the Jetty Server.
JettyServiceBuilder	hostname(String hostname)	Sets the default hostname of the Jetty Server.
JettyServiceBuilder	httpConfiguration(HttpConfiguration httpConfiguration)	Adds the specified HttpConfiguration to the Jetty Server.
JettyServiceBuilder	requestLog(RequestLog requestLog)	Sets the RequestLog of the Jetty Server.
JettyServiceBuilder	sessionIdManager(SessionIdManager sessionIdManager)	Sets the SessionIdManager of the Jetty Server.
JettyServiceBuilder	sessionIdManagerFactory(Function<? super Server,? extends SessionIdManager> sessionIdManagerFactory)	Sets the factory that creates a new instance of SessionIdManager for the Jetty Server.
JettyServiceBuilder	stopTimeoutMillis(long stopTimeoutMillis)	Sets the graceful stop time of the AbstractLifeCycle.stop() in milliseconds.
JettyServiceBuilder	tlsReverseDnsLookup(boolean tlsReverseDnsLookup)	Sets whether Jetty has to perform reverse DNS lookup for the remote IP address on a TLS connection.

Methods inherited from class java.lang.Object

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

Method Details

eventListener

public JettyServiceBuilder eventListener(EventListener eventListener)

Adds the specified event listener to the Jetty Server.

hostname

public JettyServiceBuilder hostname(String hostname)

Description copied from class: AbstractJettyServiceBuilder

Sets the default hostname of the Jetty Server.

Overrides:

hostname in class AbstractJettyServiceBuilder

attr

public JettyServiceBuilder attr(String name,
 Object attribute)

Description copied from class: AbstractJettyServiceBuilder

Puts the specified attribute into the Jetty Server.

Overrides:

attr in class AbstractJettyServiceBuilder

See Also:

• Server.setAttribute(String, Object)

bean

public JettyServiceBuilder bean(Object bean)

Description copied from class: AbstractJettyServiceBuilder

Adds the specified bean to the Jetty Server.

Overrides:

bean in class AbstractJettyServiceBuilder

See Also:

• ContainerLifeCycle.addBean(Object)

bean

public JettyServiceBuilder bean(Object bean,
 boolean managed)

Description copied from class: AbstractJettyServiceBuilder

Adds the specified bean to the Jetty Server.

Overrides:

bean in class AbstractJettyServiceBuilder

See Also:

• ContainerLifeCycle.addBean(Object, boolean)

dumpAfterStart

public JettyServiceBuilder dumpAfterStart(boolean dumpAfterStart)

Description copied from class: AbstractJettyServiceBuilder

Sets whether the Jetty Server needs to dump its configuration after it started up.

Overrides:

dumpAfterStart in class AbstractJettyServiceBuilder

See Also:

• Server.setDumpAfterStart(boolean)

dumpBeforeStop

public JettyServiceBuilder dumpBeforeStop(boolean dumpBeforeStop)

Description copied from class: AbstractJettyServiceBuilder

Sets whether the Jetty Server needs to dump its configuration before it shuts down.

Overrides:

dumpBeforeStop in class AbstractJettyServiceBuilder

See Also:

• Server.setDumpBeforeStop(boolean)

handler

public JettyServiceBuilder handler(Handler handler)

Description copied from class: AbstractJettyServiceBuilder

Sets the Handler of the Jetty Server.

Overrides:

handler in class AbstractJettyServiceBuilder

See Also:

• HandlerWrapper.setHandler(Handler)

handlerWrapper

public JettyServiceBuilder handlerWrapper(HandlerWrapper handlerWrapper)

Description copied from class: AbstractJettyServiceBuilder

Adds the specified HandlerWrapper to the Jetty Server.

Overrides:

handlerWrapper in class AbstractJettyServiceBuilder

See Also:

• HandlerWrapper.insertHandler(HandlerWrapper)

httpConfiguration

public JettyServiceBuilder httpConfiguration(HttpConfiguration httpConfiguration)

Description copied from class: AbstractJettyServiceBuilder

Adds the specified HttpConfiguration to the Jetty Server. This method is a type-safe alias of AbstractJettyServiceBuilder.bean(Object).

Overrides:

httpConfiguration in class AbstractJettyServiceBuilder

requestLog

public JettyServiceBuilder requestLog(RequestLog requestLog)

Description copied from class: AbstractJettyServiceBuilder

Sets the RequestLog of the Jetty Server.

Overrides:

requestLog in class AbstractJettyServiceBuilder

See Also:

• Server.setRequestLog(RequestLog)

sessionIdManager

public JettyServiceBuilder sessionIdManager(SessionIdManager sessionIdManager)

Description copied from class: AbstractJettyServiceBuilder

Sets the SessionIdManager of the Jetty Server. This method is a shortcut for:

 sessionIdManagerFactory(server -> sessionIdManager);
 

Overrides:

sessionIdManager in class AbstractJettyServiceBuilder

See Also:

• Server.setSessionIdManager(SessionIdManager)

sessionIdManagerFactory

public JettyServiceBuilder sessionIdManagerFactory(Function<? super Server,? extends SessionIdManager> sessionIdManagerFactory)

Description copied from class: AbstractJettyServiceBuilder

Sets the factory that creates a new instance of SessionIdManager for the Jetty Server.

Overrides:

sessionIdManagerFactory in class AbstractJettyServiceBuilder

See Also:

• Server.setSessionIdManager(SessionIdManager)

stopTimeoutMillis

public JettyServiceBuilder stopTimeoutMillis(long stopTimeoutMillis)

Description copied from class: AbstractJettyServiceBuilder

Sets the graceful stop time of the AbstractLifeCycle.stop() in milliseconds.

Overrides:

stopTimeoutMillis in class AbstractJettyServiceBuilder

See Also:

• Server.setStopTimeout(long)

tlsReverseDnsLookup

public JettyServiceBuilder tlsReverseDnsLookup(boolean tlsReverseDnsLookup)

Description copied from class: AbstractJettyServiceBuilder

Sets whether Jetty has to perform reverse DNS lookup for the remote IP address on a TLS connection. By default, this flag is disabled because it is known to cause performance issues when the DNS server is not responsive enough. However, you might want to take the risk and enable it if you want the same behavior with Jetty 9.3 when mTLS is enabled.

Overrides:

tlsReverseDnsLookup in class AbstractJettyServiceBuilder

See Also:

• Jetty issue #1235
• Jetty commit de7c146

customizer

public JettyServiceBuilder customizer(Consumer<? super Server> customizer)

Description copied from class: AbstractJettyServiceBuilder

Adds a Consumer that performs additional configuration operations against the Jetty Server created by a JettyService.

Overrides:

customizer in class AbstractJettyServiceBuilder

configurator

public JettyServiceBuilder configurator(Consumer<? super Server> configurator)

Description copied from class: AbstractJettyServiceBuilder

Adds a Consumer that performs additional configuration operations against the Jetty Server created by a JettyService.

Overrides:

configurator in class AbstractJettyServiceBuilder

build

public JettyService build()

Returns a newly-created JettyService based on the properties of this builder.