|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BanManager
Manages the banning of User Accounts and IP Addresses. There are various ban levels, such as Ban Login, Ban Post, and Moderate Post. Bans can also be set to expire, allowing for temporary bans in addition to permanent bans.
Field Summary | |
---|---|
static java.lang.String |
PROPERTY_BANNED_USER_ENABLE
****** Ban Setting Properties ****** |
static java.lang.String |
PROPERTY_EMAIL_ADDRESS
|
static java.lang.String |
PROPERTY_EMAIL_BODY
|
static java.lang.String |
PROPERTY_EMAIL_NAME
|
static java.lang.String |
PROPERTY_EMAIL_NOTIFY_ENABLED
|
static java.lang.String |
PROPERTY_EMAIL_SUBJECT
|
static int |
TYPE_BAN_IP
Ban By IP Address |
static int |
TYPE_BAN_USER
Ban by user account |
Method Summary | |
---|---|
void |
createBan(Ban ban)
Creates a ban entry in the database |
Ban |
getBan(long userID,
BanLevel banLevel)
Gets a Ban Object from the database. |
Ban |
getBan(java.lang.String ipAddress,
BanLevel banLevel)
Gets a Ban Object from the database. |
java.util.List |
getBans()
Gets an unfiltered list of Ban objects from database |
java.util.List |
getBans(BanFilter filter)
Gets a filtered list of Ban objects from the database |
java.lang.String |
getEmailAddress()
Gets the email address that notification emails will appear to be from |
java.lang.String |
getEmailBody(java.util.Locale locale)
Gets the text for the body of the notification emails. |
java.lang.String |
getEmailName()
Gets the name that notification emails will appear to be from |
java.lang.String |
getEmailSubject(java.util.Locale locale)
Gets the text for the subject of notification emails |
boolean |
isBanningEnabled()
Checks if the ban feature is enabled |
boolean |
isEmailNotifyEnabled()
Gets the comma-delimited list of email addresses to notify when a user with with ban level notify posts a message. |
boolean |
isValidIpAddress(java.lang.String ip)
Check that an IP Address is valid. |
void |
removeBan(long banID)
Removes a ban entry from the database |
void |
setBanningEnabled(boolean enabled)
Enabled/Disabled Ban feature. |
void |
setEmailAddress(java.lang.String emailAddress)
Sets the email address that notification emails will appear to be from |
void |
setEmailBody(java.lang.String emailBody,
java.util.Locale locale)
Text for the body of of notification emails. |
void |
setEmailName(java.lang.String emailName)
Sets The name that notification emails will appear to be from |
void |
setEmailNotifyEnabled(boolean emailNotifyEnabled)
Sets the list of email addresses to notify when an attachment is blocked |
void |
setEmailSubject(java.lang.String emailSubject,
java.util.Locale locale)
Sets the text for the subject of notification emails |
void |
updateBan(Ban ban)
Updates a ban entry in the database |
Methods inherited from interface com.jivesoftware.base.event.UserListener |
---|
userCreated, userDeleted, userModified |
Field Detail |
---|
static final int TYPE_BAN_USER
static final int TYPE_BAN_IP
static final java.lang.String PROPERTY_BANNED_USER_ENABLE
static final java.lang.String PROPERTY_EMAIL_NOTIFY_ENABLED
static final java.lang.String PROPERTY_EMAIL_NAME
static final java.lang.String PROPERTY_EMAIL_ADDRESS
static final java.lang.String PROPERTY_EMAIL_SUBJECT
static final java.lang.String PROPERTY_EMAIL_BODY
Method Detail |
---|
void createBan(Ban ban) throws UnauthorizedException
ban
- the ticket to create
UnauthorizedException
void updateBan(Ban ban) throws UnauthorizedException
ban
- the ticket to update
UnauthorizedException
void removeBan(long banID) throws UnauthorizedException
banID
- the id of the ban to remove
UnauthorizedException
Ban getBan(long userID, BanLevel banLevel) throws UnauthorizedException
userID
- userID the ID of the userbanLevel
- the level of the ban
UnauthorizedException
Ban getBan(java.lang.String ipAddress, BanLevel banLevel) throws UnauthorizedException
ipAddress
- the IP Address of the banbanLevel
- the level of the ban
UnauthorizedException
java.util.List getBans() throws UnauthorizedException
UnauthorizedException
java.util.List getBans(BanFilter filter) throws UnauthorizedException
filter
- the BannedUserFilter object
UnauthorizedException
Ban
boolean isValidIpAddress(java.lang.String ip)
ip
- the ip address to check
boolean isBanningEnabled() throws UnauthorizedException
UnauthorizedException
void setBanningEnabled(boolean enabled) throws UnauthorizedException
enabled
- the boolean value to enable/disable ban users feature.
UnauthorizedException
boolean isEmailNotifyEnabled() throws UnauthorizedException
UnauthorizedException
void setEmailNotifyEnabled(boolean emailNotifyEnabled) throws UnauthorizedException
emailNotifyEnabled
- the comma-delimited list of email addresses
UnauthorizedException
java.lang.String getEmailName() throws UnauthorizedException
UnauthorizedException
void setEmailName(java.lang.String emailName) throws UnauthorizedException
emailName
- the name that notification emails will appear to be from
UnauthorizedException
java.lang.String getEmailAddress() throws UnauthorizedException
UnauthorizedException
void setEmailAddress(java.lang.String emailAddress) throws UnauthorizedException
emailAddress
- the email address that notification emails will appear to be from
UnauthorizedException
java.lang.String getEmailSubject(java.util.Locale locale) throws UnauthorizedException
locale
- the locale for the subject of notification emails
UnauthorizedException
void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale) throws UnauthorizedException
emailSubject
- the text for the subject of notification emailslocale
- the locale for the subject of notification emails
UnauthorizedException
java.lang.String getEmailBody(java.util.Locale locale) throws UnauthorizedException
locale
- the locale for the body of the notification emails
UnauthorizedException
void setEmailBody(java.lang.String emailBody, java.util.Locale locale) throws UnauthorizedException
emailBody
- the text for the body of the notification emailslocale
- the locale for the body of the notification emails
UnauthorizedException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |