org.mule.service.http.impl.service.server

Interface HttpServerManager

All Known Implementing Classes:

GrizzlyServerManager

public interface HttpServerManager

A Server managers is in charge to handle all ServerSocket connections and to handle incoming requests to an Execution Service for processing.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
boolean	containsServerFor(org.mule.runtime.http.api.server.ServerAddress serverAddress, ServerIdentifier identifier)
org.mule.runtime.http.api.server.HttpServer	createServerFor(org.mule.runtime.http.api.server.ServerAddress serverAddress, Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier, boolean usePersistentConnections, int connectionIdleTimeout, ServerIdentifier identifier, Supplier<Long> shutdownTimeout) Deprecated. as of 1.7.0, 1.6.1, 1.5.15 use createServerFor(ServerAddress, Supplier, boolean, int, ServerIdentifier, Supplier, long) instead.
org.mule.runtime.http.api.server.HttpServer	createServerFor(org.mule.runtime.http.api.server.ServerAddress serverAddress, Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier, boolean usePersistentConnections, int connectionIdleTimeout, ServerIdentifier identifier, Supplier<Long> shutdownTimeout, long readTimeout)
org.mule.runtime.http.api.server.HttpServer	createSslServerFor(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory, Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier, org.mule.runtime.http.api.server.ServerAddress serverAddress, boolean usePersistentConnections, int connectionIdleTimeout, ServerIdentifier identifier, Supplier<Long> shutdownTimeout) Deprecated. as of 1.7.0, 1.6.1, 1.5.15 use createSslServerFor(TlsContextFactory, Supplier, ServerAddress, boolean, int, ServerIdentifier, Supplier, long) instead.
org.mule.runtime.http.api.server.HttpServer	createSslServerFor(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory, Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier, org.mule.runtime.http.api.server.ServerAddress serverAddress, boolean usePersistentConnections, int connectionIdleTimeout, ServerIdentifier identifier, Supplier<Long> shutdownTimeout, long readTimeout)
void	dispose() Frees all the resource hold by the server manager.
org.mule.runtime.http.api.server.HttpServer	lookupServer(ServerIdentifier identifier)

Method Detail

containsServerFor

boolean containsServerFor(org.mule.runtime.http.api.server.ServerAddress serverAddress,
                          ServerIdentifier identifier)

Parameters:

serverAddress - address of the server

identifier - the id of the server

Returns:

true if there's already a server created for that port and either the same host or an overlapping one (0.0.0.0 or any other if the serverAddress host is 0.0.0.0), false otherwise.

createServerFor

@Deprecated
org.mule.runtime.http.api.server.HttpServer createServerFor(org.mule.runtime.http.api.server.ServerAddress serverAddress,
                                                                        Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier,
                                                                        boolean usePersistentConnections,
                                                                        int connectionIdleTimeout,
                                                                        ServerIdentifier identifier,
                                                                        Supplier<Long> shutdownTimeout)
                                                                 throws org.mule.runtime.http.api.server.ServerCreationException

Deprecated. as of 1.7.0, 1.6.1, 1.5.15 use createServerFor(ServerAddress, Supplier, boolean, int, ServerIdentifier, Supplier, long) instead.

Parameters:

serverAddress - address of the server

schedulerSupplier - work manager source to use for retrieving an Executor for processing this server requests

usePersistentConnections - if true, the connections will be kept open for subsequent requests

connectionIdleTimeout - the amount of milliseconds to keep open an idle connection @return the create Server handler

identifier - the id of the server

shutdownTimeout - time to wait for persistent connections to be closed when server is stopped.

Throws:

org.mule.runtime.http.api.server.ServerCreationException - if it was not possible to create the Server. Most likely because the host and port is already in use.

createServerFor

org.mule.runtime.http.api.server.HttpServer createServerFor(org.mule.runtime.http.api.server.ServerAddress serverAddress,
                                                            Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier,
                                                            boolean usePersistentConnections,
                                                            int connectionIdleTimeout,
                                                            ServerIdentifier identifier,
                                                            Supplier<Long> shutdownTimeout,
                                                            long readTimeout)
                                                     throws org.mule.runtime.http.api.server.ServerCreationException

Parameters:

serverAddress - address of the server

schedulerSupplier - work manager source to use for retrieving an Executor for processing this server requests

usePersistentConnections - if true, the connections will be kept open for subsequent requests

connectionIdleTimeout - the amount of milliseconds to keep open an idle connection @return the create Server handler

identifier - the id of the server

shutdownTimeout - time to wait for persistent connections to be closed when server is stopped.

readTimeout - time to wait while reading input in milliseconds

Throws:

org.mule.runtime.http.api.server.ServerCreationException - if it was not possible to create the Server. Most likely because the host and port is already in use.

Since:

1.7.0, 1.6.1, 1.5.15

createSslServerFor

@Deprecated
org.mule.runtime.http.api.server.HttpServer createSslServerFor(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory,
                                                                           Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier,
                                                                           org.mule.runtime.http.api.server.ServerAddress serverAddress,
                                                                           boolean usePersistentConnections,
                                                                           int connectionIdleTimeout,
                                                                           ServerIdentifier identifier,
                                                                           Supplier<Long> shutdownTimeout)
                                                                    throws org.mule.runtime.http.api.server.ServerCreationException

Deprecated. as of 1.7.0, 1.6.1, 1.5.15 use createSslServerFor(TlsContextFactory, Supplier, ServerAddress, boolean, int, ServerIdentifier, Supplier, long) instead.

Parameters:

tlsContextFactory -

schedulerSupplier - work manager source to use for retrieving an Executor for processing this server requests

serverAddress - address of the server

usePersistentConnections - if true, the connections will be kept open for subsequent requests

connectionIdleTimeout - the amount of milliseconds to keep open an idle connection

identifier - the id of the server

shutdownTimeout - time to wait for persistent connections to be closed when server is stopped.

Returns:

the create Server handler

Throws:

org.mule.runtime.http.api.server.ServerCreationException - if it was not possible to create the Server. Most likely because the host and port is already in use.

createSslServerFor

org.mule.runtime.http.api.server.HttpServer createSslServerFor(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory,
                                                               Supplier<org.mule.runtime.api.scheduler.Scheduler> schedulerSupplier,
                                                               org.mule.runtime.http.api.server.ServerAddress serverAddress,
                                                               boolean usePersistentConnections,
                                                               int connectionIdleTimeout,
                                                               ServerIdentifier identifier,
                                                               Supplier<Long> shutdownTimeout,
                                                               long readTimeout)
                                                        throws org.mule.runtime.http.api.server.ServerCreationException

Parameters:

tlsContextFactory -

schedulerSupplier - work manager source to use for retrieving an Executor for processing this server requests

serverAddress - address of the server

usePersistentConnections - if true, the connections will be kept open for subsequent requests

connectionIdleTimeout - the amount of milliseconds to keep open an idle connection

identifier - the id of the server

shutdownTimeout - time to wait for persistent connections to be closed when server is stopped.

readTimeout - time to wait while reading input in milliseconds

Returns:

the create Server handler

Throws:

org.mule.runtime.http.api.server.ServerCreationException - if it was not possible to create the Server. Most likely because the host and port is already in use.

Since:

1.7.0, 1.6.1, 1.5.15

lookupServer

org.mule.runtime.http.api.server.HttpServer lookupServer(ServerIdentifier identifier)
                                                  throws org.mule.runtime.http.api.server.ServerNotFoundException

Parameters:

identifier - the id of the server

Returns:

an Optional with the corresponding HttpServer or an empty one, if none was found

Throws:

org.mule.runtime.http.api.server.ServerNotFoundException - when the desired server was not found

dispose

void dispose()

Frees all the resource hold by the server manager. The client is responsible for stopping all the server prior to call dispose.