Class LanguageToolHttpHandler

java.lang.Object

org.languagetool.server.LanguageToolHttpHandler

All Implemented Interfaces:

com.sun.net.httpserver.HttpHandler

class LanguageToolHttpHandler
extends Object
implements com.sun.net.httpserver.HttpHandler

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<String>	allowedIps
(package private) static final String	API_DOC_URL
private final HTTPServerConfig	config
private static final String	ENCODING
private final ErrorRequestLimiter	errorRequestLimiter
private static final org.slf4j.Logger	logger
private final RequestCounter	reqCounter
private final RequestLimiter	requestLimiter
private final TextChecker	textCheckerV2
private final LinkedBlockingQueue<Runnable>	workQueue

Constructor Summary

Constructors

Constructor	Description
LanguageToolHttpHandler(HTTPServerConfig config, Set<String> allowedIps, boolean internal, RequestLimiter requestLimiter, ErrorRequestLimiter errorLimiter, LinkedBlockingQueue<Runnable> workQueue)

Method Summary

Modifier and Type	Method	Description
private Map<String,String>	getParameterMap(String query, com.sun.net.httpserver.HttpExchange httpExchange)
private @Nullable String	getRealRemoteAddressOrNull(com.sun.net.httpserver.HttpExchange httpExchange)	A (reverse) proxy can set the 'X-forwarded-for' header so we can see a user's original IP.
private Map<String,String>	getRequestQuery(com.sun.net.httpserver.HttpExchange httpExchange, URI requestedUri)
private @NotNull String	getTextOrDataSizeMessage(Map<String,String> parameters)
void	handle(com.sun.net.httpserver.HttpExchange httpExchange)
private boolean	hasCause(Exception e, Class<AuthException> clazz)
private void	logError(String errorMessage, int code, Map<String,String> params, com.sun.net.httpserver.HttpExchange httpExchange)
private void	logError(String errorMessage, int code, Map<String,String> params, com.sun.net.httpserver.HttpExchange httpExchange, boolean logToDb)
private void	logError(String remoteAddress, Exception e, int errorCode, com.sun.net.httpserver.HttpExchange httpExchange, Map<String,String> params, boolean textLoggingAllowed, boolean logStacktrace, long runtimeMillis)
private void	logToDatabase(Map<String,String> params, String message)
private Map<String,String>	parseQuery(String query, com.sun.net.httpserver.HttpExchange httpExchange)
private String	readerToString(Reader reader, int maxTextLength)
private void	sendError(com.sun.net.httpserver.HttpExchange httpExchange, int httpReturnCode, String response)
(package private) void	shutdown()
private boolean	siteMatches(String referrer, String blockedRef)
private boolean	workQueueFull(com.sun.net.httpserver.HttpExchange httpExchange, Map<String,String> parameters, String response)

Methods inherited from class Object

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

Field Details

logger

private static final org.slf4j.Logger logger

API_DOC_URL

static final String API_DOC_URL

See Also:

• Constant Field Values

ENCODING

private static final String ENCODING

See Also:

• Constant Field Values

allowedIps

private final Set<String> allowedIps

requestLimiter

private final RequestLimiter requestLimiter

errorRequestLimiter

private final ErrorRequestLimiter errorRequestLimiter

workQueue

private final LinkedBlockingQueue<Runnable> workQueue

textCheckerV2

private final TextChecker textCheckerV2

config

private final HTTPServerConfig config

reqCounter

private final RequestCounter reqCounter

Constructor Details

LanguageToolHttpHandler

LanguageToolHttpHandler(HTTPServerConfig config,
 Set<String> allowedIps,
 boolean internal,
 RequestLimiter requestLimiter,
 ErrorRequestLimiter errorLimiter,
 LinkedBlockingQueue<Runnable> workQueue)

Method Details

shutdown

void shutdown()

Since:

2.6

handle

public void handle(com.sun.net.httpserver.HttpExchange httpExchange)
            throws IOException

Specified by:

handle in interface com.sun.net.httpserver.HttpHandler

Throws:

IOException

hasCause

private boolean hasCause(Exception e,
 Class<AuthException> clazz)

siteMatches

private boolean siteMatches(String referrer,
 String blockedRef)

workQueueFull

private boolean workQueueFull(com.sun.net.httpserver.HttpExchange httpExchange,
 Map<String,String> parameters,
 String response)
                       throws IOException

Throws:

IOException

getTextOrDataSizeMessage

@NotNull
private @NotNull String getTextOrDataSizeMessage(Map<String,String> parameters)

logError

private void logError(String errorMessage,
 int code,
 Map<String,String> params,
 com.sun.net.httpserver.HttpExchange httpExchange)

logError

private void logError(String errorMessage,
 int code,
 Map<String,String> params,
 com.sun.net.httpserver.HttpExchange httpExchange,
 boolean logToDb)

logError

private void logError(String remoteAddress,
 Exception e,
 int errorCode,
 com.sun.net.httpserver.HttpExchange httpExchange,
 Map<String,String> params,
 boolean textLoggingAllowed,
 boolean logStacktrace,
 long runtimeMillis)

logToDatabase

private void logToDatabase(Map<String,String> params,
 String message)

getRealRemoteAddressOrNull

@Nullable
private @Nullable String getRealRemoteAddressOrNull(com.sun.net.httpserver.HttpExchange httpExchange)

A (reverse) proxy can set the 'X-forwarded-for' header so we can see a user's original IP. But that's just a common header than can also be set by the client. So we restrict access to this server to the load balancer, which should add the header originally with the user's own IP.

sendError

private void sendError(com.sun.net.httpserver.HttpExchange httpExchange,
 int httpReturnCode,
 String response)
                throws IOException

Throws:

IOException

getRequestQuery

private Map<String,String> getRequestQuery(com.sun.net.httpserver.HttpExchange httpExchange,
 URI requestedUri)
                                    throws IOException

Throws:

IOException

readerToString

private String readerToString(Reader reader,
 int maxTextLength)
                       throws IOException

Throws:

IOException

parseQuery

private Map<String,String> parseQuery(String query,
 com.sun.net.httpserver.HttpExchange httpExchange)
                               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getParameterMap

private Map<String,String> getParameterMap(String query,
 com.sun.net.httpserver.HttpExchange httpExchange)
                                    throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException