org.blojsom.plugin.weather
Class WeatherPlugin

java.lang.Object
  org.blojsom.plugin.weather.WeatherPlugin

All Implemented Interfaces:

Plugin

public class WeatherPlugin

extends java.lang.Object

implements Plugin

WeatherPlugin

Since:

blojsom 3.0

Version:

$Id: WeatherPlugin.java,v 1.4 2007/01/17 02:35:15 czarneckid Exp $

Author:

David Czarnecki, Mark Lussier

Field Summary

static java.lang.String	DEFAULT_WEATHER_CODE Default Weather Station Code - Albany International Airport - Albany, NY USA
static java.lang.String	DEFAULT_WEATHER_PROVIDER Default weather provider from National Weather Service
static java.lang.String	PROPERTY_WEATHER_CODE Weather station code initialization parameter
static java.lang.String	PROPERTY_WEATHER_PROVIDER Weather provider initialization parameter

Constructor Summary

WeatherPlugin()

Method Summary

void	cleanup() Perform any cleanup for the plugin.
void	destroy() Called when BlojsomServlet is taken out of service
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
protected Weather	readWeatherSettingsForBlog(Blog blog) Read the Weather settings for a blog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_WEATHER_CODE

public static final java.lang.String PROPERTY_WEATHER_CODE

Weather station code initialization parameter

See Also:

Constant Field Values

PROPERTY_WEATHER_PROVIDER

public static final java.lang.String PROPERTY_WEATHER_PROVIDER

Weather provider initialization parameter

See Also:

Constant Field Values

DEFAULT_WEATHER_PROVIDER

public static final java.lang.String DEFAULT_WEATHER_PROVIDER

Default weather provider from National Weather Service

See Also:

Constant Field Values

DEFAULT_WEATHER_CODE

public static final java.lang.String DEFAULT_WEATHER_CODE

Default Weather Station Code - Albany International Airport - Albany, NY USA

See Also:

Constant Field Values

Constructor Detail

WeatherPlugin

public WeatherPlugin()

Method Detail

init

public void init()
          throws PluginException

Initialize this plugin. This method only called when the plugin is instantiated.

Specified by:

init in interface Plugin

Throws:

PluginException - If there is an error initializing the plugin

readWeatherSettingsForBlog

protected Weather readWeatherSettingsForBlog(Blog blog)

Read the Weather settings for a blog

Parameters:

blog - Blog

Returns:

Weather settings for the blog

process

public Entry[] process(javax.servlet.http.HttpServletRequest httpServletRequest,
                       javax.servlet.http.HttpServletResponse httpServletResponse,
                       Blog blog,
                       java.util.Map context,
                       Entry[] entries)
                throws PluginException

Process the blog entries

Specified by:

process in interface Plugin

Parameters:

httpServletRequest - Request

httpServletResponse - Response

blog - Blog instance

context - Context

entries - Blog entries retrieved for the particular request

Returns:

Modified set of blog entries

Throws:

PluginException - If there is an error processing the blog entries

cleanup

public void cleanup()
             throws PluginException

Perform any cleanup for the plugin. Called after process(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.blojsom.blog.Blog, java.util.Map, org.blojsom.blog.Entry[]).

Specified by:

cleanup in interface Plugin

Throws:

PluginException - If there is an error performing cleanup for this plugin

destroy

public void destroy()
             throws PluginException

Called when BlojsomServlet is taken out of service

Specified by:

destroy in interface Plugin

Throws:

PluginException - If there is an error in finalizing this plugin