de.smartics.maven.plugin.jboss.modules.parser.ModulesXmlParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smartics-jboss-modules-maven-plugin Show documentation
Generates an archive of modules based on information in a POM to be copied to an JBoss 7 installation.
The newest version!
/*
 * Copyright 2013-2018 smartics, Kronseder & Reiner GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.smartics.maven.plugin.jboss.modules.parser;

import java.io.IOException;
import java.io.InputStream;

import org.jdom2.Document;
import org.jdom2.JDOMException;
import org.jdom2.input.SAXBuilder;

import de.smartics.maven.plugin.jboss.modules.descriptor.ModulesDescriptor;
import de.smartics.maven.plugin.jboss.modules.util.Arg;

/**
 * Parses a modules XML document.
 */
public final class ModulesXmlParser
{
  // ********************************* Fields *********************************

  // --- constants ------------------------------------------------------------

  // --- members --------------------------------------------------------------

  /**
   * Builder of JDOM documents.
   */
  private final SAXBuilder builder;

  // ****************************** Initializer *******************************

  // ****************************** Constructors ******************************

  /**
   * Default constructor.
   */
  public ModulesXmlParser()
  {
    this.builder = new SAXBuilder();
  }

  // ****************************** Inner Classes *****************************

  // ********************************* Methods ********************************

  // --- init -----------------------------------------------------------------

  // --- get&set --------------------------------------------------------------

  // --- business -------------------------------------------------------------

  /**
   * Parses the given document from the stream.
   *
   * @param systemId the identifier of the XML document for error handling and
   *          link resolution.
   * @param input the stream to parse the modules XML document.
   * @return the descriptors found in a given document.
   * @throws NullPointerException if {@code input} or {@code systemId} is
   *           null.
   * @throws IllegalArgumentException if {@code systemId} is blank.
   * @throws JDOMException when errors occur in parsing
   * @throws IOException when an I/O error prevents a document from being fully
   *           parsed
   */
  public ModulesDescriptor parse(final String systemId, final InputStream input)
    throws NullPointerException, IllegalArgumentException, JDOMException,
    IOException
  {
    final Document document =
        builder.build(Arg.checkNotNull("input", input),
            Arg.checkNotBlank("systemId", systemId));
    ModulesDescriptor rc=null;
    if( document.getRootElement().getNamespace() == ModulesDescriptorBuilderV2.NS ) {
        rc = new ModulesDescriptorBuilderV2(systemId, document).build();
    } else {
        rc = new ModulesDescriptorBuilder(systemId, document).build();
    }

    return rc;
  }

  // --- object basics --------------------------------------------------------

}