|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.blojsom.plugin.velocity.StandaloneVelocityPlugin org.blojsom.plugin.comment.CommentPlugin
CommentPlugin
Field Summary | |
protected EventBroadcaster |
_eventBroadcaster
|
static java.lang.String |
AUTHOR_EMAIL_PARAM
Request parameter for the "authorEmail" |
static java.lang.String |
AUTHOR_PARAM
Request parameter for the "author" |
static java.lang.String |
AUTHOR_URL_PARAM
Request parameter for the "authorURL" |
static java.lang.String |
BLOJSOM_COMMENT_PLUGIN_AUTHOR
Key under which the author from the "remember me" cookie will be placed (example: on the request for the JSPDispatcher) |
static java.lang.String |
BLOJSOM_COMMENT_PLUGIN_AUTHOR_EMAIL
Key under which the author's e-mail from the "remember me" cookie will be placed (example: on the request for the JSPDispatcher) |
static java.lang.String |
BLOJSOM_COMMENT_PLUGIN_AUTHOR_URL
Key under which the author's URL from the "remember me" cookie will be placed (example: on the request for the JSPDispatcher) |
static java.lang.String |
BLOJSOM_COMMENT_PLUGIN_BLOG_COMMENT
Key under which the blog comment will be placed for merging the comment e-mail |
static java.lang.String |
BLOJSOM_COMMENT_PLUGIN_BLOG_ENTRY
Key under which the blog entry will be placed for merging the comment e-mail |
static java.lang.String |
BLOJSOM_COMMENT_PLUGIN_ENABLED
Key under which the indicator this plugin is "live" will be placed (example: on the request for the JSPDispatcher) |
static java.lang.String |
BLOJSOM_COMMENT_PLUGIN_METADATA_IP
IP address meta-data |
static java.lang.String |
BLOJSOM_COMMENT_PLUGIN_REMEMBER_ME
Key under which the "remember me" checkbox from the "remember me" cookie will be placed (example: on the request for the JSPDispatcher) |
static java.lang.String |
BLOJSOM_PLUGIN_COMMENT_METADATA
|
static java.lang.String |
BLOJSOM_PLUGIN_COMMENT_METADATA_DESTROY
|
static java.lang.String |
COMMENT_AUTOFORMAT_IP
Initialization parameter to do plugin autoformatting |
static java.lang.String |
COMMENT_COOKIE_EXPIRATION_DURATION_IP
Initialization parameter for the duration of the "remember me" cookies |
static java.lang.String |
COMMENT_DAYS_EXPIRATION_IP
Initialization parameter for disabling comments on entries after a certain number of days |
static java.lang.String |
COMMENT_PARAM
Request parameter for the "comment" |
static java.lang.String |
COMMENT_PLUGIN_EMAIL_TEMPLATE_HTML
|
static java.lang.String |
COMMENT_PLUGIN_EMAIL_TEMPLATE_TEXT
Template for comment e-mails |
static java.lang.String |
COMMENT_PREFIX_IP
Initialization parameter for e-mail prefix |
static java.lang.String |
COMMENT_TEXT_PARAM
Request parameter for the "commentText" |
static java.lang.String |
COMMENT_THROTTLE_MINUTES_IP
Initialization parameter for the throttling of comments from IP addresses |
static java.lang.String |
DEFAULT_COMMENT_PREFIX
Default prefix for comment e-mail notification |
Fields inherited from class org.blojsom.plugin.velocity.StandaloneVelocityPlugin |
_servletConfig, _velocityProperties |
Constructor Summary | |
CommentPlugin()
|
Method Summary | |
void |
cleanup()
Perform any cleanup for the plugin. |
void |
destroy()
Called when BlojsomServlet is taken out of service |
void |
handleEvent(Event event)
Handle an event broadcast from another component |
void |
init()
Initialize this plugin. |
Entry[] |
process(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse,
Blog blog,
java.util.Map context,
Entry[] entries)
Process the blog entries |
void |
processEvent(Event event)
Process an event from another component |
void |
setEventBroadcaster(EventBroadcaster eventBroadcaster)
Set the EventBroadcaster event broadcaster |
void |
setFetcher(Fetcher fetcher)
Set the Fetcher |
protected void |
setupEmail(Blog blog,
Entry entry,
org.apache.commons.mail.Email email)
Setup the comment e-mail |
Methods inherited from class org.blojsom.plugin.velocity.StandaloneVelocityPlugin |
mergeTemplate, setServletConfig, setVelocityProperties |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COMMENT_PLUGIN_EMAIL_TEMPLATE_TEXT
public static final java.lang.String COMMENT_PLUGIN_EMAIL_TEMPLATE_HTML
public static final java.lang.String DEFAULT_COMMENT_PREFIX
public static final java.lang.String COMMENT_PREFIX_IP
public static final java.lang.String COMMENT_AUTOFORMAT_IP
public static final java.lang.String COMMENT_COOKIE_EXPIRATION_DURATION_IP
public static final java.lang.String COMMENT_THROTTLE_MINUTES_IP
public static final java.lang.String COMMENT_DAYS_EXPIRATION_IP
public static final java.lang.String COMMENT_PARAM
public static final java.lang.String AUTHOR_PARAM
public static final java.lang.String AUTHOR_EMAIL_PARAM
public static final java.lang.String AUTHOR_URL_PARAM
public static final java.lang.String COMMENT_TEXT_PARAM
public static final java.lang.String BLOJSOM_COMMENT_PLUGIN_ENABLED
public static final java.lang.String BLOJSOM_COMMENT_PLUGIN_AUTHOR
public static final java.lang.String BLOJSOM_COMMENT_PLUGIN_AUTHOR_EMAIL
public static final java.lang.String BLOJSOM_COMMENT_PLUGIN_AUTHOR_URL
public static final java.lang.String BLOJSOM_COMMENT_PLUGIN_REMEMBER_ME
public static final java.lang.String BLOJSOM_COMMENT_PLUGIN_METADATA_IP
public static final java.lang.String BLOJSOM_COMMENT_PLUGIN_BLOG_ENTRY
public static final java.lang.String BLOJSOM_COMMENT_PLUGIN_BLOG_COMMENT
public static final java.lang.String BLOJSOM_PLUGIN_COMMENT_METADATA
public static final java.lang.String BLOJSOM_PLUGIN_COMMENT_METADATA_DESTROY
protected EventBroadcaster _eventBroadcaster
Constructor Detail |
public CommentPlugin()
Method Detail |
public void setEventBroadcaster(EventBroadcaster eventBroadcaster)
EventBroadcaster
event broadcaster
eventBroadcaster
- EventBroadcaster
public void setFetcher(Fetcher fetcher)
Fetcher
fetcher
- Fetcher
public void init() throws PluginException
init
in interface Plugin
init
in class StandaloneVelocityPlugin
PluginException
- If there is an error initializing the pluginpublic Entry[] process(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, Blog blog, java.util.Map context, Entry[] entries) throws PluginException
process
in interface Plugin
httpServletRequest
- RequesthttpServletResponse
- Responseblog
- Blog
instancecontext
- Contextentries
- Blog entries retrieved for the particular request
PluginException
- If there is an error processing the blog entriespublic void cleanup() throws PluginException
process(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.blojsom.blog.Blog, java.util.Map, org.blojsom.blog.Entry[])
.
cleanup
in interface Plugin
PluginException
- If there is an error performing cleanup for this pluginpublic void destroy() throws PluginException
destroy
in interface Plugin
PluginException
- If there is an error in finalizing this pluginprotected void setupEmail(Blog blog, Entry entry, org.apache.commons.mail.Email email) throws org.apache.commons.mail.EmailException
blog
- Blog
informationentry
- Entry
email
- Email message
org.apache.commons.mail.EmailException
- If there is an error preparing the e-mail messagepublic void handleEvent(Event event)
handleEvent
in interface Listener
event
- Event
to be handledpublic void processEvent(Event event)
processEvent
in interface Listener
event
- Event
to be handled
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |