com.smartfoxserver.v2.util

Class SFSWordFilter

java.lang.Object

com.smartfoxserver.v2.core.service.BaseCoreService

com.smartfoxserver.v2.util.SFSWordFilter

All Implemented Interfaces:

com.smartfoxserver.bitswarm.service.IService, com.smartfoxserver.v2.core.ICoreService, IWordFilter

public class SFSWordFilter
extends com.smartfoxserver.v2.core.service.BaseCoreService
implements IWordFilter

Field Summary

Fields inherited from class com.smartfoxserver.v2.core.service.BaseCoreService

active, name

Constructor Summary

Constructors

Constructor and Description
SFSWordFilter(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager)
SFSWordFilter(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager, java.lang.String wordsFile)

Method Summary

Modifier and Type	Method and Description
void	addExpression(java.lang.String word) Add a new regular expression to match unwanted words for the BLACK_LIST mode
com.smartfoxserver.v2.util.filters.FilteredMessage	apply(java.lang.String message) Applies the filter to a generic string
com.smartfoxserver.v2.util.filters.FilteredMessage	apply(java.lang.String message, User user) Applies the filter to a message/string of a User.
void	clearExpressions() Clears all expressions
void	destroy(java.lang.Object o) Destroy service
int	getBanDurationMinutes()
java.lang.String	getBanMessage()
BanMode	getBanMode()
com.smartfoxserver.v2.entities.managers.IBannedUserManager	getBannedUserManager()
com.smartfoxserver.v2.entities.managers.IBannedUserManager	getBannedUserManger()
java.util.Set<java.lang.String>	getExpressionsList()
com.smartfoxserver.v2.util.filters.WordsFilterMode	getFilterMode()
java.lang.String	getKickMessage()
int	getKicksBeforeBan()
int	getKicksBeforeBanMinutes()
java.lang.String	getMaskCharacter()
int	getMaxBadWordsPerMessage()
int	getSecondsBeforeBanOrKick()
java.lang.String	getWarningMessage()
int	getWarningsBeforeKick()
java.lang.String	getWordsFile()
void	init(java.lang.Object o) Initialize service
boolean	isUseWarnings()
void	loadExpressionList()
void	removeExpression(java.lang.String word)
void	setActive(boolean flag)
void	setBanDurationMinutes(int minutes)
void	setBanMessage(java.lang.String banMessage)
void	setBanMode(BanMode banMode)
void	setBannedUserManager(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager)
void	setBannedUserManger(com.smartfoxserver.v2.entities.managers.IBannedUserManager bannedUserManger)
void	setFilterMode(com.smartfoxserver.v2.util.filters.WordsFilterMode filterMode)
void	setKickMessage(java.lang.String kickMessage)
void	setKicksBeforeBan(int kicks)
void	setKicksBeforeBanMinutes(int kicksBeforeBanMinutes)
void	setMaskCharacter(java.lang.String mask)
void	setMaxBadWordsPerMessage(int max)
void	setSecondsBeforeBanOrKick(int secondsBeforeBanOrKick)
void	setUseWarnings(boolean value)
void	setWarningMessage(java.lang.String message)
void	setWarningsBeforeKick(int warnings)
void	setWordsFile(java.lang.String wordsFile)

Methods inherited from class com.smartfoxserver.v2.core.service.BaseCoreService

getId, getName, handleMessage, isActive, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.smartfoxserver.v2.core.ICoreService

isActive

Methods inherited from interface com.smartfoxserver.bitswarm.service.IService

getName, handleMessage, setName

Constructor Detail

SFSWordFilter

public SFSWordFilter(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager)

SFSWordFilter

public SFSWordFilter(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager,
                     java.lang.String wordsFile)

Method Detail

init

public void init(java.lang.Object o)

Description copied from interface: com.smartfoxserver.bitswarm.service.IService

Initialize service

Specified by:

init in interface com.smartfoxserver.bitswarm.service.IService

Overrides:

init in class com.smartfoxserver.v2.core.service.BaseCoreService

Parameters:

o - custom parameters

setActive

public void setActive(boolean flag)

Specified by:

setActive in interface IWordFilter

destroy

public void destroy(java.lang.Object o)

Description copied from interface: com.smartfoxserver.bitswarm.service.IService

Destroy service

Specified by:

destroy in interface com.smartfoxserver.bitswarm.service.IService

Overrides:

destroy in class com.smartfoxserver.v2.core.service.BaseCoreService

Parameters:

o - custom parameters

apply

public com.smartfoxserver.v2.util.filters.FilteredMessage apply(java.lang.String message)

Applies the filter to a generic string

Specified by:

apply in interface IWordFilter

Parameters:

message - the message

Returns:

the filtered message

apply

public com.smartfoxserver.v2.util.filters.FilteredMessage apply(java.lang.String message,
                                                                User user)

Applies the filter to a message/string of a User. This means that the user will be warned or even immediately kicked according to the filter rules

Specified by:

apply in interface IWordFilter

addExpression

public void addExpression(java.lang.String word)

Add a new regular expression to match unwanted words for the BLACK_LIST mode

