Document parseDocument(String filename) throws Exception {
FileReader reader = new FileReader(filename);
String firstLine = new BufferedReader(reader).readLine();
reader.close();
Document document = null;
if (firstLine.startsWith("<?xml")) {
System.err.println("XML detected; using default XML parser.");
} else {
try {
Class nekoParserClass = Class.forName("org.cyberneko.html.parsers.DOMParser");
Object parser = nekoParserClass.newInstance();
Method parse = nekoParserClass.getMethod("parse", new Class[] {String.class});
Method getDocument = nekoParserClass.getMethod("getDocument", new Class[0]);
parse.invoke(parser, filename);
document = (Document) getDocument.invoke(parser);
} catch (Exception e) {
System.err.println("NekoHTML HTML parser not found; HTML4 support disabled.");
}
}
if (document == null) {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
try { // http://www.w3.org/blog/systeam/2008/02/08/w3c_s_excessive_dtd_traffic
factory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
} catch (ParserConfigurationException e) {
System.err.println("Warning: Could not disable external DTD loading");
}
DocumentBuilder builder = factory.newDocumentBuilder();
document = builder.parse(filename);
}
return document;
}
public static void testEnum() throws Exception {
Builder b = new Builder();
b.addClasspath(new File("bin"));
b.setProperty("Export-Package", "test.metatype");
b.setProperty("-metatype", "*");
b.build();
assertEquals(0, b.getErrors().size());
assertEquals(0, b.getWarnings().size());
Resource r = b.getJar().getResource("OSGI-INF/metatype/test.metatype.MetatypeTest$Enums.xml");
IO.copy(r.openInputStream(), System.err);
Document d = db.parse(r.openInputStream());
assertEquals(
"http://www.osgi.org/xmlns/metatype/v1.1.0", d.getDocumentElement().getNamespaceURI());
Properties p = new Properties();
p.setProperty("r", "requireConfiguration");
p.setProperty("i", "ignoreConfiguration");
p.setProperty("o", "optionalConfiguration");
Enums enums = Configurable.createConfigurable(Enums.class, (Map<Object, Object>) p);
assertEquals(Enums.X.requireConfiguration, enums.r());
assertEquals(Enums.X.ignoreConfiguration, enums.i());
assertEquals(Enums.X.optionalConfiguration, enums.o());
}
/**
* Reads an XML document from an input source and copies its values into the specified object
*
* @param ob The object to receive the values
* @param source The location of the XML document
* @throws IOException If there is an error reading the document
*/
public void readObject(Object ob, InputSource source) throws IOException {
try {
// Create a document builder to read the document
DocumentBuilder builder = factory.newDocumentBuilder();
// Read the document
Document doc = builder.parse(source);
// Get the root element
Element element = doc.getDocumentElement();
// Copy the root element into the bean
readObject(ob, element);
} catch (SAXException exc) {
throw new IOException("Error parsing XML document: " + exc.toString());
} catch (ParserConfigurationException exc) {
throw new IOException("Error parsing XML document: " + exc.toString());
}
}
/**
* Marshall a Chromosome instance to an XML Document representation, including its contained Gene
* instances.
*
* @param a_subject the chromosome to represent as an XML document
* @return a Document object representing the given Chromosome
* @author Neil Rotstan
* @since 1.0
* @deprecated use XMLDocumentBuilder instead
*/
public static Document representChromosomeAsDocument(final IChromosome a_subject) {
// DocumentBuilders do not have to be thread safe, so we have to
// protect creation of the Document with a synchronized block.
// -------------------------------------------------------------
Document chromosomeDocument;
synchronized (m_lock) {
chromosomeDocument = m_documentCreator.newDocument();
}
Element chromosomeElement = representChromosomeAsElement(a_subject, chromosomeDocument);
chromosomeDocument.appendChild(chromosomeElement);
return chromosomeDocument;
}
/**
* Marshall a Genotype to an XML Document representation, including its population of Chromosome
* instances.
*
* @param a_subject the genotype to represent as an XML document
* @return a Document object representing the given Genotype
* @author Neil Rotstan
* @since 1.0
* @deprecated use XMLDocumentBuilder instead
*/
public static Document representGenotypeAsDocument(final Genotype a_subject) {
// DocumentBuilders do not have to be thread safe, so we have to
// protect creation of the Document with a synchronized block.
// -------------------------------------------------------------
Document genotypeDocument;
synchronized (m_lock) {
genotypeDocument = m_documentCreator.newDocument();
}
Element genotypeElement = representGenotypeAsElement(a_subject, genotypeDocument);
genotypeDocument.appendChild(genotypeElement);
return genotypeDocument;
}
public static void testADWithInheritance() throws Exception {
Builder b = new Builder();
b.addClasspath(new File("bin"));
b.setProperty("Export-Package", "test.metatype");
b.setProperty("-metatype", "*");
b.setProperty("-metatype-inherit", "true");
b.build();
Resource r =
b.getJar()
.getResource(
"OSGI-INF/metatype/test.metatype.MetatypeTest$TestADWithInheritanceChild.xml");
assertEquals(0, b.getErrors().size());
assertEquals(0, b.getWarnings().size());
System.err.println(b.getJar().getResources().keySet());
assertNotNull(r);
IO.copy(r.openInputStream(), System.err);
Document d = db.parse(r.openInputStream());
assertAD(
d, "fromChild", "From child", "fromChild", null, null, null, 0, "String", null, null, null);
assertAD(
d,
"fromSuperOne",
"From super one",
"fromSuperOne",
null,
null,
null,
0,
"String",
null,
null,
null);
assertAD(
d,
"fromSuperTwo",
"From super two",
"fromSuperTwo",
null,
null,
null,
0,
"String",
null,
null,
null);
}
public static void testSimple() throws Exception {
Builder b = new Builder();
b.addClasspath(new File("bin"));
b.setProperty("Export-Package", "test.metatype");
b.setProperty("-metatype", "*");
b.build();
Resource r =
b.getJar().getResource("OSGI-INF/metatype/test.metatype.MetatypeTest$TestSimple.xml");
assertEquals(0, b.getErrors().size());
assertEquals(0, b.getWarnings().size());
System.err.println(b.getJar().getResources().keySet());
assertNotNull(r);
IO.copy(r.openInputStream(), System.err);
Document d = db.parse(r.openInputStream());
assertEquals("TestSimple", xpath.evaluate("//OCD/@name", d));
assertEquals("simple", xpath.evaluate("//OCD/@description", d));
assertEquals("test.metatype.MetatypeTest$TestSimple", xpath.evaluate("//OCD/@id", d));
assertEquals("test.metatype.MetatypeTest$TestSimple", xpath.evaluate("//Designate/@pid", d));
assertEquals("test.metatype.MetatypeTest$TestSimple", xpath.evaluate("//Object/@ocdref", d));
assertEquals("simple", xpath.evaluate("//OCD/AD[@id='simple']/@id", d));
assertEquals("Simple", xpath.evaluate("//OCD/AD[@id='simple']/@name", d));
assertEquals("String", xpath.evaluate("//OCD/AD[@id='simple']/@type", d));
assertEquals("true", xpath.evaluate("//OCD/AD[@id='notSoSimple']/@required", d));
/**
* https://github.com/bndtools/bnd/issues/281
*
* <p>Using the Bnd annotations library (1.52.3), the generated metatype file will have
* required='false' for all fields annotated with @Meta.AD(). When this annotation is omitted,
* or when the required property is explicitly set, the field is correctly marked as required.
* Taking a glance at the code, the bug appears to be due to aQute.bnd.osgi.Annotation using
* aQute.bnd.annotation.metatype.Configurable internally for bridging Bnd-annotations to
* Java-annotations. This configurable only obtains the values from the Bnd-annotation, omitting
* the defaults defined in the Java annotation. The workaround is to explicitly mention the
* required property on each field annotated with @Meta.AD.
*/
assertEquals("true", xpath.evaluate("//OCD/AD[@id='simple']/@required", d));
assertEquals(
Integer.MAX_VALUE + "", xpath.evaluate("//OCD/AD[@id='notSoSimple']/@cardinality", d));
}
static void assertOCD(
Builder b,
String cname,
String id,
String name,
String description,
String designate,
boolean factory,
String localization)
throws Exception {
Resource r = b.getJar().getResource("OSGI-INF/metatype/" + cname + ".xml");
assertNotNull(r);
IO.copy(r.openInputStream(), System.err);
Document d = db.parse(r.openInputStream());
assertEquals(id, xpath.evaluate("//OCD/@id", d, XPathConstants.STRING));
assertEquals(name, xpath.evaluate("//OCD/@name", d, XPathConstants.STRING));
assertEquals(
localization == null ? cname : localization,
xpath.evaluate("//OCD/@localization", d, XPathConstants.STRING));
assertEquals(
description == null ? "" : description,
xpath.evaluate("//OCD/@description", d, XPathConstants.STRING));
if (designate == null) {
assertEquals(id, xpath.evaluate("//Designate/@pid", d, XPathConstants.STRING));
if (factory)
assertEquals(id, xpath.evaluate("//Designate/@factoryPid", d, XPathConstants.STRING));
} else {
assertEquals(designate, xpath.evaluate("//Designate/@pid", d, XPathConstants.STRING));
if (factory)
assertEquals(
designate, xpath.evaluate("//Designate/@factoryPid", d, XPathConstants.STRING));
}
assertEquals(id, xpath.evaluate("//Object/@ocdref", d, XPathConstants.STRING));
}
/** Forward to real factory, set error handler */
public DocumentBuilder newDocumentBuilder() throws ParserConfigurationException {
DocumentBuilder db = fact.newDocumentBuilder();
log.debug3("Created builder: " + db);
db.setErrorHandler(new MyErrorHandler());
return db;
}
/**
* Reads in an XML file and returns a Document object.
*
* @param file the file to be read in
* @throws IOException
* @throws SAXException
* @return Document
* @author Klaus Meffert
* @since 2.0
*/
public static Document readFile(File file) throws IOException, org.xml.sax.SAXException {
return m_documentCreator.parse(file);
}
public static void testAD() throws Exception {
Builder b = new Builder();
b.addClasspath(new File("bin"));
b.setProperty("Export-Package", "test.metatype");
b.setProperty("-metatype", "*");
b.build();
Resource r = b.getJar().getResource("OSGI-INF/metatype/test.metatype.MetatypeTest$TestAD.xml");
assertEquals(0, b.getErrors().size());
assertEquals(0, b.getWarnings().size());
System.err.println(b.getJar().getResources().keySet());
assertNotNull(r);
IO.copy(r.openInputStream(), System.err);
Document d = db.parse(r.openInputStream());
assertAD(
d,
"noSettings",
"No settings",
"noSettings",
null,
null,
null,
0,
"String",
null,
null,
null);
assertAD(d, "withId", "With id", "id", null, null, null, 0, "String", null, null, null);
assertAD(d, "name", "name", "withName", null, null, null, 0, "String", null, null, null);
assertAD(d, "withMax", "With max", "withMax", null, "1", null, 0, "String", null, null, null);
assertAD(d, "withMin", "With min", "withMin", "-1", null, null, 0, "String", null, null, null);
assertAD(d, "withC1", "With c1", "withC1", null, null, null, 1, "String", null, null, null);
assertAD(
d, "withC0", "With c0", "withC0", null, null, null, 2147483647, "String", null, null, null);
assertAD(d, "withC_1", "With c 1", "withC.1", null, null, null, -1, "String", null, null, null);
assertAD(
d,
"withC_1ButArray",
"With c 1 but array",
"withC.1ButArray",
null,
null,
null,
-1,
"String",
null,
null,
null);
assertAD(
d,
"withC1ButCollection",
"With c1 but collection",
"withC1ButCollection",
null,
null,
null,
1,
"String",
null,
null,
null);
assertAD(d, "withInt", "With int", "withInt", null, null, null, 0, "String", null, null, null);
assertAD(
d,
"withString",
"With string",
"withString",
null,
null,
null,
0,
"Integer",
null,
null,
null);
assertAD(
d, "a", "A", "a", null, null, null, 0, "String", "description_xxx\"xxx'xxx", null, null);
assertAD(
d,
"valuesOnly",
"Values only",
"valuesOnly",
null,
null,
null,
0,
"String",
null,
new String[] {"a", "b"},
new String[] {"a", "b"});
assertAD(
d,
"labelsAndValues",
"Labels and values",
"labelsAndValues",
null,
null,
null,
0,
"String",
null,
new String[] {"a", "b"},
new String[] {"A", "A"});
}
public static void testNaming() throws Exception {
Map<String, Object> map = Create.map();
map.put("_secret", "_secret");
map.put("_secret", "_secret");
map.put(".secret", ".secret");
map.put("$new", "$new");
map.put("new", "new");
map.put("secret", "secret");
map.put("a_b_c", "a_b_c");
map.put("a.b.c", "a.b.c");
map.put(".a_b", ".a_b");
map.put("$$$$a_b", "$$$$a_b");
map.put("$$$$a.b", "$$$$a.b");
map.put("a", "a");
map.put("a$", "a$");
map.put("a$$", "a$$");
map.put("a$.$", "a$.$");
map.put("a$_$", "a$_$");
map.put("a..", "a..");
map.put("noid", "noid");
map.put("nullid", "nullid");
Naming trt = Configurable.createConfigurable(Naming.class, map);
// By name
assertEquals("secret", trt.secret());
assertEquals("_secret", trt.__secret());
assertEquals(".secret", trt._secret());
assertEquals("new", trt.$new());
assertEquals("$new", trt.$$new());
assertEquals("a.b.c", trt.a_b_c());
assertEquals("a_b_c", trt.a__b__c());
assertEquals(".a_b", trt._a__b());
assertEquals("$$$$a.b", trt.$$$$$$$$a_b());
assertEquals("$$$$a_b", trt.$$$$$$$$a__b());
assertEquals("a", trt.a$());
assertEquals("a$", trt.a$$());
assertEquals("a$", trt.a$$$());
assertEquals("a$.$", trt.a$$_$$());
assertEquals("a$_$", trt.a$$__$$());
assertEquals("a..", trt.a_$_());
assertEquals("noid", trt.noid());
assertEquals("nullid", trt.nullid());
// By AD
assertEquals("secret", trt.xsecret());
assertEquals("_secret", trt.x__secret());
assertEquals(".secret", trt.x_secret());
assertEquals("new", trt.x$new());
assertEquals("$new", trt.x$$new());
assertEquals("a.b.c", trt.xa_b_c());
assertEquals("a_b_c", trt.xa__b__c());
assertEquals(".a_b", trt.x_a__b());
assertEquals("$$$$a.b", trt.x$$$$$$$$a_b());
assertEquals("$$$$a_b", trt.x$$$$$$$$a__b());
assertEquals("a", trt.xa$());
assertEquals("a$", trt.xa$$());
assertEquals("a$", trt.xa$$$());
assertEquals("a$.$", trt.xa$$_$$());
Builder b = new Builder();
b.addClasspath(new File("bin"));
b.setProperty("Export-Package", "test.metatype");
b.setProperty("-metatype", "*");
b.build();
assertEquals(0, b.getErrors().size());
assertEquals(0, b.getWarnings().size());
Resource r = b.getJar().getResource("OSGI-INF/metatype/test.metatype.MetatypeTest$Naming.xml");
IO.copy(r.openInputStream(), System.err);
Document d = db.parse(r.openInputStream(), "UTF-8");
assertEquals(
"http://www.osgi.org/xmlns/metatype/v1.1.0", d.getDocumentElement().getNamespaceURI());
}
public static void testReturnTypes() throws Exception {
Builder b = new Builder();
b.addClasspath(new File("bin"));
b.setProperty("Export-Package", "test.metatype");
b.setProperty("-metatype", "*");
b.build();
Resource r =
b.getJar().getResource("OSGI-INF/metatype/test.metatype.MetatypeTest$TestReturnTypes.xml");
assertEquals(0, b.getErrors().size());
assertEquals(0, b.getWarnings().size());
System.err.println(b.getJar().getResources().keySet());
assertNotNull(r);
IO.copy(r.openInputStream(), System.err);
Document d = db.parse(r.openInputStream());
assertEquals(
"http://www.osgi.org/xmlns/metatype/v1.1.0", d.getDocumentElement().getNamespaceURI());
// Primitives
assertEquals("Boolean", xpath.evaluate("//OCD/AD[@id='rpBoolean']/@type", d));
assertEquals("Byte", xpath.evaluate("//OCD/AD[@id='rpByte']/@type", d));
assertEquals("Character", xpath.evaluate("//OCD/AD[@id='rpCharacter']/@type", d));
assertEquals("Short", xpath.evaluate("//OCD/AD[@id='rpShort']/@type", d));
assertEquals("Integer", xpath.evaluate("//OCD/AD[@id='rpInt']/@type", d));
assertEquals("Long", xpath.evaluate("//OCD/AD[@id='rpLong']/@type", d));
assertEquals("Float", xpath.evaluate("//OCD/AD[@id='rpFloat']/@type", d));
assertEquals("Double", xpath.evaluate("//OCD/AD[@id='rpDouble']/@type", d));
// Primitive Wrappers
assertEquals("Boolean", xpath.evaluate("//OCD/AD[@id='rBoolean']/@type", d));
assertEquals("Byte", xpath.evaluate("//OCD/AD[@id='rByte']/@type", d));
assertEquals("Character", xpath.evaluate("//OCD/AD[@id='rCharacter']/@type", d));
assertEquals("Short", xpath.evaluate("//OCD/AD[@id='rShort']/@type", d));
assertEquals("Integer", xpath.evaluate("//OCD/AD[@id='rInt']/@type", d));
assertEquals("Long", xpath.evaluate("//OCD/AD[@id='rLong']/@type", d));
assertEquals("Float", xpath.evaluate("//OCD/AD[@id='rFloat']/@type", d));
assertEquals("Double", xpath.evaluate("//OCD/AD[@id='rDouble']/@type", d));
// Primitive Arrays
assertEquals("Boolean", xpath.evaluate("//OCD/AD[@id='rpaBoolean']/@type", d));
assertEquals("Byte", xpath.evaluate("//OCD/AD[@id='rpaByte']/@type", d));
assertEquals("Character", xpath.evaluate("//OCD/AD[@id='rpaCharacter']/@type", d));
assertEquals("Short", xpath.evaluate("//OCD/AD[@id='rpaShort']/@type", d));
assertEquals("Integer", xpath.evaluate("//OCD/AD[@id='rpaInt']/@type", d));
assertEquals("Long", xpath.evaluate("//OCD/AD[@id='rpaLong']/@type", d));
assertEquals("Float", xpath.evaluate("//OCD/AD[@id='rpaFloat']/@type", d));
assertEquals("Double", xpath.evaluate("//OCD/AD[@id='rpaDouble']/@type", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='rpaBoolean']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='rpaByte']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='rpaCharacter']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='rpaShort']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='rpaInt']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='rpaLong']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='rpaFloat']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='rpaDouble']/@cardinality", d));
// Wrapper + Object arrays
assertEquals("Boolean", xpath.evaluate("//OCD/AD[@id='raBoolean']/@type", d));
assertEquals("Byte", xpath.evaluate("//OCD/AD[@id='raByte']/@type", d));
assertEquals("Character", xpath.evaluate("//OCD/AD[@id='raCharacter']/@type", d));
assertEquals("Short", xpath.evaluate("//OCD/AD[@id='raShort']/@type", d));
assertEquals("Integer", xpath.evaluate("//OCD/AD[@id='raInt']/@type", d));
assertEquals("Long", xpath.evaluate("//OCD/AD[@id='raLong']/@type", d));
assertEquals("Float", xpath.evaluate("//OCD/AD[@id='raFloat']/@type", d));
assertEquals("Double", xpath.evaluate("//OCD/AD[@id='raDouble']/@type", d));
assertEquals("String", xpath.evaluate("//OCD/AD[@id='raString']/@type", d));
assertEquals("String", xpath.evaluate("//OCD/AD[@id='raURI']/@type", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raBoolean']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raByte']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raCharacter']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raShort']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raInt']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raLong']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raFloat']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raDouble']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raString']/@cardinality", d));
assertEquals("2147483647", xpath.evaluate("//OCD/AD[@id='raURI']/@cardinality", d));
// Wrapper + Object collections
assertEquals("Boolean", xpath.evaluate("//OCD/AD[@id='rBooleans']/@type", d));
assertEquals("Byte", xpath.evaluate("//OCD/AD[@id='rBytes']/@type", d));
assertEquals("Character", xpath.evaluate("//OCD/AD[@id='rCharacter']/@type", d));
assertEquals("Short", xpath.evaluate("//OCD/AD[@id='rShorts']/@type", d));
assertEquals("Integer", xpath.evaluate("//OCD/AD[@id='rInts']/@type", d));
assertEquals("Long", xpath.evaluate("//OCD/AD[@id='rLongs']/@type", d));
assertEquals("Float", xpath.evaluate("//OCD/AD[@id='rFloats']/@type", d));
assertEquals("Double", xpath.evaluate("//OCD/AD[@id='rDoubles']/@type", d));
assertEquals("String", xpath.evaluate("//OCD/AD[@id='rStrings']/@type", d));
assertEquals("String", xpath.evaluate("//OCD/AD[@id='rURIs']/@type", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rBooleans']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rBytes']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rCharacters']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rShorts']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rInts']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rLongs']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rFloats']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rDoubles']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rStrings']/@cardinality", d));
assertEquals("-2147483648", xpath.evaluate("//OCD/AD[@id='rURIs']/@cardinality", d));
}
