Package com.smartfoxserver.v2.util

Class 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

    • 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

      • getFilterMode

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

      • setWordsFile

        public void setWordsFile​(java.lang.String wordsFile)
        Specified by:
        setWordsFile in interface IWordFilter

      • setFilterMode

        public void setFilterMode​(com.smartfoxserver.v2.util.filters.WordsFilterMode filterMode)
        Specified by:
        setFilterMode 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

      • setKickMessage

        public void setKickMessage​(java.lang.String kickMessage)
        Specified by:
        setKickMessage 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

      • setWarningMessage

        public void setWarningMessage​(java.lang.String message)
        Specified by:
        setWarningMessage in interface IWordFilter