Package org.languagetool.server

Class ApiV2

java.lang.Object

org.languagetool.server.ApiV2

class ApiV2
extends Object

Handle requests to /v2/ of the HTTP API.

Since:

3.4

Field Summary

Fields

Modifier and Type	Field	Description
private final String	allowOriginUrl
private static final String	ENCODING
private final com.fasterxml.jackson.core.JsonFactory	factory
private static final String	JSON_CONTENT_TYPE
private static final org.slf4j.Logger	logger
private static final String	TEXT_CONTENT_TYPE
private final TextChecker	textChecker

Constructor Summary

Constructors

Constructor	Description
ApiV2(TextChecker textChecker, String allowOriginUrl)

Method Summary

Modifier and Type	Method	Description
private void	ensureGetMethod(HttpExchange httpExchange, String url)
private void	ensurePostMethod(HttpExchange httpExchange, String url)
private AnnotatedText	getAnnotatedTextFromJson(com.fasterxml.jackson.databind.JsonNode data)
private AnnotatedText	getAnnotatedTextFromString(com.fasterxml.jackson.databind.JsonNode data, String text)
(package private) String	getConfigurationInfo(Language lang, HTTPServerConfig config)
(package private) String	getLanguages()
(package private) String	getSoftwareInfo()
private UserLimits	getUserLimits(Map<String,String> parameters, HTTPServerConfig config)
private void	handleCheckRequest(HttpExchange httpExchange, Map<String,String> parameters, ErrorRequestLimiter errorRequestLimiter, String remoteAddress, HTTPServerConfig config)
private void	handleGetConfigurationInfoRequest(HttpExchange httpExchange, Map<String,String> parameters, HTTPServerConfig config)
private void	handleGetUserInfoRequest(HttpExchange httpExchange, Map<String,String> parameters, HTTPServerConfig config)
private void	handleIpLogMatch(HttpExchange httpExchange, String remoteAddress, Map<String,String> parameters)
private void	handleLanguagesRequest(HttpExchange httpExchange)
private void	handleMaxTextLengthRequest(HttpExchange httpExchange, HTTPServerConfig config)
private void	handleRefreshUserInfoRequest(HttpExchange httpExchange, Map<String,String> params, HTTPServerConfig config)
(package private) void	handleRequest(String path, HttpExchange httpExchange, Map<String,String> parameters, ErrorRequestLimiter errorRequestLimiter, String remoteAddress, HTTPServerConfig config)
private void	handleRuleExamplesRequest(HttpExchange httpExchange, Map<String,String> params)
private void	handleSoftwareInfoRequest(HttpExchange httpExchange)
private void	handleWordAddRequest(HttpExchange httpExchange, Map<String,String> parameters, HTTPServerConfig config)
private void	handleWordDeleteRequest(HttpExchange httpExchange, Map<String,String> parameters, HTTPServerConfig config)
private void	handleWordsRequest(HttpExchange httpExchange, Map<String,String> params, HTTPServerConfig config)
private void	sendJson(HttpExchange httpExchange, StringWriter sw)
private void	writeListResponse(String fieldName, List<String> words, HttpExchange httpExchange)
private void	writeResponse(String fieldName, boolean added, HttpExchange httpExchange)

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

JSON_CONTENT_TYPE

private static final String JSON_CONTENT_TYPE

See Also:

• Constant Field Values

TEXT_CONTENT_TYPE

private static final String TEXT_CONTENT_TYPE

See Also:

• Constant Field Values

ENCODING

private static final String ENCODING

See Also:

• Constant Field Values

textChecker

private final TextChecker textChecker

allowOriginUrl

private final String allowOriginUrl

factory

private final com.fasterxml.jackson.core.JsonFactory factory

Constructor Details

ApiV2

ApiV2(TextChecker textChecker,
 String allowOriginUrl)

Method Details

handleRequest

