Class HTTPSServer

java.lang.Object

org.languagetool.server.HTTPSServer

public class HTTPSServer
extends Object

A small embedded HTTPS server that checks text. Works only with https, not with http.

Since:

2.0

See Also:

• HTTPServer

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Set<String>	DEFAULT_ALLOWED_IPS
protected String	host
protected org.languagetool.server.LanguageToolHttpHandler	httpHandler
protected int	port
protected com.sun.net.httpserver.HttpServer	server

Constructor Summary

Constructors

Constructor	Description
HTTPSServer(HTTPSServerConfig config, boolean runInternally, String host, Set<String> allowedIps)	Prepare a server on the given host and port - use run() to start it.

Method Summary

Modifier and Type	Method	Description
protected static void	checkForNonRootUser()
protected @Nullable org.languagetool.server.ErrorRequestLimiter	getErrorRequestLimiterOrNull(HTTPServerConfig config)
protected ThreadPoolExecutor	getExecutorService(LinkedBlockingQueue<Runnable> workQueue, HTTPServerConfig config)
protected String	getProtocol()
protected @Nullable org.languagetool.server.RequestLimiter	getRequestLimiterOrNull(HTTPServerConfig config)
boolean	isRunning()
static void	main(String[] args)
protected static void	printCommonConfigFileOptions()
protected static void	printCommonOptions()
void	run()	Start the server.
void	stop()	Stop the server.
protected static boolean	usageRequested(String[] args)

Methods inherited from class Object

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

Field Details

DEFAULT_ALLOWED_IPS

protected static final Set<String> DEFAULT_ALLOWED_IPS

port

protected int port

host

protected String host

server

protected com.sun.net.httpserver.HttpServer server

httpHandler

protected org.languagetool.server.LanguageToolHttpHandler httpHandler

Constructor Details

HTTPSServer

public HTTPSServer(HTTPSServerConfig config,
 boolean runInternally,
 String host,
 Set<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" or null to bind to any host

allowedIps - the IP addresses from which connections are allowed or null to allow any host

Throws:

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

Method Details

stop

public void stop()

Stop the server. Once stopped, a server cannot be used again.

main

public static void main(String[] args)

getProtocol

protected String getProtocol()

run

public void run()

Start the server.

isRunning

public boolean isRunning()

Returns:

whether the server is running

Since:

2.0

getRequestLimiterOrNull

@Nullable
protected @Nullable org.languagetool.server.RequestLimiter getRequestLimiterOrNull(HTTPServerConfig config)

getErrorRequestLimiterOrNull

@Nullable
protected @Nullable org.languagetool.server.ErrorRequestLimiter getErrorRequestLimiterOrNull(HTTPServerConfig config)

usageRequested

protected static boolean usageRequested(String[] args)

printCommonConfigFileOptions

protected static void printCommonConfigFileOptions()

printCommonOptions

protected static void printCommonOptions()

checkForNonRootUser

protected static void checkForNonRootUser()

getExecutorService

protected ThreadPoolExecutor getExecutorService(LinkedBlockingQueue<Runnable> workQueue,
 HTTPServerConfig config)