Package org.languagetool.server

Class PipelinePool

java.lang.Object

org.languagetool.server.PipelinePool

All Implemented Interfaces:

org.apache.commons.pool2.KeyedPooledObjectFactory<PipelineSettings,Pipeline>

class PipelinePool
extends Object
implements org.apache.commons.pool2.KeyedPooledObjectFactory<PipelineSettings,Pipeline>

Caches pre-configured JLanguageTool instances to avoid costly setup time of rules, etc.

Field Summary

Fields

Modifier and Type	Field	Description
private final ResultCache	cache
private final HTTPServerConfig	config
private final boolean	internalServer
private static final org.slf4j.Logger	logger
private final org.apache.commons.pool2.KeyedObjectPool<PipelineSettings,Pipeline>	pool

Constructor Summary

Constructors

Constructor	Description
PipelinePool(HTTPServerConfig config, ResultCache cache, boolean internalServer)

Method Summary

Modifier and Type	Method	Description
void	activateObject(PipelineSettings pipelineSettings, org.apache.commons.pool2.PooledObject<Pipeline> pooledObject)
private void	configureFromGUI(JLanguageTool lt, Language lang)
private void	configureFromRulesFile(JLanguageTool lt, Language lang)
(package private) Pipeline	createPipeline(Language lang, Language motherTongue, TextChecker.QueryParams params, GlobalConfig globalConfig, UserConfig userConfig, List<String> disabledRuleIds)	Create a JLanguageTool instance for a specific language, mother tongue, and rule configuration.
void	destroyObject(PipelineSettings pipelineSettings, org.apache.commons.pool2.PooledObject<Pipeline> pooledObject)
(package private) Pipeline	getPipeline(PipelineSettings settings)
org.apache.commons.pool2.PooledObject<Pipeline>	makeObject(PipelineSettings pipelineSettings)
void	passivateObject(PipelineSettings pipelineSettings, org.apache.commons.pool2.PooledObject<Pipeline> pooledObject)
(package private) void	returnPipeline(PipelineSettings settings, Pipeline pipeline)
boolean	validateObject(PipelineSettings pipelineSettings, org.apache.commons.pool2.PooledObject<Pipeline> pooledObject)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.pool2.KeyedPooledObjectFactory

destroyObject

Field Details

logger

private static final org.slf4j.Logger logger

pool

private final org.apache.commons.pool2.KeyedObjectPool<PipelineSettings,Pipeline> pool

config

private final HTTPServerConfig config

cache

private final ResultCache cache

internalServer

private final boolean internalServer

Constructor Details

PipelinePool

PipelinePool(HTTPServerConfig config,
 ResultCache cache,
 boolean internalServer)

Method Details

getPipeline

Pipeline getPipeline(PipelineSettings settings)
              throws Exception

Throws:

Exception

returnPipeline

void returnPipeline(PipelineSettings settings,
 Pipeline pipeline)
             throws Exception

Throws:

Exception

createPipeline

Pipeline createPipeline(Language lang,
 Language motherTongue,
 TextChecker.QueryParams params,
 GlobalConfig globalConfig,
 UserConfig userConfig,
 List<String> disabledRuleIds)
                 throws Exception

Create a JLanguageTool instance for a specific language, mother tongue, and rule configuration. Uses Pipeline wrapper to safely share objects

Parameters:

lang - the language to be used

motherTongue - the user's mother tongue or null

Throws:

Exception

configureFromRulesFile

private void configureFromRulesFile(JLanguageTool lt,
 Language lang)
                             throws IOException

Throws:

IOException

configureFromGUI

private void configureFromGUI(JLanguageTool lt,
 Language lang)
                       throws IOException

Throws:

IOException

makeObject

public org.apache.commons.pool2.PooledObject<Pipeline> makeObject(PipelineSettings pipelineSettings)
                                                           throws Exception

Specified by:

makeObject in interface org.apache.commons.pool2.KeyedPooledObjectFactory<PipelineSettings,Pipeline>

Throws:

Exception

destroyObject

public void destroyObject(PipelineSettings pipelineSettings,
 org.apache.commons.pool2.PooledObject<Pipeline> pooledObject)
                   throws Exception

Specified by:

destroyObject in interface org.apache.commons.pool2.KeyedPooledObjectFactory<PipelineSettings,Pipeline>

Throws:

Exception

validateObject

public boolean validateObject(PipelineSettings pipelineSettings,
 org.apache.commons.pool2.PooledObject<Pipeline> pooledObject)

Specified by:

validateObject in interface org.apache.commons.pool2.KeyedPooledObjectFactory<PipelineSettings,Pipeline>

activateObject

public void activateObject(PipelineSettings pipelineSettings,
 org.apache.commons.pool2.PooledObject<Pipeline> pooledObject)
                    throws Exception

Specified by:

activateObject in interface org.apache.commons.pool2.KeyedPooledObjectFactory<PipelineSettings,Pipeline>

Throws:

Exception

passivateObject

public void passivateObject(PipelineSettings pipelineSettings,
 org.apache.commons.pool2.PooledObject<Pipeline> pooledObject)
                     throws Exception

Specified by:

passivateObject in interface org.apache.commons.pool2.KeyedPooledObjectFactory<PipelineSettings,Pipeline>

Throws:

Exception