1 /**
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.decima.xml.templating.document.post.template;
28
29 import gov.nist.secauto.decima.core.document.DocumentException;
30 import gov.nist.secauto.decima.core.document.handling.ResourceResolver;
31 import gov.nist.secauto.decima.xml.document.MutableXMLDocument;
32
33 import java.net.URL;
34 import java.util.List;
35
36 /**
37 * Represents a template processor that applies a number of {@code Action} transforms to a template
38 * document.
39 */
40 public interface TemplateProcessor {
41 /*
42 * Retrieve the URL of the template definition file.
43 *
44 * @return a URL pointing to the template definition file
45 */
46 URL getContextSystemId();
47
48 /**
49 * Retrieve the URL for the base template that is used for the transformations.
50 *
51 * @return a URL pointing to the template to use
52 */
53 URL getBaseTemplateURL();
54
55 /**
56 * Retrieves the sequence of actions to be applied to the template.
57 *
58 * @return a list of actions
59 */
60 List<Action> getActions();
61
62 /**
63 * Creates a resulting {@code Template} by processing a set of {@code Action} transforms against a
64 * base template.
65 *
66 * @param resolver
67 * the TemplateResolver to use to load the template
68 * @return a new {@code Document} based on the provided template and transformations
69 * @throws DocumentException
70 * if a processing error occurs
71 */
72 MutableXMLDocument generate(ResourceResolver<MutableXMLDocument> resolver) throws DocumentException;
73 }