org.eclipse.jetty.ee9.webapp.Descriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-ee9-webapp Show documentation
Jetty web application support
The newest version!
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.ee9.webapp;

import java.io.IOException;
import java.io.InputStream;
import java.util.Objects;

import org.eclipse.jetty.io.IOResources;
import org.eclipse.jetty.util.resource.Resource;
import org.eclipse.jetty.xml.XmlParser;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;

public abstract class Descriptor
{
    private static final Logger LOG = LoggerFactory.getLogger(Descriptor.class);

    protected Resource _xml;
    protected XmlParser.Node _root;
    protected String _dtd;

    public Descriptor(Resource resource)
    {
        _xml = Objects.requireNonNull(resource, "Resource must not be null");
        if (_xml.isDirectory())
            throw new IllegalArgumentException("Descriptor cannot be a directory");
    }

    public void parse(XmlParser parser)
        throws Exception
    {
        if (_root == null)
        {
            Objects.requireNonNull(parser);
            try (InputStream is = IOResources.asInputStream(_xml))
            {
                _root = parser.parse(is);
                _dtd = parser.getDTD();
            }
            catch (SAXException | IOException e)
            {
                LOG.warn("Unable to parse {}", _xml, e);
                throw e;
            }
        }
    }

    public String getURI()
    {
        return _xml.getURI().toASCIIString();
    }

    public Resource getResource()
    {
        return _xml;
    }

    public XmlParser.Node getRoot()
    {
        return _root;
    }

    @Override
    public String toString()
    {
        return this.getClass().getSimpleName() + "(" + getURI() + ")";
    }
}