01: /*
02: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Portal/Sources/es/udc/mypersonalizer/portal/controller/services/ServiceController.java,v 1.1.1.1 2004/03/25 12:08:39 fbellas Exp $
03: * $Revision: 1.1.1.1 $
04: * $Date: 2004/03/25 12:08:39 $
05: *
06: * =============================================================================
07: *
08: * Copyright (c) 2003, The MyPersonalizer Development Group
09: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
10: * University Of A Coruna
11: * All rights reserved.
12: *
13: * Redistribution and use in source and binary forms, with or without
14: * modification, are permitted provided that the following conditions are met:
15: *
16: * - Redistributions of source code must retain the above copyright notice,
17: * this list of conditions and the following disclaimer.
18: *
19: * - Redistributions in binary form must reproduce the above copyright notice,
20: * this list of conditions and the following disclaimer in the documentation
21: * and/or other materials provided with the distribution.
22: *
23: * - Neither the name of the University Of A Coruna nor the names of its
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 "AS IS"
28: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37: * POSSIBILITY OF SUCH DAMAGE.
38: *
39: */
40:
41: package es.udc.mypersonalizer.portal.controller.services;
42:
43: import es.udc.mypersonalizer.kernel.model.repository.interfaces.ServiceButtonsState;
44: import es.udc.mypersonalizer.kernel.model.repository.interfaces.ServiceProperty;
45: import es.udc.mypersonalizer.kernel.model.repository.interfaces.ServicePropertyKey;
46: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
47: import javax.servlet.http.HttpServletRequest;
48: import javax.servlet.http.HttpServletResponse;
49:
50: /**
51: * This interface must be followed by the class intended to collect the
52: * reply of a service. This class, called the <i>service controller</i>,
53: * must be declared in the <tt>serviceControllerClassName</tt>
54: * configuration parameter.<p>
55: *
56: * This service controller is called from the <tt>ServiceReplyManager</tt>.
57: *
58: * @author Daniel Fernandez
59: * @since 1.0
60: */
61: public interface ServiceController {
62:
63: /**
64: * Returns the reply of the service, according to the configuration
65: * that is provided (ServiceProperty).
66: *
67: * @param request the request object.
68: * @param response the response object.
69: * @param servicePropertyKey the service property key object.
70: * @param serviceProperty the service property.
71: * @param buttons the service buttons state.
72: * @throws InternalErrorException if any fatal errors happen.
73: * @throws ServiceNotAvailableException if the service is not accessible.
74: * @throws ServiceTimeOutException if the service exceeds its assigned
75: * timeout.
76: * @return the service reply
77: */
78: public String getPersonalizedReply(HttpServletRequest request,
79: HttpServletResponse response,
80: ServicePropertyKey servicePropertyKey,
81: ServiceProperty serviceProperty, ServiceButtonsState buttons)
82: throws InternalErrorException,
83: ServiceNotAvailableException, ServiceTimeOutException;
84:
85: }
|