Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.ban
Class BanManagerImpl

java.lang.Object
  extended by com.jivesoftware.base.ban.AbstractBanManager
      extended by com.jivesoftware.forum.ban.BanManagerImpl
All Implemented Interfaces:
BanManager, UserListener

public class BanManagerImpl
extends AbstractBanManager

A concrete instance of the BanManager interface providing additional forum functionality to the base ban manager model.


Field Summary
 
Fields inherited from class com.jivesoftware.base.ban.AbstractBanManager
banDAO
 
Fields inherited from interface com.jivesoftware.base.ban.BanManager
PROPERTY_BANNED_USER_ENABLE, PROPERTY_EMAIL_ADDRESS, PROPERTY_EMAIL_BODY, PROPERTY_EMAIL_NAME, PROPERTY_EMAIL_NOTIFY_ENABLED, PROPERTY_EMAIL_SUBJECT, TYPE_BAN_IP, TYPE_BAN_USER
 
Method Summary
static BanManagerImpl getInstance()
          Provides singleton access to a BanManagerImpl instance.
 void setBanningEnabled(boolean enabled)
          Overridden to provide specific forum functionality of installing the ban message interceptor when banning is set to enabled, and removing the ban message interceptor when banning is set to disabled.
 void userCreated(UserEvent event)
          Fired when a user is created.
 void userDeleted(UserEvent event)
          Fired when a user is deleted.
 void userModified(UserEvent event)
          Fired when a user is modified.
 
Methods inherited from class com.jivesoftware.base.ban.AbstractBanManager
createBan, getBan, getBan, getBans, getBans, getEmailAddress, getEmailBody, getEmailName, getEmailSubject, isBanningEnabled, isEmailNotifyEnabled, isValidIpAddress, populateContext, removeBan, setEmailAddress, setEmailBody, setEmailName, setEmailNotifyEnabled, setEmailSubject, updateBan
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static BanManagerImpl getInstance()
Provides singleton access to a BanManagerImpl instance.


setBanningEnabled

public void setBanningEnabled(boolean enabled)
Overridden to provide specific forum functionality of installing the ban message interceptor when banning is set to enabled, and removing the ban message interceptor when banning is set to disabled.

Specified by:
setBanningEnabled in interface BanManager
Overrides:
setBanningEnabled in class AbstractBanManager
Parameters:
enabled - the boolean value to enable / disable banning

userCreated

public void userCreated(UserEvent event)
Description copied from interface: UserListener
Fired when a user is created.

Parameters:
event - the UserEvent

userDeleted

public void userDeleted(UserEvent event)
Description copied from interface: UserListener
Fired when a user is deleted.

Parameters:
event - the UserEvent

userModified

public void userModified(UserEvent event)
Description copied from interface: UserListener
Fired when a user is modified.

Parameters:
event - the UserEvent

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.