01: /*
02: * $Id: BSFManagerFilter.java 471754 2006-11-06 14:55:09Z husted $
03: *
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
20: */
21: package org.apache.struts.scripting;
22:
23: // util imports:
24: import java.util.Properties;
25:
26: // misc imports:
27: import org.apache.bsf.BSFManager;
28:
29: /**
30: * Defines a class that wants to manipulate the contents of the scripting
31: * context before the script is executed. An example would be a class that puts
32: * business facade classes in the context.
33: */
34: public interface BSFManagerFilter {
35:
36: /**
37: * Initializes the filter. Properties can be retrieved as: <code>
38: * struts-scripting.filters.FILTER_NAME.PROPERTY_NAME=PROPERTY_VALUE
39: * </code> where FILTER_NAME is the "name" parameter.
40: *
41: *@param name The name of the filter
42: *@param props The properties
43: */
44: void init(String name, Properties props);
45:
46: /**
47: * Applies the filter.
48: *
49: *@param mgr The scripting manager
50: *@return The scripting manager
51: */
52: BSFManager apply(BSFManager mgr);
53: }
|