|
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.interceptor.IPInterceptor
public class IPInterceptor
Interceptor to take action on a message posting depending on IP address of user posting. Note that in order for this interceptor to work, IP tracking must be turned on.
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.MessageInterceptor |
---|
TYPE_ALL, TYPE_BOTH, TYPE_EDIT, TYPE_POST, TYPE_PRE |
Constructor Summary | |
---|---|
IPInterceptor()
|
|
IPInterceptor(int type,
long objectID)
|
Method Summary | |
---|---|
java.lang.String |
getBanList()
Get the comma delimited list of banned IP's. |
java.lang.String |
getEmailAddress()
Returns the email address that notification emails will appear to be from. |
java.lang.String |
getEmailBody()
Deprecated. replaced by getEmailBody(java.util.Locale) |
java.lang.String |
getEmailBody(java.util.Locale locale)
Returns the body of the nofication emails. |
java.lang.String |
getEmailList()
Get the comma delimited list of IP's whose posts generate an email notification. |
java.lang.String |
getEmailName()
Returns the name that notification emails will appear to be from. |
java.lang.String |
getEmailNotifyList()
Returns the list of email addresses that will be notified when keywords are found. |
java.lang.String |
getEmailSubject()
Deprecated. replaced by getEmailSubject(java.util.Locale) |
java.lang.String |
getEmailSubject(java.util.Locale locale)
Returns the subject of the notification emails. |
java.lang.String |
getModerationList()
Get the comma delimited list of IP's whose posts get moderated. |
int |
getType()
returns whether this Interceptor is a pre, post, or both. |
void |
invokeInterceptor(ForumMessage message,
int type)
checks to see if IP is banned, moderated, or requires an email notification. |
void |
setBanList(java.lang.String banList)
Set the list of banned IPs. |
void |
setEmailAddress(java.lang.String emailAddress)
Sets the email address that notification emails will appear to be from. |
void |
setEmailBody(java.lang.String emailBody)
Deprecated. replaced by setEmailBody(String, java.util.Locale) |
void |
setEmailBody(java.lang.String emailBody,
java.util.Locale locale)
Sets the body of the nofication emails. |
void |
setEmailList(java.lang.String emailList)
Set the list of IPs whose posts generate an email notification. |
void |
setEmailName(java.lang.String emailName)
Sets the name that notification emails will appear to be from. |
void |
setEmailNotifyList(java.lang.String notifyList)
Sets the list of email addresses that will be notified when keywords are found. |
void |
setEmailSubject(java.lang.String emailSubject)
Deprecated. replaced byh setEmailSubject(String, java.util.Locale) |
void |
setEmailSubject(java.lang.String emailSubject,
java.util.Locale locale)
Sets the subject of the nofitication emails. |
void |
setModerationList(java.lang.String moderationList)
Set the list of IPs whose posts get moderated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IPInterceptor()
public IPInterceptor(int type, long objectID)
Method Detail |
---|
public int getType()
getType
in interface MessageInterceptor
public void invokeInterceptor(ForumMessage message, int type) throws MessageRejectedException
invokeInterceptor
in interface MessageInterceptor
message
- type
-
MessageRejectedException
public void setBanList(java.lang.String banList)
banList
- public java.lang.String getBanList()
public void setModerationList(java.lang.String moderationList)
moderationList
- public java.lang.String getModerationList()
public void setEmailList(java.lang.String emailList)
emailList
- public java.lang.String getEmailList()
public java.lang.String getEmailNotifyList()
public void setEmailNotifyList(java.lang.String notifyList)
notifyList
- the comma-delimited list of notification email addresses.public java.lang.String getEmailName()
public void setEmailName(java.lang.String emailName)
emailName
- the name that notification emails will appear from.public java.lang.String getEmailAddress()
public void setEmailAddress(java.lang.String emailAddress)
emailAddress
- the email address that notification emails will appear from.public java.lang.String getEmailSubject()
getEmailSubject(java.util.Locale)
public java.lang.String getEmailSubject(java.util.Locale locale)
locale
- the locale to get the subject for
public void setEmailSubject(java.lang.String emailSubject)
setEmailSubject(String, java.util.Locale)
emailSubject
- the subject of notification emails.public void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale)
emailSubject
- the subject of notification emails.locale
- The locale to set the subject forpublic java.lang.String getEmailBody()
getEmailBody(java.util.Locale)
public java.lang.String getEmailBody(java.util.Locale locale)
locale
- the locale to get the body for
public void setEmailBody(java.lang.String emailBody)
setEmailBody(String, java.util.Locale)
emailBody
- the body of the notification emails.public void setEmailBody(java.lang.String emailBody, java.util.Locale locale)
emailBody
- the body of the notification emails.locale
- the locale to set the email body for
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |