org.soulwing.cas.extension.AbstractResourceParser 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 Mar 5, 2015 
 *
 * Copyright (c) 2014 Virginia Polytechnic Institute and State University
 *
 * 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.extension;

import java.util.ArrayList;
import java.util.Deque;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

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

import org.jboss.as.controller.PathAddress;
import org.jboss.as.controller.descriptions.ModelDescriptionConstants;
import org.jboss.as.server.deployment.AttachmentKey;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.Property;

/**
 * An abstract base for {@link ResourceParser} implementations.
 *
 * @author Carl Harris
 */
public abstract class AbstractResourceParser implements ResourceParser {

  private final ResourceReader delegate;
  
  private final Deque> opStack = new LinkedList<>();
  
  private final Deque stack = new LinkedList<>();
  
  private final Map, Object> attachments = new HashMap<>();
  
  private List ops;

  /**
   * Constructs a new instance.
   * @param delegate
   */
  protected AbstractResourceParser(ResourceReader delegate) {
    this.delegate = delegate;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void readElement(XMLStreamReader reader,
      List ops) throws XMLStreamException {

    this.ops = ops;
    push(delegate);
    init();
    
    while (reader.hasNext()) {
      switch (reader.next()) {
        case START_ELEMENT:   
          peek().startElement(reader, reader.getNamespaceURI(), 
              reader.getLocalName());
          break;
          
        case END_ELEMENT:
          peek().endElement(reader, reader.getNamespaceURI(), 
              reader.getLocalName());
          break;
          
        case CHARACTERS:
          peek().characters(reader, reader.getText());
          break;
          
        default:
          assert true;  // just ignore it
      }
    }
  }

  /**
   * Allow a subclass to perform its own initialization.
   * 
   * Typically, a subsystem parser will use this callback to add an operation
   * that adds the subsystem to the management model.  The default 
   * implementation does nothing.
   */
  protected void init() {
  }

  private ResourceReader peek() {
    if (stack.isEmpty()) {
      throw new RuntimeException("stack underflow");
    }
    return stack.peek();
  }
  
  @Override
  public void push(ResourceReader reader) {
    reader.init(this);
    stack.push(reader);

    List ops = new ArrayList<>();
    if (!opStack.isEmpty()) {
      ops.addAll(opStack.peek());
    }
    opStack.push(ops);

  }

  @Override
  public void pop() {
    stack.pop();
    opStack.pop();
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void unexpectedElement(XMLStreamReader reader)
      throws XMLStreamException {
    throw new XMLStreamException("unexpected element {"
        + reader.getNamespaceURI() + "}" + reader.getLocalName());
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void unexpectedEndElement(XMLStreamReader reader)
      throws XMLStreamException {
    throw new XMLStreamException("unexpected end element {"
        + reader.getNamespaceURI() + "}" + reader.getLocalName());
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void unexpectedAttribute(XMLStreamReader reader, int index)
      throws XMLStreamException {
    throw new XMLStreamException("unexpected attribute {"
        + reader.getAttributeNamespace(index) + "}"
        + reader.getAttributeLocalName(index));
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void missingAttributes(XMLStreamReader reader, Set names)
      throws XMLStreamException {
    throw new XMLStreamException("missing attributes: " + names);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void duplicateAttribute(XMLStreamReader reader, String name)
      throws XMLStreamException {
    throw new XMLStreamException("duplicate attribute " + name);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void addOperation(ModelNode op, String type, String name) {
    PathAddress addr = PathAddress.pathAddress();
    List ops = opStack.peek();
    if (!ops.isEmpty()) {
      ModelNode parent = ops.get(ops.size() - 1);    
      for (ModelNode node : 
        parent.get(ModelDescriptionConstants.OP_ADDR).asList()) {
        Property property = node.asProperty();
        addr = addr.append(property.getName(), property.getValue().asString());
      }
    }
    
    addr = addr.append(type, name);
    op.get(ModelDescriptionConstants.OP_ADDR).set(addr.toModelNode());
    this.ops.add(op);
    opStack.peek().add(op);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public ModelNode lastOperation() {
    return ops.get(ops.size() - 1);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public  T getAttachment(AttachmentKey key) {
    return key.cast(attachments.get(key));
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public  T putAttachment(AttachmentKey key, T value) {
    return key.cast(attachments.put(key, value));
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public  T removeAttachment(AttachmentKey key) {
    return key.cast(attachments.remove(key));
  }
 
}