Přeskočit na hlavní obsah

Jak na xs:anyURI v JAXB

Při práci s JAXB (Java API for XML Binding) jsem narazili na zajímavou chybu při unmarshalování. Jestliže byl typ XML elementu xs:anyURI a hodnota obsahovala na začátku, či konci mezery např.

<test:Config xmlns:test="http://www.mycompany.com/test/">
  <test:MyServiceUri>
    http://www.myserver.com/myService
  </test:MyServiceUri>
</test:Config>

pak navzdory tomu, že to bylo validní vůči dané XML Schema instanci, unmarshalovaná hodnota tohoto elementu byla null v případě cílového typu java.net.URI a nebo obsahovala i ony nežádoucí mezery v případě cílového typu String.

Takže první krok k vyřešení problému bylo nahlášení chyby do Issue trackeru JAXB RI a pak nezbývalo než hledat, jak to ošetřit na mé straně než bude vydána opravená verze JAXB. Nakonec jsem použil workaround, v němž vstupní XML soubor (String, InputStream, apod.) načtu se zapnutou validací jako DOM a teprve ten předám k unmarshalování. Nechtěné mezery v DOMu mizí jako zázrakem.

Tento workaround funguje bohužel jen při použití Java 6 - vypadá to, že od Java 5 soudruzi ze Sunu (blahé paměti) zdařile pohnuli s XML parserem. (Takže by mohlo stačit i endorsovat novější XML Parser do Javy 5.)

V reálném nasazení je většinou nutné udělat i nějaké ošetření stavu, kdy vstupní dokument validní není, ale obsahuje jen malou chybku, kterou Unmarshaller hravě zvládne vyřešit (např. přehozené dva elementy). Na tyto případy jsem se osobně rozhodl rezignovat a počkám si až bude oficiálně vydaná oprava přímo v JAXB RI.

A když to vezmeme prakticky, pak to vypadá následovně. Potřebujeme XML Schema, vůči kterému vstupní dokument validujeme:

<xs:schema targetNamespace="http://www.mycompany.com/test/"
 xmlns:test="http://www.mycompany.com/test/" xmlns:xs="http://www.w3.org/2001/XMLSchema"
 elementFormDefault="qualified">

 <xs:element name="Config">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="MyServiceUri" type="xs:anyURI" />
   </xs:sequence>
  </xs:complexType>
 </xs:element>
</xs:schema>

Z toho vygenerujeme pomocí XJC výsledný typ:


@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
    "myServiceUri"
})
@XmlRootElement(name = "Config")
public class Config {

    @XmlElement(name = "MyServiceUri", required = true)
    @XmlSchemaType(name = "anyURI")
    protected String myServiceUri;

    public String getMyServiceUri() {
        return myServiceUri;
    }

    public void setMyServiceUri(String value) {
        this.myServiceUri = value;
    }
}

A teď jen ono magické načítání:

public static void main(String[] args) throws Exception {
 final Schema schema = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI).newSchema(
   new File("test.xsd"));
 final File xmlFile = new File("test.xml");
 
 final Unmarshaller unmarshaller = JAXBContext.newInstance(Config.class.getPackage().getName())
   .createUnmarshaller();
 unmarshaller.setSchema(schema);
 
 // unmarshall XML File directly - there's the bug
 final Config configFromFile = (Config) unmarshaller.unmarshal(xmlFile);
 System.out.println("Service URI when unmarshalled from File: '" + configFromFile.getMyServiceUri() + "'");
 
 // load file to DOM (with validation enabled)
 DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
 dbf.setSchema(schema);
 dbf.setNamespaceAware(true);
 Document doc = dbf.newDocumentBuilder().parse(xmlFile);
 
 // unmarshall DOM
 Config configFromDom = (Config) unmarshaller.unmarshal(doc);
 System.out.println("Service URI when unmarshalled from DOM: '" + configFromDom.getMyServiceUri() + "'");
}

Což by mělo vytisknout:

Service URI when unmarshalled from File: '
    http://www.myserver.com/myService
  '
Service URI when unmarshalled from DOM: 'http://www.myserver.com/myService'

Chybu a workaround si můžete vyzkoušet v přiloženém Java projektu.

Komentáře

Lukáš Křečan píše…
Už dlouhou dobu zvažuji, jestli je JAX-WS RI vhodné k produkčnímu použití. Z mnoha důvodů to na mě působí jako pěkný hobby projekt, ale ne jako něco, co by bylo vhodné nasadit na ostrý server.
Lukáš Křečan píše…
Jo a teď jsem si uvědomil, že pláču na špatném hrobě. S JAXB jsem dosud problém neměl, takže je to pro mě docela novinka.
Josef Cacek píše…
JAX-WS RI používáme a občas je to opravdu drbání levou rukou za pravým uchem. Nicméně použitelné to očividně je (musí!) i pro produkční nasazení. :-)

Populární příspěvky z tohoto blogu

Three ways to redirect HTTP requests to HTTPs in WildFly and JBoss EAP

WildFly application server (and JBoss EAP) supports several simple ways how to redirect the communication from plain HTTP to TLS protected HTTPs. This article presents 3 ways. Two are on the application level and the last one is on the server level valid for requests to all deployments. 1. Request confidentiality in the deployment descriptor The first way is based on the Servlet specification. You need to specify which URLs should be protected in the web.xml deployment descriptor. It's the same approach as the one used for specifying which URLs require authentication/authorization. Just instead of requesting an assigned role, you request a transport-guarantee . Sample content of the WEB-INF/web.xml <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1

Zipujeme efektivně

Jedna ze základních vlastností Javy je práce se ZIP archívy, ať už jsou to knihovny tříd a spustitelné JARy, webové aplikace (war), nebo třeba JEE bumbrlíčci (ear). Není tedy divu, že i přímo v základním API je implementována práce s těmito archívy. Slouží k tomu třídy v balíku java.util.zip a nejzajímavější z nich jsou ZipOutputStream a ZipInputStream. Příkladem budiž vytvoření zipu: //Vytvorime Zip ZipOutputStream zos = new ZipOutputStream(new FileOutputStream("javlog.zip")); //V Zipu chceme mit jeden textovy soubor zos.putNextEntry(new ZipEntry("priznani.txt")); //naplnime obsah textoveho souboru zos.write("Máme rádi Javu!".getBytes()); //zavrem entry (priznani.txt) zos.closeEntry(); //zavrem stream zos.close(); a jeho rozbalení: ZipInputStream zis = new ZipInputStream(new FileInputStream("javlog.zip")); ZipEntry zipEntry; //budem predpokladat, ze v ZIPu mame jen textove soubory a tak je vypisem do konzole while ((zipEntry = zis.getNextE

Simple TLS certificates in WildFly 18

It's just 2 weeks when WildFly 18 was released. It includes nice improvements in TLS certificates handling through ACME protocol (Automatic Certificate Management Environment), it greatly simplifies obtaining valid HTTPS certificates. There was already a support for the Let's Encrypt CA in WildFly 14 as Farah Juma described in her blog post last year. New WildFly version allows using other CA-s with ACME protocol support. It also adds new switch --lets-encrypt to interactive mode of security enable-ssl-http-server JBoss CLI commands. Let's try it. Before we jump on WildFly configuration, let's just mention the HTTPs can be used even in the default configuration and a self-signed certificate is generated on the fly. Nevertheless, it's not secure and you should not use it for any other purpose than testing. Use Let's Encrypt signed certificate for HTTPs application interface Start WildFly on a machine with the public IP address. Run it on the defaul