Package org.languagetool.server

Class DatabaseAccessOpenSource

java.lang.Object

org.languagetool.server.DatabaseAccess

org.languagetool.server.DatabaseAccessOpenSource

class DatabaseAccessOpenSource
extends DatabaseAccess

Encapsulate database access. Will do nothing if database access is not configured.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
private final com.google.common.cache.Cache<String,Long>	dbLoggingCache
private static final org.slf4j.Logger	logger
private static final String	NON_PREMIUM_MSG
private static final Pattern	WHITESPACE_PATTERN

Fields inherited from class org.languagetool.server.DatabaseAccess

sqlSessionFactory

Constructor Summary

Constructors

Constructor	Description
DatabaseAccessOpenSource(HTTPServerConfig config)

Method Summary

Modifier and Type	Method	Description
(package private) boolean	addWord(String word, Long userId)
(package private) boolean	addWord(String word, Long userId, String groupName)
(package private) void	addWordBatch(List<String> words, Long userId, String groupName)	add words in sql batch mode, no auto commit for better performance with large lists also suppresses uniqueness checks
void	createAndFillTestTables(boolean mysql, List<String> skipStatements)	For unit tests only!
void	deleteTestTables()	For unit tests only!
(package private) boolean	deleteWord(String word, Long userId)
(package private) boolean	deleteWord(String word, Long userId, String groupName)
(package private) boolean	deleteWordBatch(List<String> words, Long userId, String groupName)	remove words in sql batch mode, no auto commit for better performance with large lists also suppresses uniqueness checks
(package private) List<DictGroupEntry>	getDictGroups(Long userId)	get all dictionary groups belonging to a user
(package private) ExtendedUserInfo	getExtendedUserInfo(long userId)	Get more general information on a user.
(package private) ExtendedUserInfo	getExtendedUserInfo(String user)	Get more general information on a user Expects access to already be authorized
(package private) Long	getOrCreateClientId(String client)
(package private) Long	getOrCreateDictGroup(Long userId, String groupName)	get or create a group with this name if it doesn't exist
(package private) Long	getOrCreateServerId()
List<Rule>	getRules(UserLimits limits, Language lang, List<String> groups)
(package private) Long	getUserId(String username, String apiKey)
(package private) UserInfoEntry	getUserInfoWithAddonToken(String username, String apiKey)
(package private) UserInfoEntry	getUserInfoWithApiKey(String username, String apiKey)
(package private) UserInfoEntry	getUserInfoWithPassword(String username, String password)
(package private) Long	getUserRequestCount(Long userId)
(package private) List<String>	getWords(Long userId, int offset, int limit)
List<String>	getWords(UserLimits limits, List<String> groups, int offset, int limit)
(package private) void	invalidateCaches()	For tests, to avoid waiting for the invalidation period.
(package private) void	invalidateUserInfoCache(String user)
private void	validateWord(String word)

Methods inherited from class org.languagetool.server.DatabaseAccess

createAndFillTestTables, createAndFillTestTables, execute, executeStatement, getInstance, init, isReady, reset, shutdownCompact

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

NON_PREMIUM_MSG

private static final String NON_PREMIUM_MSG

See Also:

• Constant Field Values

WHITESPACE_PATTERN

private static final Pattern WHITESPACE_PATTERN

dbLoggingCache

private final com.google.common.cache.Cache<String,Long> dbLoggingCache

Constructor Details

DatabaseAccessOpenSource

public DatabaseAccessOpenSource(HTTPServerConfig config)

Method Details

invalidateCaches

void invalidateCaches()

Description copied from class: DatabaseAccess

For tests, to avoid waiting for the invalidation period.

Specified by:

invalidateCaches in class DatabaseAccess

addWord

boolean addWord(String word,
 Long userId,
 String groupName)

Specified by:

addWord in class DatabaseAccess

deleteWord

boolean deleteWord(String word,
 Long userId,
 String groupName)

Specified by:

deleteWord in class DatabaseAccess

deleteWordBatch

boolean deleteWordBatch(List<String> words,
 Long userId,
 String groupName)

Description copied from class: DatabaseAccess

remove words in sql batch mode, no auto commit for better performance with large lists also suppresses uniqueness checks

Specified by:

deleteWordBatch in class DatabaseAccess

addWordBatch

void addWordBatch(List<String> words,
 Long userId,
 String groupName)

Description copied from class: DatabaseAccess

add words in sql batch mode, no auto commit for better performance with large lists also suppresses uniqueness checks

Specified by:

addWordBatch in class DatabaseAccess

getUserInfoWithPassword

UserInfoEntry getUserInfoWithPassword(String username,
 String password)

Specified by:

getUserInfoWithPassword in class DatabaseAccess

getExtendedUserInfo

ExtendedUserInfo getExtendedUserInfo(String user)

Description copied from class: DatabaseAccess

Get more general information on a user Expects access to already be authorized

Specified by:

getExtendedUserInfo in class DatabaseAccess

Parameters:

user - email address of user

Returns:

POJO with user information

getExtendedUserInfo

ExtendedUserInfo getExtendedUserInfo(long userId)

Description copied from class: DatabaseAccess

Get more general information on a user. Expects access to already be authorized.

Specified by:

getExtendedUserInfo in class DatabaseAccess

Parameters:

userId - user id

Returns:

POJO with more user information

getUserInfoWithApiKey

UserInfoEntry getUserInfoWithApiKey(String username,
 String apiKey)

Specified by:

getUserInfoWithApiKey in class DatabaseAccess

getUserInfoWithAddonToken

UserInfoEntry getUserInfoWithAddonToken(String username,
 String apiKey)

Specified by:

getUserInfoWithAddonToken in class DatabaseAccess

invalidateUserInfoCache

void invalidateUserInfoCache(String user)

Specified by:

invalidateUserInfoCache in class DatabaseAccess

getUserRequestCount

Long getUserRequestCount(Long userId)

Specified by:

getUserRequestCount in class DatabaseAccess

getWords

List<String> getWords(Long userId,
 int offset,
 int limit)

addWord

boolean addWord(String word,
 Long userId)

getUserId

Long getUserId(String username,
 String apiKey)

deleteWord

boolean deleteWord(String word,
 Long userId)

getOrCreateServerId

Long getOrCreateServerId()

Specified by:

getOrCreateServerId in class DatabaseAccess

Since:

4.3

getOrCreateClientId

Long getOrCreateClientId(String client)

Specified by:

getOrCreateClientId in class DatabaseAccess

Since:

4.3

getDictGroups

List<DictGroupEntry> getDictGroups(Long userId)

Description copied from class: DatabaseAccess

get all dictionary groups belonging to a user

Specified by:

getDictGroups in class DatabaseAccess

getOrCreateDictGroup

Long getOrCreateDictGroup(Long userId,
 String groupName)

Description copied from class: DatabaseAccess

get or create a group with this name if it doesn't exist

Specified by:

getOrCreateDictGroup in class DatabaseAccess

Returns:

id of the created/existing group

validateWord

private void validateWord(String word)

createAndFillTestTables

public void createAndFillTestTables(boolean mysql,
 List<String> skipStatements)

For unit tests only!

Specified by:

createAndFillTestTables in class DatabaseAccess

deleteTestTables

public void deleteTestTables()

For unit tests only!

Specified by:

deleteTestTables in class DatabaseAccess

getWords

public List<String> getWords(UserLimits limits,
 List<String> groups,
 int offset,
 int limit)

Specified by:

getWords in class DatabaseAccess

Parameters:

limits - user account and settings for e.g. caching

groups - names of dictionaries to be fetched, or null for default dictionary

offset - use offset with limit for an ordered list of words in the dictionary, or RowBounds.NO_ROW_OFFSET

limit - use limit with offset for an ordered list of words in the dictionary, or use RowBounds.NO_ROW_LIMIT

Returns:

a list of words from the user's dictionary (complete, or from the given range)

getRules

public List<Rule> getRules(UserLimits limits,
 Language lang,
 List<String> groups)

Specified by:

getRules in class DatabaseAccess

Parameters:

limits - user account and settings for e.g. caching

lang - language of rules to fetch; fetches global rules and language-specific rules for that language

groups - names of groups of rules to be fetched, or null for default set of rules

Returns:

a list of user rules (complete, or from the given range)