Source code: com/arranger/jarl/script/jarlsp/JarlSPRuntime.java
1 package com.arranger.jarl.script.jarlsp;
2
3 import java.io.Writer;
4 import java.util.Map;
5
6 /**
7 * ISPRuntime created on Jan 17, 2003
8 *
9 * This is used to provide a runtime environment for an {@link JarlSPBase}
10 */
11 public interface JarlSPRuntime {
12
13 /**
14 * Gets the writer for this runtime
15 */
16 public Writer getWriter();
17
18 /**
19 * Returns specified parameter.
20 *
21 * @param name Name of parameter to get.
22 * @return Parameter value or null if not found.
23 */
24 public Object get(String name);
25
26 /**
27 * Get all the current properties
28 */
29 public Map getProperties();
30
31 /**
32 * Sets the specified parameter
33 *
34 * @param name Name of parameter to set
35 * @param value parameter value to set
36 */
37 public void put(String name, Object value);
38
39 /**
40 * Executes an jarlsp based upon its className
41 * @param jarlspClassName name of the class to execute
42 * @param writer the writer to use
43 * @param properties for this jarlSP
44 * @throws Exception
45 */
46 public void execute(String jarlspClassName, Writer writer, Map properties) throws Exception;
47 }