org.soulwing.cas.deployment.AbstractDescriptorReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cas-subsystem Show documentation
Wildfly subsystem that monitors web application deployments and attaches CAS authentication support.
There is a newer version: 2.0.3
/*
 * File created on Dec 22, 2014 
 *
 * Copyright (c) 2015 Carl Harris, Jr.
 *
 * 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 org.soulwing.cas.deployment;

import java.util.Arrays;
import java.util.List;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;

import org.soulwing.cas.extension.Names;

/**
 * An abstract base for {@link DescriptorReader} implementations.
 *
 * @author Carl Harris
 */
abstract class AbstractDescriptorReader implements DescriptorReader {

  private final String namespaceUri;
  private final String localName;
  private final List children;
  
  protected DescriptorParser parser;
  
  /**
   * Constructs a new instance.
   * @param localName
   * @param children
   */
  public AbstractDescriptorReader(String localName,
      AbstractDescriptorReader... children) {
    this(Names.NAMESPACE, localName, children);
  }

  /**
   * Constructs a new instance.
   * @param parser
   * @param namespaceUri
   * @param localName
   */
  public AbstractDescriptorReader(String namespaceUri, String localName, 
      AbstractDescriptorReader... children) {
    this.namespaceUri = namespaceUri;
    this.localName = localName;
    this.children = Arrays.asList(children);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void init(DescriptorParser parser) {
    this.parser = parser;
  }

  /**
   * Tests whether this reader supports a given element.
   * @param namespaceUri namespace of the element
   * @param localName local name of the element
   * @return {@code true} if this reader can handle the specified element
   */
  protected boolean supports(String namespaceUri, String localName) {
    return this.namespaceUri.equals(namespaceUri)
        && this.localName.equals(localName);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void startElement(XMLStreamReader reader, String namespaceUri,
      String localName, AppConfiguration config) throws XMLStreamException {
    for (AbstractDescriptorReader child : children) {
      if (child.supports(namespaceUri, localName)) {
        parser.push(child);
        child.attributes(reader, config);
        return;
      }
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void endElement(XMLStreamReader reader, String namespaceUri,
      String localName, AppConfiguration config) throws XMLStreamException {
    if (!this.namespaceUri.equals(namespaceUri)
        && this.localName.equals(localName)) {
      throw new XMLStreamException("unexpected end element", 
          reader.getLocation());
    }
    
    parser.pop();
  }

  /**
   * Notifies the recipient of attributes associated with the start element.
   * @param reader XML stream being parsed
   * @param text character data parsed from the XML stream
   * @param config application configuration
   * @throws XMLStreamException
   */
  protected void attributes(XMLStreamReader reader, AppConfiguration config)
      throws XMLStreamException {
    if (reader.getAttributeCount() > 0) {
      throw new XMLStreamException("unexpected attributes(s)", 
          reader.getLocation());
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void characters(XMLStreamReader reader,
      AppConfiguration config) throws XMLStreamException {
    if (!reader.getText().trim().isEmpty()) {
      throw new XMLStreamException("unexpected text", reader.getLocation());
    }
  }

}