void handleRequest(String path,
 HttpExchange httpExchange,
 Map<String,String> parameters,
 ErrorRequestLimiter errorRequestLimiter,
 String remoteAddress,
 HTTPServerConfig config)
            throws Exception

Throws:

Exception

handleLanguagesRequest

private void handleLanguagesRequest(HttpExchange httpExchange)
                             throws IOException

Throws:

IOException

handleMaxTextLengthRequest

private void handleMaxTextLengthRequest(HttpExchange httpExchange,
 HTTPServerConfig config)
                                 throws IOException

Throws:

IOException

handleGetConfigurationInfoRequest

private void handleGetConfigurationInfoRequest(HttpExchange httpExchange,
 Map<String,String> parameters,
 HTTPServerConfig config)
                                        throws IOException

Throws:

IOException

handleSoftwareInfoRequest

private void handleSoftwareInfoRequest(HttpExchange httpExchange)
                                throws IOException

Throws:

IOException

handleCheckRequest

private void handleCheckRequest(HttpExchange httpExchange,
 Map<String,String> parameters,
 ErrorRequestLimiter errorRequestLimiter,
 String remoteAddress,
 HTTPServerConfig config)
                         throws Exception

Throws:

Exception

handleIpLogMatch

private void handleIpLogMatch(HttpExchange httpExchange,
 String remoteAddress,
 Map<String,String> parameters)

handleWordsRequest

private void handleWordsRequest(HttpExchange httpExchange,
 Map<String,String> params,
 HTTPServerConfig config)
                         throws Exception

Throws:

Exception

handleWordAddRequest

private void handleWordAddRequest(HttpExchange httpExchange,
 Map<String,String> parameters,
 HTTPServerConfig config)
                           throws Exception

Throws:

Exception

handleWordDeleteRequest

private void handleWordDeleteRequest(HttpExchange httpExchange,
 Map<String,String> parameters,
 HTTPServerConfig config)
                              throws Exception

Throws:

Exception

handleRuleExamplesRequest

private void handleRuleExamplesRequest(HttpExchange httpExchange,
 Map<String,String> params)
                                throws Exception

Throws:

Exception

handleRefreshUserInfoRequest

private void handleRefreshUserInfoRequest(HttpExchange httpExchange,
 Map<String,String> params,
 HTTPServerConfig config)
                                   throws Exception

Throws:

Exception

handleGetUserInfoRequest

private void handleGetUserInfoRequest(HttpExchange httpExchange,
 Map<String,String> parameters,
 HTTPServerConfig config)
                               throws Exception

Throws:

Exception

ensureGetMethod

private void ensureGetMethod(HttpExchange httpExchange,
 String url)

ensurePostMethod

private void ensurePostMethod(HttpExchange httpExchange,
 String url)

getUserLimits

@NotNull
private UserLimits getUserLimits(Map<String,String> parameters,
 HTTPServerConfig config)

writeResponse

private void writeResponse(String fieldName,
 boolean added,
 HttpExchange httpExchange)
                    throws IOException

Throws:

IOException

writeListResponse

private void writeListResponse(String fieldName,
 List<String> words,
 HttpExchange httpExchange)
                        throws IOException

Throws:

IOException

sendJson

private void sendJson(HttpExchange httpExchange,
 StringWriter sw)
               throws IOException

Throws:

IOException

getAnnotatedTextFromString

private AnnotatedText getAnnotatedTextFromString(com.fasterxml.jackson.databind.JsonNode data,
 String text)

getAnnotatedTextFromJson

private AnnotatedText getAnnotatedTextFromJson(com.fasterxml.jackson.databind.JsonNode data)

getLanguages

String getLanguages()
             throws IOException

Throws:

IOException

getSoftwareInfo

String getSoftwareInfo()
                throws IOException

Throws:

IOException

getConfigurationInfo

String getConfigurationInfo(Language lang,
 HTTPServerConfig config)
                     throws IOException

Throws:

IOException