01: /*
02: * CommunityHomeProcessor.java
03: *
04: * Version: $Revision: $
05: *
06: * Date: $Date: $
07: *
08: * Copyright (c) 2002-2007, Hewlett-Packard Company and Massachusetts
09: * Institute of Technology. All rights reserved.
10: *
11: * Redistribution and use in source and binary forms, with or without
12: * modification, are permitted provided that the following conditions are
13: * met:
14: *
15: * - Redistributions of source code must retain the above copyright
16: * notice, this list of conditions and the following disclaimer.
17: *
18: * - Redistributions in binary form must reproduce the above copyright
19: * notice, this list of conditions and the following disclaimer in the
20: * documentation and/or other materials provided with the distribution.
21: *
22: * - Neither the name of the Hewlett-Packard Company nor the name of the
23: * Massachusetts Institute of Technology nor the names of their
24: * contributors may be used to endorse or promote products derived from
25: * this software without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28: * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31: * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
32: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
33: * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
34: * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36: * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37: * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38: * DAMAGE.
39: */
40: package org.dspace.plugin;
41:
42: import javax.servlet.http.HttpServletRequest;
43: import javax.servlet.http.HttpServletResponse;
44:
45: import org.dspace.authorize.AuthorizeException;
46: import org.dspace.content.Community;
47: import org.dspace.core.Context;
48:
49: /**
50: * Interface that must be implemented by any plugin wanting to be called at
51: * the inception of the Community home page (in HandleServlet). Classes that implement the process method
52: * and appear in the configuration will be run before the at the start of preparing the community home page has any
53: * chance to continue its execution
54: *
55: * @author Richard Jones
56: *
57: */
58: public interface CommunityHomeProcessor {
59: /**
60: * execute the process
61: *
62: * @param context the DSpace context
63: * @param request the HTTP request
64: * @param response the HTTP response
65: * @param community The community object whose home page we are on
66: *
67: * @throws PluginException any particular problem with the plugin execution
68: * @throws AuthorizeException Authorisation errors during plugin execution
69: */
70: void process(Context context, HttpServletRequest request,
71: HttpServletResponse response, Community community)
72: throws PluginException, AuthorizeException;
73:
74: }
|