Package org.languagetool.server
Class HTTPServer
- java.lang.Object
-
- org.languagetool.server.Server
-
- org.languagetool.server.HTTPServer
-
public class HTTPServer extends Server
A small embedded HTTP server that checks text. Returns XML, prints debugging to stdout/stderr. Note that by default the server only accepts connections from localhost for security reasons.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.languagetool.server.Server
Server.StoppingThreadPoolExecutor
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.concurrent.ExecutorService
executorService
-
Fields inherited from class org.languagetool.server.Server
DEFAULT_ALLOWED_IPS, host, httpHandler, port, server
-
-
Constructor Summary
Constructors Constructor Description HTTPServer()
Prepare a server on the given port - use run() to start it.HTTPServer(HTTPServerConfig config)
Prepare a server on localhost on the given port - use run() to start it.HTTPServer(HTTPServerConfig config, boolean runInternally)
Prepare a server on localhost on the given port - use run() to start it.HTTPServer(HTTPServerConfig config, boolean runInternally, java.lang.String host, java.util.Set<java.lang.String> allowedIps)
Prepare a server on the given host and port - use run() to start it.HTTPServer(HTTPServerConfig config, boolean runInternally, java.util.Set<java.lang.String> allowedIps)
Prepare a server on localhost on the given port - use run() to start it.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getProtocol()
static void
main(java.lang.String[] args)
void
stop()
Stop the server.-
Methods inherited from class org.languagetool.server.Server
checkForNonRootUser, getErrorRequestLimiterOrNull, getExecutorService, getRequestLimiterOrNull, isRunning, printCommonConfigFileOptions, printCommonOptions, run, usageRequested
-
-
-
-
Constructor Detail
-
HTTPServer
public HTTPServer()
Prepare a server on the given port - use run() to start it. Accepts connections from localhost only.
-
HTTPServer
public HTTPServer(HTTPServerConfig config)
Prepare a server on localhost on the given port - use run() to start it. Accepts connections from localhost only.- Throws:
PortBindingException
- if we cannot bind to the given port, e.g. because something else is running there
-
HTTPServer
public HTTPServer(HTTPServerConfig config, boolean runInternally)
Prepare a server on localhost on the given port - use run() to start it. Accepts connections from localhost only.- Parameters:
runInternally
- if true, then the server was started from the GUI.- Throws:
PortBindingException
- if we cannot bind to the given port, e.g. because something else is running there
-
HTTPServer
public HTTPServer(HTTPServerConfig config, boolean runInternally, java.util.Set<java.lang.String> allowedIps)
Prepare a server on localhost on the given port - use run() to start it. The server will bind to localhost.- Parameters:
runInternally
- if true, then the server was started from the GUI.allowedIps
- the IP addresses from which connections are allowed ornull
to allow any host- Throws:
PortBindingException
- if we cannot bind to the given port, e.g. because something else is running there
-
HTTPServer
public HTTPServer(HTTPServerConfig config, boolean runInternally, java.lang.String host, java.util.Set<java.lang.String> allowedIps)
Prepare a server on the given host and port - use run() to start it.- Parameters:
runInternally
- if true, then the server was started from the GUI.host
- the host to bind to, e.g."localhost"
ornull
to bind to any hostallowedIps
- the IP addresses from which connections are allowed ornull
to allow any host- Throws:
PortBindingException
- if we cannot bind to the given port, e.g. because something else is running there- Since:
- 1.7
-
-
Method Detail
-
stop
public void stop()
Description copied from class:Server
Stop the server. Once stopped, a server cannot be used again.
-
main
public static void main(java.lang.String[] args)
-
getProtocol
protected java.lang.String getProtocol()
- Specified by:
getProtocol
in classServer
-
-