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
23 import org.springframework.extensions.webscripts.Description.RequiredAuthentication;
24
25
26 /**
27 * Web Script Container extensions for a Web Script Runtime
28 *
29 * @author davidc
30 */
31 public interface RuntimeContainer extends Container
32 {
33 /**
34 * Execute the script in the context of the provided request and response
35 *
36 * @param scriptReq
37 * @param scriptRes
38 */
39 public void executeScript(WebScriptRequest scriptReq, WebScriptResponse scriptRes, Authenticator auth)
40 throws IOException;
41
42 /**
43 * Gets the required container authentication level (for matching web scripts)
44 *
45 * @return the required authentication level
46 */
47 public RequiredAuthentication getRequiredAuthentication();
48
49 /**
50 * Pre-authenticate container, if required
51 *
52 * @param auth
53 * @param required
54 */
55 public boolean authenticate(Authenticator auth, RequiredAuthentication required);
56 }