Specified by:

addExpression in interface IWordFilter

clearExpressions

public void clearExpressions()

Clears all expressions

Specified by:

clearExpressions in interface IWordFilter

getBanDurationMinutes

public int getBanDurationMinutes()

Specified by:

getBanDurationMinutes in interface IWordFilter

getBanMode

public BanMode getBanMode()

Specified by:

getBanMode in interface IWordFilter

getFilterMode

public com.smartfoxserver.v2.util.filters.WordsFilterMode getFilterMode()

Specified by:

getFilterMode in interface IWordFilter

getWarningsBeforeKick

public int getWarningsBeforeKick()

Specified by:

getWarningsBeforeKick in interface IWordFilter

getWordsFile

public java.lang.String getWordsFile()

Specified by:

getWordsFile in interface IWordFilter

setWordsFile

public void setWordsFile(java.lang.String wordsFile)

Specified by:

setWordsFile in interface IWordFilter

getExpressionsList

public java.util.Set<java.lang.String> getExpressionsList()

Specified by:

getExpressionsList in interface IWordFilter

getKicksBeforeBan

public int getKicksBeforeBan()

Specified by:

getKicksBeforeBan in interface IWordFilter

removeExpression

public void removeExpression(java.lang.String word)

Specified by:

removeExpression in interface IWordFilter

setBanDurationMinutes

public void setBanDurationMinutes(int minutes)

Specified by:

setBanDurationMinutes in interface IWordFilter

setBanMode

public void setBanMode(BanMode banMode)

Specified by:

setBanMode in interface IWordFilter

setFilterMode

public void setFilterMode(com.smartfoxserver.v2.util.filters.WordsFilterMode filterMode)

Specified by:

setFilterMode in interface IWordFilter

setKicksBeforeBan

public void setKicksBeforeBan(int kicks)

Specified by:

setKicksBeforeBan in interface IWordFilter

setWarningsBeforeKick

public void setWarningsBeforeKick(int warnings)

Specified by:

setWarningsBeforeKick in interface IWordFilter

getBannedUserManager

public com.smartfoxserver.v2.entities.managers.IBannedUserManager getBannedUserManager()

Specified by:

getBannedUserManager in interface IWordFilter

setBannedUserManager

public void setBannedUserManager(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager)

Specified by:

setBannedUserManager in interface IWordFilter

getMaskCharacter

public java.lang.String getMaskCharacter()

Specified by:

getMaskCharacter in interface IWordFilter

setMaskCharacter

public void setMaskCharacter(java.lang.String mask)

Specified by:

setMaskCharacter in interface IWordFilter

getMaxBadWordsPerMessage

public int getMaxBadWordsPerMessage()

Specified by:

getMaxBadWordsPerMessage in interface IWordFilter

setMaxBadWordsPerMessage

public void setMaxBadWordsPerMessage(int max)

Specified by:

setMaxBadWordsPerMessage in interface IWordFilter

getKicksBeforeBanMinutes

public int getKicksBeforeBanMinutes()

Specified by:

getKicksBeforeBanMinutes in interface IWordFilter

setKicksBeforeBanMinutes

public void setKicksBeforeBanMinutes(int kicksBeforeBanMinutes)

Specified by:

setKicksBeforeBanMinutes in interface IWordFilter

getKickMessage

public java.lang.String getKickMessage()

Specified by:

getKickMessage in interface IWordFilter

setKickMessage

public void setKickMessage(java.lang.String kickMessage)

Specified by:

setKickMessage in interface IWordFilter

getBanMessage

public java.lang.String getBanMessage()

Specified by:

getBanMessage in interface IWordFilter

setBanMessage

public void setBanMessage(java.lang.String banMessage)

Specified by:

setBanMessage in interface IWordFilter

getBannedUserManger

public com.smartfoxserver.v2.entities.managers.IBannedUserManager getBannedUserManger()

Specified by:

getBannedUserManger in interface IWordFilter

setBannedUserManger

public void setBannedUserManger(com.smartfoxserver.v2.entities.managers.IBannedUserManager bannedUserManger)

Specified by:

setBannedUserManger in interface IWordFilter

getSecondsBeforeBanOrKick

public int getSecondsBeforeBanOrKick()

Specified by:

getSecondsBeforeBanOrKick in interface IWordFilter

setSecondsBeforeBanOrKick

public void setSecondsBeforeBanOrKick(int secondsBeforeBanOrKick)

Specified by:

setSecondsBeforeBanOrKick in interface IWordFilter

getWarningMessage

public java.lang.String getWarningMessage()

Specified by:

getWarningMessage in interface IWordFilter

setWarningMessage

public void setWarningMessage(java.lang.String message)

Specified by:

setWarningMessage in interface IWordFilter

isUseWarnings

public boolean isUseWarnings()

Specified by:

isUseWarnings in interface IWordFilter

setUseWarnings

public void setUseWarnings(boolean value)

Specified by:

setUseWarnings in interface IWordFilter

loadExpressionList

public void loadExpressionList()

Specified by:

loadExpressionList in interface IWordFilter