org.languagetool.server

Class HTTPServer

Object

HTTPServer

public class HTTPServer
extends Object

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.

Author:

Daniel Naber

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOST
static int	DEFAULT_PORT The default port on which the server is running (8081).

Constructor Summary

Constructors

Constructor and Description
HTTPServer() Prepare a server on the given port - use run() to start it.
HTTPServer(int port) Prepare a server on localhost on the given port - use run() to start it.
HTTPServer(int port, boolean verbose) Prepare a server on localhost on the given port - use run() to start it.
HTTPServer(int port, boolean verbose, Set<String> allowedIps) Prepare a server on localhost on the given port - use run() to start it.
HTTPServer(int port, boolean verbose, String host, Set<String> allowedIps) Prepare a server on the given host and port - use run() to start it.

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(String[] args)
void	run() Start the server.
void	stop() Stop the server.

Methods inherited from class Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port on which the server is running (8081).

See Also:

Constant Field Values

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(int port)

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(int port,
          boolean verbose)

Prepare a server on localhost on the given port - use run() to start it. Accepts connections from localhost only.

Parameters:

verbose - if true, the text to be checked will be displayed in case of exceptions

Throws:

PortBindingException - if we cannot bind to the given port, e.g. because something else is running there

HTTPServer

public HTTPServer(int port,
          boolean verbose,
          Set<String> allowedIps)

Prepare a server on localhost on the given port - use run() to start it. The server will bind to localhost.

Parameters:

verbose - if true, the text to be checked will be displayed in case of exceptions

allowedIps - the IP addresses from which connections are allowed

Throws:

PortBindingException - if we cannot bind to the given port, e.g. because something else is running there

HTTPServer

public HTTPServer(int port,
          boolean verbose,
          String host,
          Set<String> allowedIps)

Prepare a server on the given host and port - use run() to start it.

Parameters:

verbose - if true, the text to be checked will be displayed in case of exceptions

host - the host to bind to, e.g. "localhost" or InetAddress.anyLocalAddress()

allowedIps - the IP addresses from which connections are allowed

Throws:

PortBindingException - if we cannot bind to the given port, e.g. because something else is running there

Since:

1.7

Method Detail

run

public void run()

Start the server.

stop

public void stop()

Stop the server.

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException