Package org.languagetool.server

Class LanguageToolHttpHandler

java.lang.Object

org.languagetool.server.LanguageToolHttpHandler

All Implemented Interfaces:

HttpHandler

class LanguageToolHttpHandler
extends Object
implements 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 final Server	httpServer
private static final org.slf4j.Logger	logger
private final RequestCounter	reqCounter
(package private) static final String	REQUEST_LIMIT_ACCESS_TOKEN_HEADER
private final RequestLimiter	requestLimiter
private final TextChecker	textCheckerV2
private final BlockingQueue<Runnable>	workQueue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private boolean	allowSkipRequestLimit(Headers requestHeaders)
private Map<String,String>	getParameterMap(String query, HttpExchange httpExchange)
(package private) static String	getRealRemoteAddressOrNull(HttpExchange httpExchange, HTTPServerConfig config)	A (reverse) proxy can set the 'X-forwarded-for' header so we can see a user's original IP.
(package private) static String	getRequestId(HttpExchange httpExchange)
private Map<String,String>	getRequestQuery(HttpExchange httpExchange, URI requestedUri)
private String	getTextOrDataSizeMessage(Map<String,String> parameters)
void	handle(HttpExchange httpExchange)
private boolean	hasCause(Exception e, Class<AuthException> clazz)
private boolean	limitPath(String path)	whitelist paths from request limiting
private void	logError(String errorMessage, int code, Map<String,String> params, HttpExchange httpExchange)
private void	logError(String errorMessage, int code, Map<String,String> params, HttpExchange httpExchange, boolean logToDb)
private void	logError(String remoteAddress, Exception e, int errorCode, HttpExchange httpExchange, Map<String,String> params, boolean textLoggingAllowed, boolean logStacktrace, long runtimeMillis)
private Map<String,String>	parseQuery(String query, HttpExchange httpExchange)
private String	readerToString(Reader reader, int maxTextLength)
private void	sendError(HttpExchange httpExchange, int httpReturnCode, String response)
(package private) void	shutdown()
private boolean	textCheckerQueueFull(HttpExchange httpExchange, String response)
private boolean	workQueueFull(HttpExchange httpExchange, Map<String,String> parameters, String response)

Methods inherited from class java.lang.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

REQUEST_LIMIT_ACCESS_TOKEN_HEADER

static final String REQUEST_LIMIT_ACCESS_TOKEN_HEADER

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 BlockingQueue<Runnable> workQueue

httpServer

private final Server httpServer

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,
 BlockingQueue<Runnable> workQueue,
 Server httpServer)

Method Details

shutdown

void shutdown()

Since:

2.6

handle

public void handle(HttpExchange httpExchange)
            throws IOException

Specified by:

handle in interface HttpHandler

Throws:

IOException

allowSkipRequestLimit

private boolean allowSkipRequestLimit(Headers requestHeaders)

limitPath

private boolean limitPath(String path)

whitelist paths from request limiting

getRequestId

@NotNull
static String getRequestId(HttpExchange httpExchange)

hasCause

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

workQueueFull

private boolean workQueueFull(HttpExchange httpExchange,
 Map<String,String> parameters,
 String response)
                       throws IOException

Throws:

IOException

textCheckerQueueFull

private boolean textCheckerQueueFull(HttpExchange httpExchange,
 String response)
                              throws IOException

Throws:

IOException

getTextOrDataSizeMessage

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

logError

private void logError(String errorMessage,
 int code,
 Map<String,String> params,
 HttpExchange httpExchange)

logError

private void logError(String errorMessage,
 int code,
 Map<String,String> params,
 HttpExchange httpExchange,
 boolean logToDb)

logError

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

getRealRemoteAddressOrNull

@Nullable
static String getRealRemoteAddressOrNull(HttpExchange httpExchange,
 HTTPServerConfig config)

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(HttpExchange httpExchange,
 int httpReturnCode,
 String response)
                throws IOException

Throws:

IOException

getRequestQuery

private Map<String,String> getRequestQuery(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,
 HttpExchange httpExchange)
                               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getParameterMap

private Map<String,String> getParameterMap(String query,
 HttpExchange httpExchange)
                                    throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException