Package com.smartfoxserver.util

Class SFSWordFilter

java.lang.Object
com.smartfoxserver.core.service.BaseCoreService
com.smartfoxserver.util.SFSWordFilter
All Implemented Interfaces:
com.smartfoxserver.bitswarm.service.IService, com.smartfoxserver.core.ICoreService, com.smartfoxserver.util.IWordFilter
public class SFSWordFilter extends com.smartfoxserver.core.service.BaseCoreService implements com.smartfoxserver.util.IWordFilter

  • Constructor Details

    • SFSWordFilter

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

    • SFSWordFilter

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

  • Method Details

    • init

      public void init(Object o)
      Specified by:
      init in interface com.smartfoxserver.bitswarm.service.IService
      Overrides:
      init in class com.smartfoxserver.core.service.BaseCoreService

    • setActive

      public void setActive(boolean flag)
      Specified by:
      setActive in interface com.smartfoxserver.util.IWordFilter

    • destroy

      public void destroy(Object o)
      Specified by:
      destroy in interface com.smartfoxserver.bitswarm.service.IService
      Overrides:
      destroy in class com.smartfoxserver.core.service.BaseCoreService

    • apply

      public com.smartfoxserver.util.filters.FilteredMessage apply(String message)
      Applies the filter to a generic string
      Specified by:
      apply in interface com.smartfoxserver.util.IWordFilter
      Parameters:
      message - the message
      Returns:
      the filtered message

    • apply

      public com.smartfoxserver.util.filters.FilteredMessage apply(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 com.smartfoxserver.util.IWordFilter

    • addExpression

      public void addExpression(String word)
      Add a new regular expression to match unwanted words for the BLACK_LIST mode
      Specified by:
      addExpression in interface com.smartfoxserver.util.IWordFilter

    • clearExpressions

      public void clearExpressions()
      Clears all expressions
      Specified by:
      clearExpressions in interface com.smartfoxserver.util.IWordFilter

    • getBanDurationMinutes

      public int getBanDurationMinutes()
      Specified by:
      getBanDurationMinutes in interface com.smartfoxserver.util.IWordFilter

    • getBanMode

      public BanMode getBanMode()
      Specified by:
      getBanMode in interface com.smartfoxserver.util.IWordFilter

    • getFilterMode

      public com.smartfoxserver.util.filters.WordsFilterMode getFilterMode()
      Specified by:
      getFilterMode in interface com.smartfoxserver.util.IWordFilter

    • getWarningsBeforeKick

      public int getWarningsBeforeKick()
      Specified by:
      getWarningsBeforeKick in interface com.smartfoxserver.util.IWordFilter

    • getWordsFile

      public String getWordsFile()
      Specified by:
      getWordsFile in interface com.smartfoxserver.util.IWordFilter

    • setWordsFile

      public void setWordsFile(String wordsFile)
      Specified by:
      setWordsFile in interface com.smartfoxserver.util.IWordFilter

    • getExpressionsList

      public Set<String> getExpressionsList()
      Specified by:
      getExpressionsList in interface com.smartfoxserver.util.IWordFilter

    • getKicksBeforeBan

      public int getKicksBeforeBan()
      Specified by:
      getKicksBeforeBan in interface com.smartfoxserver.util.IWordFilter

    • removeExpression

      public void removeExpression(String word)
      Specified by:
      removeExpression in interface com.smartfoxserver.util.IWordFilter

    • setBanDurationMinutes

      public void setBanDurationMinutes(int minutes)
      Specified by:
      setBanDurationMinutes in interface com.smartfoxserver.util.IWordFilter

    • setBanMode

      public void setBanMode(BanMode banMode)
      Specified by:
      setBanMode in interface com.smartfoxserver.util.IWordFilter

    • setFilterMode

      public void setFilterMode(com.smartfoxserver.util.filters.WordsFilterMode filterMode)
      Specified by:
      setFilterMode in interface com.smartfoxserver.util.IWordFilter

    • setKicksBeforeBan

      public void setKicksBeforeBan(int kicks)
      Specified by:
      setKicksBeforeBan in interface com.smartfoxserver.util.IWordFilter

    • setWarningsBeforeKick

      public void setWarningsBeforeKick(int warnings)
      Specified by:
      setWarningsBeforeKick in interface com.smartfoxserver.util.IWordFilter

    • getBannedUserManager

      public com.smartfoxserver.entities.managers.IBannedUserManager getBannedUserManager()
      Specified by:
      getBannedUserManager in interface com.smartfoxserver.util.IWordFilter

    • setBannedUserManager

      public void setBannedUserManager(com.smartfoxserver.entities.managers.IBannedUserManager manager)
      Specified by:
      setBannedUserManager in interface com.smartfoxserver.util.IWordFilter

    • getMaskCharacter

      public String getMaskCharacter()
      Specified by:
      getMaskCharacter in interface com.smartfoxserver.util.IWordFilter

    • setMaskCharacter

      public void setMaskCharacter(String mask)
      Specified by:
      setMaskCharacter in interface com.smartfoxserver.util.IWordFilter

    • getMaxBadWordsPerMessage

      public int getMaxBadWordsPerMessage()
      Specified by:
      getMaxBadWordsPerMessage in interface com.smartfoxserver.util.IWordFilter

    • setMaxBadWordsPerMessage

      public void setMaxBadWordsPerMessage(int max)
      Specified by:
      setMaxBadWordsPerMessage in interface com.smartfoxserver.util.IWordFilter

    • getKicksBeforeBanMinutes

      public int getKicksBeforeBanMinutes()
      Specified by:
      getKicksBeforeBanMinutes in interface com.smartfoxserver.util.IWordFilter

    • setKicksBeforeBanMinutes

      public void setKicksBeforeBanMinutes(int kicksBeforeBanMinutes)
      Specified by:
      setKicksBeforeBanMinutes in interface com.smartfoxserver.util.IWordFilter

    • getKickMessage

      public String getKickMessage()
      Specified by:
      getKickMessage in interface com.smartfoxserver.util.IWordFilter

    • setKickMessage

      public void setKickMessage(String kickMessage)
      Specified by:
      setKickMessage in interface com.smartfoxserver.util.IWordFilter

    • getBanMessage

      public String getBanMessage()
      Specified by:
      getBanMessage in interface com.smartfoxserver.util.IWordFilter

    • setBanMessage

      public void setBanMessage(String banMessage)
      Specified by:
      setBanMessage in interface com.smartfoxserver.util.IWordFilter

    • getBannedUserManger

      public com.smartfoxserver.entities.managers.IBannedUserManager getBannedUserManger()
      Specified by:
      getBannedUserManger in interface com.smartfoxserver.util.IWordFilter

    • setBannedUserManger

      public void setBannedUserManger(com.smartfoxserver.entities.managers.IBannedUserManager bannedUserManger)
      Specified by:
      setBannedUserManger in interface com.smartfoxserver.util.IWordFilter

    • getSecondsBeforeBanOrKick

      public int getSecondsBeforeBanOrKick()
      Specified by:
      getSecondsBeforeBanOrKick in interface com.smartfoxserver.util.IWordFilter

    • setSecondsBeforeBanOrKick

      public void setSecondsBeforeBanOrKick(int secondsBeforeBanOrKick)
      Specified by:
      setSecondsBeforeBanOrKick in interface com.smartfoxserver.util.IWordFilter

    • getWarningMessage

      public String getWarningMessage()
      Specified by:
      getWarningMessage in interface com.smartfoxserver.util.IWordFilter

    • setWarningMessage

      public void setWarningMessage(String message)
      Specified by:
      setWarningMessage in interface com.smartfoxserver.util.IWordFilter

    • isUseWarnings

      public boolean isUseWarnings()
      Specified by:
      isUseWarnings in interface com.smartfoxserver.util.IWordFilter

    • setUseWarnings

      public void setUseWarnings(boolean value)
      Specified by:
      setUseWarnings in interface com.smartfoxserver.util.IWordFilter

    • loadExpressionList

      public void loadExpressionList()
      Specified by:
      loadExpressionList in interface com.smartfoxserver.util.IWordFilter