|
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 |
java.lang.Objectcom.jivesoftware.forum.ban.BanManagerProxy
public class BanManagerProxy
Field Summary |
---|
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 |
Constructor Summary | |
---|---|
BanManagerProxy(BanManager banManager,
AuthToken authToken,
Permissions permissions)
|
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. |
protected boolean |
permCheck()
|
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 |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BanManagerProxy(BanManager banManager, AuthToken authToken, Permissions permissions)
Method Detail |
---|
public void createBan(Ban ban) throws UnauthorizedException
BanManager
createBan
in interface BanManager
ban
- the ticket to create
UnauthorizedException
public void updateBan(Ban ban) throws UnauthorizedException
BanManager
updateBan
in interface BanManager
ban
- the ticket to update
UnauthorizedException
public void removeBan(long banID) throws UnauthorizedException
BanManager
removeBan
in interface BanManager
banID
- the id of the ban to remove
UnauthorizedException
public Ban getBan(long userID, BanLevel banLevel) throws UnauthorizedException
BanManager
getBan
in interface BanManager
userID
- userID the ID of the userbanLevel
- the level of the ban
UnauthorizedException
public Ban getBan(java.lang.String ipAddress, BanLevel banLevel) throws UnauthorizedException
BanManager
getBan
in interface BanManager
ipAddress
- the IP Address of the banbanLevel
- the level of the ban
UnauthorizedException
public java.util.List getBans() throws UnauthorizedException
BanManager
getBans
in interface BanManager
UnauthorizedException
public java.util.List getBans(BanFilter filter) throws UnauthorizedException
BanManager
getBans
in interface BanManager
filter
- the BannedUserFilter object
UnauthorizedException
Ban
public boolean isValidIpAddress(java.lang.String ip)
BanManager
isValidIpAddress
in interface BanManager
ip
- the ip address to check
public boolean isBanningEnabled() throws UnauthorizedException
BanManager
isBanningEnabled
in interface BanManager
UnauthorizedException
public void setBanningEnabled(boolean enabled) throws UnauthorizedException
BanManager
setBanningEnabled
in interface BanManager
enabled
- the boolean value to enable/disable ban users feature.
UnauthorizedException
public boolean isEmailNotifyEnabled() throws UnauthorizedException
BanManager
isEmailNotifyEnabled
in interface BanManager
UnauthorizedException
public void setEmailNotifyEnabled(boolean emailNotifyEnabled) throws UnauthorizedException
BanManager
setEmailNotifyEnabled
in interface BanManager
emailNotifyEnabled
- the comma-delimited list of email addresses
UnauthorizedException
public java.lang.String getEmailName() throws UnauthorizedException
BanManager
getEmailName
in interface BanManager
UnauthorizedException
public void setEmailName(java.lang.String emailName) throws UnauthorizedException
BanManager
setEmailName
in interface BanManager
emailName
- the name that notification emails will appear to be from
UnauthorizedException
public java.lang.String getEmailAddress() throws UnauthorizedException
BanManager
getEmailAddress
in interface BanManager
UnauthorizedException
public void setEmailAddress(java.lang.String emailAddress) throws UnauthorizedException
BanManager
setEmailAddress
in interface BanManager
emailAddress
- the email address that notification emails will appear to be from
UnauthorizedException
public java.lang.String getEmailSubject(java.util.Locale locale) throws UnauthorizedException
BanManager
getEmailSubject
in interface BanManager
locale
- the locale for the subject of notification emails
UnauthorizedException
public void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale) throws UnauthorizedException
BanManager
setEmailSubject
in interface BanManager
emailSubject
- the text for the subject of notification emailslocale
- the locale for the subject of notification emails
UnauthorizedException
public java.lang.String getEmailBody(java.util.Locale locale) throws UnauthorizedException
BanManager
getEmailBody
in interface BanManager
locale
- the locale for the body of the notification emails
UnauthorizedException
public void setEmailBody(java.lang.String emailBody, java.util.Locale locale) throws UnauthorizedException
BanManager
setEmailBody
in interface BanManager
emailBody
- the text for the body of the notification emailslocale
- the locale for the body of the notification emails
UnauthorizedException
protected boolean permCheck()
public void userCreated(UserEvent event)
UserListener
userCreated
in interface UserListener
event
- the UserEventpublic void userDeleted(UserEvent event)
UserListener
userDeleted
in interface UserListener
event
- the UserEventpublic void userModified(UserEvent event)
UserListener
userModified
in interface UserListener
event
- the UserEvent
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |