1 /**
2 * Copyright (C) 2005-2009 Alfresco Software Limited.
3 *
4 * This file is part of the Spring Surf Extension project.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.springframework.extensions.webscripts;
20
21 import java.io.IOException;
22 import java.util.ResourceBundle;
23
24 /**
25 * Web Script
26 *
27 * @author davidc
28 */
29 public interface WebScript
30 {
31 /**
32 * Gets the Service Description
33 *
34 * @return service description
35 */
36 public Description getDescription();
37
38 /**
39 * Gets the Service Resources
40 *
41 * @return ResourceBundle of services resources or null if none present
42 */
43 public ResourceBundle getResources();
44
45 /**
46 * Execute the Service
47 *
48 * @param req WebScriptRequest representing the request to this service
49 * @param res WebScriptResponse encapsulating the result of this service
50 *
51 * @throws IOException
52 */
53 public void execute(WebScriptRequest req, WebScriptResponse res)
54 throws IOException;
55 }