annotate artifact-database/src/main/java/org/dive4elements/artifactdatabase/DefaultArtifactFactory.java @ 570:584591f8203c 3.2.x

Upgrade to Log4j 2
author Tom Gottfried <tom@intevation.de>
date Mon, 28 Feb 2022 17:41:14 +0100
parents 3d9d6d61d0c6
children
rev   line source
100
933bbc9fc11f Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 93
diff changeset
1 /*
933bbc9fc11f Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 93
diff changeset
2 * Copyright (c) 2010 by Intevation GmbH
933bbc9fc11f Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 93
diff changeset
3 *
933bbc9fc11f Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 93
diff changeset
4 * This program is free software under the LGPL (>=v2.1)
933bbc9fc11f Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 93
diff changeset
5 * Read the file LGPL.txt coming with the software for details
933bbc9fc11f Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 93
diff changeset
6 * or visit http://www.gnu.org/licenses/ if it does not exist.
933bbc9fc11f Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 93
diff changeset
7 */
933bbc9fc11f Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 93
diff changeset
8
475
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
9 package org.dive4elements.artifactdatabase;
207
b2115f484edb Move Config and XMLUtils totally to commons package.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 100
diff changeset
10
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
11 import java.util.ArrayList;
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
12 import java.util.HashMap;
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
13 import java.util.List;
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
14 import java.util.Map;
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
15
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
16 import javax.xml.xpath.XPathConstants;
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
17
475
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
18 import org.dive4elements.artifacts.common.utils.Config;
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
19 import org.dive4elements.artifacts.common.utils.XMLUtils;
475
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
20
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
21 import org.dive4elements.artifacts.Artifact;
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
22 import org.dive4elements.artifacts.ArtifactFactory;
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
23 import org.dive4elements.artifacts.ArtifactSerializer;
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
24 import org.dive4elements.artifacts.CallMeta;
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
25 import org.dive4elements.artifacts.GlobalContext;
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
26
570
584591f8203c Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 533
diff changeset
27 import org.apache.logging.log4j.Logger;
584591f8203c Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 533
diff changeset
28 import org.apache.logging.log4j.LogManager;
93
e27cf9c84eb8 Unified imports.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 91
diff changeset
29
e27cf9c84eb8 Unified imports.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 91
diff changeset
30 import org.w3c.dom.Document;
517
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
31 import org.w3c.dom.Element;
93
e27cf9c84eb8 Unified imports.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 91
diff changeset
32 import org.w3c.dom.Node;
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
33 import org.w3c.dom.NodeList;
93
e27cf9c84eb8 Unified imports.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 91
diff changeset
34
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
35 /**
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
36 * Trivial implementation of the ArtifactFactory interface.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
37 * Time to live (ttl), name and description are configured
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
38 * via the Node given to #setup(Document, Node) with attributes
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
39 * of same name. The class name of the artifacts to be build by this
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
40 * factory is configures with the attribute 'artifact'.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
41 *
77
48d1a9a082c2 Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>'
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 75
diff changeset
42 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
43 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
44 public class DefaultArtifactFactory
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
45 implements ArtifactFactory
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
46 {
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
47 private static Logger logger =
570
584591f8203c Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 533
diff changeset
48 LogManager.getLogger(DefaultArtifactFactory.class);
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
49
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
50 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
51 * XPath to access the TTL of this artifact.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
52 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
53 public static final String XPATH_TTL = "@ttl";
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
54 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
55 * XPath to access the name of this factory.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
56 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
57 public static final String XPATH_NAME = "@name";
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
58 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
59 * XPath to access the description of this artifact factory.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
60 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
61 public static final String XPATH_DESCRIPTION = "@description";
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
62 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
63 * XPath to access the class name of the artifacts to be build
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
64 * by this factory.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
65 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
66 public static final String XPATH_ARTIFACT = "@artifact";
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
67 /**
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
68 * XPath to access the static facets configured for artifacts
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
69 */
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
70 public static final String XPATH_ARTIFACT_CONFIG =
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
71 "/artifact-database/artifacts/artifact[@name=$name]/load-facets/facet";
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
72
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
73 /**
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
74 * XPath to access the static facets configured for artifacts
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
75 */
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
76 public static final String XPATH_ARTIFACT_NAME =
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
77 "/artifact-database/artifacts/artifact/@name";
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
78
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
79 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
80 * Default description of this factory if none is given by the
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
81 * configuration.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
82 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
83 public static final String DEFAULT_DESCRIPTION =
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
84 "No description available";
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
85
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
86 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
87 * Class to load if no artifact class is given in the configuration.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
88 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
89 public static final String DEFAULT_ARTIFACT =
475
415df0fc4fa1 Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents: 473
diff changeset
90 "org.dive4elements.artifactdatabase.DefaultArtifact";
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
91
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
92 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
93 * The Time to live of the artifacts build by this factory.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
94 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
95 protected Long ttl;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
96
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
97 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
98 * The name of this factory.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
99 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
100 protected String name;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
101
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
102 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
103 * The description of this factory.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
104 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
105 protected String description;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
106
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
107 /**
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
108 * The class of the artifacts to be build by this factory.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
109 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
110 protected Class artifactClass;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
111
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
112 /**
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
113 * The name of the artifacts to be build by this factory.
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
114 */
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
115 protected String artifactName;
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
116
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
117 /**
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
118 * The list of facets the generated artifact creates on instantiation.
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
119 */
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
120 protected List<Class> facetClasses;
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
121
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
122 /**
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
123 * Default constructor.
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
124 */
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
125 public DefaultArtifactFactory() {
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
126 facetClasses = new ArrayList<Class>();
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
127 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
128
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
129 public String getName() {
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
130 return name;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
131 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
132
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
133 public String getDescription() {
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
134 return description;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
135 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
136
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
137 public Artifact createArtifact(
293
a367a0d011af Set an interface for the global context; added a method to the artifact database to return an instance of an Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 207
diff changeset
138 String identifier,
a367a0d011af Set an interface for the global context; added a method to the artifact database to return an instance of an Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 207
diff changeset
139 GlobalContext context,
297
694d818e99b2 Adapted the signature of Artifact.setup() - a parameter of type CallMeta has been added.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 293
diff changeset
140 CallMeta callMeta,
293
a367a0d011af Set an interface for the global context; added a method to the artifact database to return an instance of an Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 207
diff changeset
141 Document data
90
68285f7bc476 More javadoc.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 86
diff changeset
142 ) {
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
143 try {
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
144 Artifact artifact =
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
145 (Artifact)artifactClass.newInstance();
517
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
146 String oldName = artifact.getName();
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
147
517
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
148 if (oldName == null || oldName.length() == 0) {
533
3d9d6d61d0c6 Use the real artifact name.
Raimund Renkert <rrenkert@intevation.de>
parents: 517
diff changeset
149 artifact.setName(name);
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
150 }
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
151 artifact.setup(
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
152 identifier,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
153 this,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
154 context,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
155 callMeta,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
156 data,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
157 facetClasses);
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
158
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
159 return artifact;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
160 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
161 catch (InstantiationException ie) {
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
162 logger.error(ie.getLocalizedMessage(), ie);
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
163 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
164 catch (IllegalAccessException iae) {
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
165 logger.error(iae.getLocalizedMessage(), iae);
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
166 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
167 catch (ClassCastException cce) {
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
168 logger.error(cce.getLocalizedMessage(), cce);
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
169 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
170
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
171 return null;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
172 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
173
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
174 public void setup(Document document, Node factoryNode) {
517
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
175 boolean debug = logger.isDebugEnabled();
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
176
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
177 String ttlString = Config.getStringXPath(factoryNode, XPATH_TTL);
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
178 if (ttlString != null) {
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
179 try {
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
180 ttl = Long.valueOf(ttlString);
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
181 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
182 catch (NumberFormatException nfe) {
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
183 logger.warn("'" + ttlString + "' is not an integer.");
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
184 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
185 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
186
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
187 description = Config.getStringXPath(
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
188 factoryNode, XPATH_DESCRIPTION, DEFAULT_DESCRIPTION);
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
189
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
190 name = Config.getStringXPath(
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
191 factoryNode, XPATH_NAME, toString());
517
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
192
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
193 if (debug) {
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
194 logger.debug("setting up " + name);
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
195 }
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
196
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
197 String artifact = Config.getStringXPath(
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
198 factoryNode, XPATH_ARTIFACT, DEFAULT_ARTIFACT);
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
199
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
200 artifactName = Config.getStringXPath(
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
201 document, XPATH_ARTIFACT_NAME, "default");
517
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
202
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
203 if (debug) {
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
204 logger.debug("artifact name: " + artifactName);
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
205 }
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
206 Map<String, String> variables = new HashMap<String, String>();
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
207 variables.put("name", name);
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
208 NodeList facets = (NodeList) XMLUtils.xpath(
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
209 document,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
210 XPATH_ARTIFACT_CONFIG,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
211 XPathConstants.NODESET,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
212 null,
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
213 variables);
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
214
517
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
215 for (int i = 0, F = facets.getLength(); i < F; i++) {
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
216 Element element = (Element)facets.item(i);
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
217 String className = element.getAttribute("class");
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
218
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
219 if (debug) {
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
220 logger.debug("load facet class: " + className);
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
221 }
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
222
513
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
223 try {
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
224 facetClasses.add(Class.forName(className));
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
225 }
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
226 catch (ClassNotFoundException cnfe) {
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
227 logger.error(cnfe.getLocalizedMessage(), cnfe);
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
228 }
69f99bdf3d65 Use a list of "static" facets loaded from configuration to generate facets on artifact setup.
Raimund Renkert <rrenkert@intevation.de>
parents: 475
diff changeset
229 }
517
863f1fa66981 Simplified code to be more readable.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 513
diff changeset
230
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
231 try {
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
232 artifactClass = Class.forName(artifact);
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
233 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
234 catch (ClassNotFoundException cnfe) {
17
5a6b6a3debc7 Integrated logging into artifact database.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 10
diff changeset
235 logger.error(cnfe.getLocalizedMessage(), cnfe);
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
236 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
237
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
238 if (artifactClass == null) {
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
239 artifactClass = DefaultArtifact.class;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
240 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
241 }
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
242
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
243 public Long timeToLiveUntouched(Artifact artifact, Object context) {
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
244 return ttl;
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
245 }
41
5e4bc24ea438 Made serilization more flexible. DB update required!!!
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 24
diff changeset
246
5e4bc24ea438 Made serilization more flexible. DB update required!!!
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 24
diff changeset
247 public ArtifactSerializer getSerializer() {
5e4bc24ea438 Made serilization more flexible. DB update required!!!
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 24
diff changeset
248 return DefaultArtifactSerializer.INSTANCE;
5e4bc24ea438 Made serilization more flexible. DB update required!!!
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 24
diff changeset
249 }
10
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
250 }
91
730ff077a58c More javadoc, some code formatting.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 90
diff changeset
251 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org