public class SFSWordFilter extends com.smartfoxserver.v2.core.service.BaseCoreService implements IWordFilter
Constructor and Description |
---|
SFSWordFilter(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager) |
SFSWordFilter(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager,
java.lang.String wordsFile) |
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) |
getId, getName, handleMessage, isActive, setName, toString
public SFSWordFilter(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager)
public SFSWordFilter(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager, java.lang.String wordsFile)
public void init(java.lang.Object o)
com.smartfoxserver.bitswarm.service.IService
init
in interface com.smartfoxserver.bitswarm.service.IService
init
in class com.smartfoxserver.v2.core.service.BaseCoreService
o
- custom parameterspublic void setActive(boolean flag)
setActive
in interface IWordFilter
public void destroy(java.lang.Object o)
com.smartfoxserver.bitswarm.service.IService
destroy
in interface com.smartfoxserver.bitswarm.service.IService
destroy
in class com.smartfoxserver.v2.core.service.BaseCoreService
o
- custom parameterspublic com.smartfoxserver.v2.util.filters.FilteredMessage apply(java.lang.String message)
apply
in interface IWordFilter
message
- the messagepublic com.smartfoxserver.v2.util.filters.FilteredMessage apply(java.lang.String message, User user)
apply
in interface IWordFilter
public void addExpression(java.lang.String word)
addExpression
in interface IWordFilter
public void clearExpressions()
clearExpressions
in interface IWordFilter
public int getBanDurationMinutes()
getBanDurationMinutes
in interface IWordFilter
public BanMode getBanMode()
getBanMode
in interface IWordFilter
public com.smartfoxserver.v2.util.filters.WordsFilterMode getFilterMode()
getFilterMode
in interface IWordFilter
public int getWarningsBeforeKick()
getWarningsBeforeKick
in interface IWordFilter
public java.lang.String getWordsFile()
getWordsFile
in interface IWordFilter
public void setWordsFile(java.lang.String wordsFile)
setWordsFile
in interface IWordFilter
public java.util.Set<java.lang.String> getExpressionsList()
getExpressionsList
in interface IWordFilter
public int getKicksBeforeBan()
getKicksBeforeBan
in interface IWordFilter
public void removeExpression(java.lang.String word)
removeExpression
in interface IWordFilter
public void setBanDurationMinutes(int minutes)
setBanDurationMinutes
in interface IWordFilter
public void setBanMode(BanMode banMode)
setBanMode
in interface IWordFilter
public void setFilterMode(com.smartfoxserver.v2.util.filters.WordsFilterMode filterMode)
setFilterMode
in interface IWordFilter
public void setKicksBeforeBan(int kicks)
setKicksBeforeBan
in interface IWordFilter
public void setWarningsBeforeKick(int warnings)
setWarningsBeforeKick
in interface IWordFilter
public com.smartfoxserver.v2.entities.managers.IBannedUserManager getBannedUserManager()
getBannedUserManager
in interface IWordFilter
public void setBannedUserManager(com.smartfoxserver.v2.entities.managers.IBannedUserManager manager)
setBannedUserManager
in interface IWordFilter
public java.lang.String getMaskCharacter()
getMaskCharacter
in interface IWordFilter
public void setMaskCharacter(java.lang.String mask)
setMaskCharacter
in interface IWordFilter
public int getMaxBadWordsPerMessage()
getMaxBadWordsPerMessage
in interface IWordFilter
public void setMaxBadWordsPerMessage(int max)
setMaxBadWordsPerMessage
in interface IWordFilter
public int getKicksBeforeBanMinutes()
getKicksBeforeBanMinutes
in interface IWordFilter
public void setKicksBeforeBanMinutes(int kicksBeforeBanMinutes)
setKicksBeforeBanMinutes
in interface IWordFilter
public java.lang.String getKickMessage()
getKickMessage
in interface IWordFilter
public void setKickMessage(java.lang.String kickMessage)
setKickMessage
in interface IWordFilter
public java.lang.String getBanMessage()
getBanMessage
in interface IWordFilter
public void setBanMessage(java.lang.String banMessage)
setBanMessage
in interface IWordFilter
public com.smartfoxserver.v2.entities.managers.IBannedUserManager getBannedUserManger()
getBannedUserManger
in interface IWordFilter
public void setBannedUserManger(com.smartfoxserver.v2.entities.managers.IBannedUserManager bannedUserManger)
setBannedUserManger
in interface IWordFilter
public int getSecondsBeforeBanOrKick()
getSecondsBeforeBanOrKick
in interface IWordFilter
public void setSecondsBeforeBanOrKick(int secondsBeforeBanOrKick)
setSecondsBeforeBanOrKick
in interface IWordFilter
public java.lang.String getWarningMessage()
getWarningMessage
in interface IWordFilter
public void setWarningMessage(java.lang.String message)
setWarningMessage
in interface IWordFilter
public boolean isUseWarnings()
isUseWarnings
in interface IWordFilter
public void setUseWarnings(boolean value)
setUseWarnings
in interface IWordFilter
public void loadExpressionList()
loadExpressionList
in interface IWordFilter