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.util.Map;
22
23 import org.springframework.extensions.config.ConfigService;
24
25
26 /**
27 * Web Script Container
28 *
29 * @author davidc
30 */
31 public interface Container
32 {
33 /**
34 * Gets the name of the Container
35 *
36 * @return name
37 */
38 public String getName();
39
40 /**
41 * Gets the Container Description
42 *
43 * @return description
44 */
45 public ServerModel getDescription();
46
47 /**
48 * Gets the Script Processor Registry
49 *
50 * @return script processor registry
51 */
52 public ScriptProcessorRegistry getScriptProcessorRegistry();
53
54 /**
55 * Gets parameters for the Script Processor
56 *
57 * @return parameters
58 */
59 public Map<String, Object> getScriptParameters();
60
61 /**
62 * Gets the Template Processor Registry
63 *
64 * @return template processor registry
65 */
66 public TemplateProcessorRegistry getTemplateProcessorRegistry();
67
68 /**
69 * Gets parameters for the Template Processor
70 *
71 * @return parameters
72 */
73 public Map<String, Object> getTemplateParameters();
74
75 /**
76 * Gets the response format registry
77 *
78 * @return response format registry
79 */
80 public FormatRegistry getFormatRegistry();
81
82 /**
83 * Gets the registry of Web Scripts
84 *
85 * @return registry of web scripts
86 */
87 public Registry getRegistry();
88
89 /**
90 * Gets the Search Path
91 *
92 * @return search path
93 */
94 public SearchPath getSearchPath();
95
96 /**
97 * Gets the Config Service
98 *
99 * @return config service
100 */
101 public ConfigService getConfigService();
102
103 /**
104 * Re-initialise the Web Script Container
105 */
106 public void reset();
107
108 }