org.mule.runtime.http.api.server

Class HttpServerConfiguration.Builder

java.lang.Object

org.mule.runtime.http.api.server.HttpServerConfiguration.Builder

Enclosing class:

HttpServerConfiguration

public static class HttpServerConfiguration.Builder
extends Object

Builder for HttpServerConfigurations. At the very least, a host, a port and a name must be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HttpServerConfiguration	build()
HttpServerConfiguration.Builder	setConnectionIdleTimeout(int connectionIdleTimeout) Defines the number of milliseconds that a connection can remain idle before being closed.
HttpServerConfiguration.Builder	setHost(String host) Defines the host where the requests will be sent to the HttpServer.
HttpServerConfiguration.Builder	setName(String name)
HttpServerConfiguration.Builder	setPort(int port) Defines the port where the requests will be received by the HttpServer.
HttpServerConfiguration.Builder	setSchedulerSupplier(Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier) Defines a Supplier for a Scheduler that will be used by the HttpServer to process requests.
HttpServerConfiguration.Builder	setTlsContextFactory(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory) Required exclusively for HTTPS, this defines through a TlsContextFactory all the TLS related data to establish such connections.
HttpServerConfiguration.Builder	setUsePersistentConnections(boolean usePersistentConnections) Defines if connections should be kept after a request is completed or closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setHost

public HttpServerConfiguration.Builder setHost(String host)

Defines the host where the requests will be sent to the HttpServer. Must be provided.

Parameters:

host - where to establish the server

Returns:

this builder

setPort

public HttpServerConfiguration.Builder setPort(int port)

Defines the port where the requests will be received by the HttpServer. Must be provided.

Parameters:

port - where to listen

Returns:

this builder

setTlsContextFactory

public HttpServerConfiguration.Builder setTlsContextFactory(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)

Required exclusively for HTTPS, this defines through a TlsContextFactory all the TLS related data to establish such connections. Set to null by default.

Parameters:

tlsContextFactory - a TlsContextFactory with the required data.

Returns:

this builder

setUsePersistentConnections

public HttpServerConfiguration.Builder setUsePersistentConnections(boolean usePersistentConnections)

Defines if connections should be kept after a request is completed or closed. Default value is true.

Parameters:

usePersistentConnections - boolean specifying the decision

Returns:

this builder

setConnectionIdleTimeout

public HttpServerConfiguration.Builder setConnectionIdleTimeout(int connectionIdleTimeout)

Defines the number of milliseconds that a connection can remain idle before being closed. Only relevant if persistent connections are used, the default value is 30 seconds.

Parameters:

connectionIdleTimeout - timeout value (in milliseconds)

Returns:

this builder

setSchedulerSupplier

public HttpServerConfiguration.Builder setSchedulerSupplier(Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier)

Defines a Supplier for a Scheduler that will be used by the HttpServer to process requests. Must be specified if the server won't be associated to a flow where a processing strategy will define the scheduling.

Parameters:

schedulerSupplier -

Returns:

this builder

setName

public HttpServerConfiguration.Builder setName(String name)

build

public HttpServerConfiguration build()

Returns:

a HttpServerConfiguration as specified.