KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jpublish > action > ScriptHandler


1 /*--
2
3  Copyright (C) 2001-2003 Aetrion LLC.
4  All rights reserved.
5  
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions
8  are met:
9  
10  1. Redistributions of source code must retain the above copyright
11     notice, this list of conditions, and the following disclaimer.
12  
13  2. Redistributions in binary form must reproduce the above copyright
14     notice, this list of conditions, and the disclaimer that follows
15     these conditions in the documentation and/or other materials
16     provided with the distribution.
17
18  3. The name "JPublish" must not be used to endorse or promote products
19     derived from this software without prior written permission. For
20     written permission, please contact info@aetrion.com.
21  
22  4. Products derived from this software may not be called "JPublish", nor
23     may "JPublish" appear in their name, without prior written permission
24     from Aetrion LLC (info@aetrion.com).
25  
26  In addition, the authors of this software request (but do not require)
27  that you include in the end-user documentation provided with the
28  redistribution and/or in the software itself an acknowledgement equivalent
29  to the following:
30      "This product includes software developed by
31       Aetrion LLC (http://www.aetrion.com/)."
32
33  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
37  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43  POSSIBILITY OF SUCH DAMAGE.
44
45  For more information on JPublish, please see <http://www.jpublish.org/>.
46  
47  */
48
49 package org.jpublish.action;
50
51 import com.anthonyeden.lib.config.Configuration;
52 import com.anthonyeden.lib.config.ConfigurationException;
53 import org.apache.commons.vfs.FileObject;
54 import org.jpublish.RequestContext;
55
56 /**
57  * ScriptHandlers handle the actual execution of scripts. It is up to the class using the script handler to acquire and
58  * possibly cache scripts.
59  *
60  * @author Anthony Eden
61  */
62
63 public interface ScriptHandler {
64
65     /**
66      * Get the FileObject which the ScriptHandler will handle.
67      *
68      * @return The FileObject
69      */
70
71     public FileObject getFile();
72
73     /**
74      * Set the FileObject which the ScriptHandler will handle.
75      *
76      * @param file The FileObject
77      */
78
79     public void setFile(FileObject file);
80
81     /**
82      * Set the variable.
83      *
84      * @param name The variable name
85      * @param value The variable value
86      * @param c The Class
87      */
88
89     public void set(String JavaDoc name, Object JavaDoc value, Class JavaDoc c);
90
91     /**
92      * Execute the specified script.
93      *
94      * @param name The script name
95      * @param scriptText The script text
96      * @param requestContext The request context
97      * @param configuration The Configuration object
98      */
99
100     public void execute(String JavaDoc name, String JavaDoc scriptText, RequestContext context,
101             Configuration configuration);
102
103     /**
104      * Load the script handler's configuration.
105      *
106      * @param configuration The Configuration object
107      * @throws ConfigurationException
108      */
109
110     public void loadConfiguration(Configuration configuration)
111             throws ConfigurationException;
112
113     /**
114      * Initialize the script handler.
115      */
116
117     public void init();
118
119 }
120
Popular Tags