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.InputStream;
22 import java.io.Reader;
23
24
25 /**
26 * Web Script Content
27 *
28 * @author davidc
29 */
30 public interface ScriptContent
31 {
32 /**
33 * Gets an input stream to the contents of the script
34 *
35 * @return the input stream
36 */
37 InputStream getInputStream();
38
39 /**
40 * Gets a reader to the contents of the script
41 *
42 * @return the reader
43 */
44 Reader getReader();
45
46 /**
47 * Gets the path to the content
48 *
49 * @return path
50 */
51 public String getPath();
52
53 /**
54 * Gets path description
55 *
56 * @return human readable version of path
57 */
58 public String getPathDescription();
59
60 /**
61 * Returns true if the script content is considered cachedable - i.e. classpath located or similar.
62 * Else the content will be compiled/interpreted on every execution i.e. repo content.
63 *
64 * @return true if the script content is considered cachedable, false otherwise
65 */
66 boolean isCachable();
67
68 /**
69 * Returns true if the script location is considered secure - i.e. on the app-server classpath.
70 * Secure scripts may access java.* libraries and instantiate pure Java objects directly. Unsecure
71 * scripts only have access to pre-configure host objects and cannot access java.* libs.
72 *
73 * @return true if the script location is considered secure
74 */
75 boolean isSecure();
76 }