SimpleMapAttributeDefinition

/*
 * Copyright 2013 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.properties.jboss.extension.resources.util;

import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

import org.jboss.as.controller.MapAttributeDefinition;
import org.jboss.as.controller.descriptions.ModelDescriptionConstants;
import org.jboss.as.controller.descriptions.ResourceDescriptionResolver;
import org.jboss.as.controller.operations.validation.ModelTypeValidator;
import org.jboss.as.controller.operations.validation.ParameterValidator;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.ModelType;
import org.jboss.dmr.Property;

/**
 * A map of simple map values.
 */
public final class SimpleMapAttributeDefinition extends MapAttributeDefinition
{
  // ********************************* Fields *********************************

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

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

  /**
   * The name of the XML element that encloses the items named by
   * {@link #xmlName}.
   */
  private final String wrapperXmlName;

  /**
   * The name of the XML attribute that references the type name.
   */
  private final String xmlAttributeName;

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

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

  /**
   * Default constructor.
   *
   * @param wrapperXmlName the name of the XML element that encloses the items
   *          named by {@link #xmlName}.
   * @param name the name of the map attribute.
   * @param xmlName the name of the XML element.
   * @param xmlAttributeName the name of the XML attribute that references the
   *          type name.
   * @param allowNull the flag to mark the attribute containing the tuples as
   *          optional ( <code>true</code>) or mandatory (<code>false</code>).
   * @param elementValidator the validator of the tuple values.
   */
  private SimpleMapAttributeDefinition(final String wrapperXmlName,
      final String name, final String xmlName, final String xmlAttributeName,
      final boolean allowNull, final ParameterValidator elementValidator)
  {
    super(name, xmlName, allowNull, 0, Integer.MAX_VALUE, elementValidator,
        null, null);
    this.wrapperXmlName = wrapperXmlName;
    this.xmlAttributeName = xmlAttributeName;
  }

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

  /**
   * Builds instances of {@link SimpleMapAttributeDefinition}.
   */
  public static final class Builder
  {
    // ******************************** Fields ********************************

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

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

    /**
     * The name of the XML element that encloses the items named by
     * {@link #xmlName}.
     */
    private String wrapperXmlName;

    /**
     * The name of the map attribute.
     */
    private String name;

    /**
     * The name of the XML element where the attribute is the key and the
     * contents is the value.
     */
    private String xmlName;

    /**
     * The name of the XML attribute that references the type name.
     */
    private String xmlAttributeName;

    /**
     * The type of the value.
     */
    private ModelType type;

    /**
     * The flag to mark the attribute containing the tuples as optional (
     * <code>true</code>) or mandatory (<code>false</code>).
     */
    private boolean allowNull;

    /**
     * Flag to mark the value being allowed to contain expressions.
     */
    private boolean allowExpression;

    /**
     * The validator for values.
     */
    private ParameterValidator validator;

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

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

    /**
     * Default constructor.
     */
    public Builder()
    {
    }

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

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

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

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

    /**
     * Sets the name of the XML element that encloses the items named by
     * {@link #setXmlName() xmlName}.
     *
     * @param wrapperXmlName the name of the XML element that encloses the items
     *          named by {@link #setXmlName() xmlName}.
     * @return a reference to this builder.
     */
    public Builder withWrapperXmlName(final String wrapperXmlName)
    {
      this.wrapperXmlName = wrapperXmlName;
      return this;
    }

    /**
     * Sets the name of the map attribute.
     *
     * @param name the name of the attribute.
     * @return a reference to this builder.
     */
    public Builder withName(final String name)
    {
      this.name = name;
      return this;
    }

    /**
     * Sets the name of the XML element where the attribute is the key and the
     * contents is the value.
     *
     * @param xmlName the name of the XML element where the attribute is the key
     *          and the contents is the value.
     * @return a reference to this builder.
     */
    public Builder withXmlName(final String xmlName)
    {
      this.xmlName = xmlName;
      return this;
    }

    /**
     * Sets the name of the XML attribute that references the type name.
     *
     * @param xmlAttributeName the name of the XML attribute that references the
     *          type name.
     * @return a reference to this builder.
     */
    public Builder withXmlAttributeName(final String xmlAttributeName)
    {
      this.xmlAttributeName = xmlAttributeName;
      return this;
    }

