org.mule.runtime.http.api.server

Interface HttpServer

@NoImplement
public interface HttpServer

Represents a ServerSocket connection. Notice it should be started to be bound, stopped to be unbound and finally disposed to release all related components. To extends it's functionality and not depend on API changes, this object should be used internally instead of decorated.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
RequestHandlerManager	addRequestHandler(Collection<String> methods, String path, RequestHandler requestHandler) Adds a RequestHandler on the given path and for the given methods.
RequestHandlerManager	addRequestHandler(String path, RequestHandler requestHandler) Adds a RequestHandler on the given path and for all methods.
default WebSocketHandlerManager	addWebSocketHandler(WebSocketHandler handler) Adds a WebSocketHandler
default void	disableTls() Disable TLS dynamically.
void	dispose() Removes all secondary data to get rid of the server.
default void	enableTls(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory) Enable TLS dynamically on this server using the supplied TLS context factory
HttpConstants.Protocol	getProtocol()
ServerAddress	getServerAddress()
boolean	isStopped()
boolean	isStopping()
HttpServer	start() Binds the ServerSocket to the network interface and starts listening for requests.
HttpServer	stop() Unbinds the ServerSocket to the network interface and stops listening for requests.

Method Detail

start

HttpServer start()
          throws IOException

Binds the ServerSocket to the network interface and starts listening for requests.

Returns:

this server

Throws:

IOException - if there was a problem binding to the host and port specified.

stop

HttpServer stop()

Unbinds the ServerSocket to the network interface and stops listening for requests.

Currently executing requests are not affected and may proceed normally until dispose() is called.

Returns:

this server

dispose

void dispose()

Removes all secondary data to get rid of the server. Cannot be undone.

If there are any currently running requests, this method will block until either those requests are finished or a timeout elapses. The requests that were received but didn't start processing, will be finished returning a 503 status code.

getServerAddress

ServerAddress getServerAddress()

Returns:

the server address this server is listening on.

getProtocol

HttpConstants.Protocol getProtocol()

Returns:

the protocol (HTTP or HTTPS) this server is expecting.

isStopping

boolean isStopping()

Returns:

true if the server is currently stopping, false if it's stopped already or if it's not doing stop.

isStopped

boolean isStopped()

Returns:

true if the server is stopped, false otherwise.

enableTls

default void enableTls(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)

Enable TLS dynamically on this server using the supplied TLS context factory

Parameters:

tlsContextFactory - The TLS context factory to be used when dynamically enabled TLS at this server

disableTls

default void disableTls()

Disable TLS dynamically. It should work for when the TLS was dynamically enabled or even when the TLS was statically configured in the listener configuration section of the application.

addRequestHandler

RequestHandlerManager addRequestHandler(Collection<String> methods,
                                        String path,
                                        RequestHandler requestHandler)

Adds a RequestHandler on the given path and for the given methods.

Parameters:

methods - a list of methods to match

path - the path to match

requestHandler - the handler to execute upon a matching request

Returns:

a RequestHandlerManager for the handler

addRequestHandler

RequestHandlerManager addRequestHandler(String path,
                                        RequestHandler requestHandler)

Adds a RequestHandler on the given path and for all methods.

Parameters:

path - the path to match

requestHandler - the handler to execute upon a matching request

Returns:

a RequestHandlerManager for the handler

addWebSocketHandler

default WebSocketHandlerManager addWebSocketHandler(WebSocketHandler handler)

Adds a WebSocketHandler

Parameters:

handler - the handler

Returns:

a WebSocketHandlerManager

Since:

4.2.0