org.mule.runtime.http.api.server

Interface HttpServer

public interface HttpServer

Represents a ServerSocket connection.

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.
void	dispose() Removes all secondary data to get rid of the server.
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.

Returns:

this server

dispose

void dispose()

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

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.

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