    /**
     * Sets the type of the value.
     *
     * @param type the type of the value.
     * @return a reference to this builder.
     */
    public Builder withType(final ModelType type)
    {
      this.type = type;
      return this;
    }

    /**
     * Sets the flag to mark the attribute containing the tuples as optional (
     * <code>true</code>) or mandatory (<code>false</code>).
     *
     * @param allowNull the flag to mark the attribute containing the tuples as
     *          optional ( <code>true</code>) or mandatory (<code>false</code>).
     * @return a reference to this builder.
     */
    public Builder withAllowNull(final boolean allowNull)
    {
      this.allowNull = allowNull;
      return this;
    }

    /**
     * Sets the value for allowExpression.
     * <p>
     * Flag to mark the value being allowed to contain expressions.
     *
     * @param allowExpression the value for allowExpression.
     * @return a reference to this builder.
     */
    public Builder withAllowExpression(final boolean allowExpression)
    {
      this.allowExpression = allowExpression;
      return this;
    }

    /**
     * Sets the validator for values.
     *
     * @param validator the validator for values.
     * @return a reference to this builder.
     */
    public Builder withValidator(final ParameterValidator validator)
    {
      this.validator = validator;
      return this;
    }

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

    /**
     * Creates the instance.
     *
     * @return the instance.
     */
    public SimpleMapAttributeDefinition build()
    {
      if (type == null)
      {
        type = ModelType.STRING;
      }
      if (xmlAttributeName == null)
      {
        xmlAttributeName = "type";
      }

      if (validator == null)
      {
        validator = new ModelTypeValidator(type, allowNull, allowExpression);
      }

      return new SimpleMapAttributeDefinition(wrapperXmlName, name, xmlName,
          xmlAttributeName, allowNull, validator);
    }

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

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

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

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

  /**
   * Returns the name of the XML element that encloses the items named by
   * {@link #getXmlName() xmlName}.
   *
   * @return the name of the XML element that encloses the items named by
   *         {@link #getXmlName() xmlName}.
   */
  public String getWrapperXmlName()
  {
    return wrapperXmlName;
  }

  /**
   * Returns the name of the XML attribute that references the type name.
   *
   * @return the name of the XML attribute that references the type name.
   */
  public String getXmlAttributeName()
  {
    return xmlAttributeName;
  }

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

  @Override
  protected void addValueTypeDescription(final ModelNode node,
      final ResourceBundle bundle)
  {
    setValueType(node);
  }

  @Override
  protected void addAttributeValueTypeDescription(final ModelNode result,
      final ResourceDescriptionResolver resolver, final Locale locale,
      final ResourceBundle bundle)
  {
    setValueType(result);
  }

  @Override
  protected void addOperationParameterValueTypeDescription(
      final ModelNode result, final String operationName,
      final ResourceDescriptionResolver resolver, final Locale locale,
      final ResourceBundle bundle)
  {
    setValueType(result);
  }

  void setValueType(final ModelNode node)
  {
    node.get(ModelDescriptionConstants.VALUE_TYPE).set(ModelType.STRING);
    if (isAllowExpression())
    {
      node.get(ModelDescriptionConstants.EXPRESSIONS_ALLOWED).set(
          new ModelNode(true));
    }
  }

  @Override
  public void marshallAsElement(final ModelNode resourceModel,
      final XMLStreamWriter writer) throws XMLStreamException
  {
    final String modelName = getName();
    final ModelNode mapModel = resourceModel.get(modelName);
    writer.writeStartElement(wrapperXmlName == null ? modelName
        : wrapperXmlName);

    for (final ModelNode listNode : mapModel.asList())
    {
      final Property property = listNode.asProperty();
      writer.writeStartElement(getXmlName());
      writer.writeAttribute(xmlAttributeName, property.getName());
      writer.writeCharacters(property.getValue().asString());
      writer.writeEndElement();
    }

    writer.writeEndElement();
  }

  public Map<String, String> toStringMap(final ModelNode resourceModel)
  {
    final Map<String, String> map = new LinkedHashMap<String, String>();

    final String modelName = getName();
    final ModelNode mapModel = resourceModel.get(modelName);
    if (mapModel.isDefined())
    {
      for (final ModelNode listNode : mapModel.asList())
      {
        final Property property = listNode.asProperty();
        final String key = property.getName();
        final String value = property.getValue().asString();
        map.put(key, value);
      }
    }

    return map;
  }

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

}