01: // THIS SOFTWARE IS PROVIDED BY SOFTARIS PTY.LTD. AND OTHER METABOSS
02: // CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
03: // BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
04: // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTARIS PTY.LTD.
05: // OR OTHER METABOSS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
06: // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
07: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
08: // OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
09: // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
10: // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
11: // EVEN IF SOFTARIS PTY.LTD. OR OTHER METABOSS CONTRIBUTORS ARE ADVISED OF THE
12: // POSSIBILITY OF SUCH DAMAGE.
13: //
14: // Copyright 2000-2005 © Softaris Pty.Ltd. All Rights Reserved.
15: package com.metaboss.sdlctools.services.jdktools;
16:
17: import com.metaboss.enterprise.bs.BSException;
18:
19: /** This component provides MetaBoss Java template processing service.
20: * MetaBoss Java template is a simple 'servlet' style Java class, which implements
21: * @see com.metaboss.javatemplate.JavaTemplate
22: */
23: public interface BSJavaTemplateProcessor {
24: /** Naming URL of the component */
25: public static final String COMPONENT_URL = "component:/com.metaboss.sdlctools.services.jdktools.BSJavaTemplateProcessor";
26:
27: /** Merges given template with given set of properties.
28: * @see com.metaboss.javatemplate.JavaTemplate
29: * @param pSourceTemplate the string with template source in it. The template source is a
30: * normal java source of the class, implementing com.metaboss.javatemplate.JavaTemplate interface
31: * @param pSourceTemplateName the unique name of the template - used in logging, may also be used in
32: * caching, so the caller must make sure that the same template always has exact same name
33: * @param pTemplateJavaClassName the name of the class, whose source is provided in pSourceTemplate
34: * @param pContextMap the context map to pass to the template processor.
35: * @return MergeResult contains the result of the requested operation */
36: public MergeResult mergeTemplate(String pSourceTemplate,
37: String pSourceTemplateName, String pTemplateJavaClassName,
38: java.util.Map pContextMap) throws BSException;
39: }
|