/*
    * 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.components;
  
  import static javax.xml.stream.XMLStreamConstants.END_ELEMENT;
  
  import javax.xml.stream.XMLStreamException;
  
  import org.jboss.as.controller.AttributeDefinition;
  import org.jboss.as.controller.OperationFailedException;
  import org.jboss.as.controller.OperationStepHandler;
  import org.jboss.as.controller.SimpleAttributeDefinition;
  import org.jboss.as.controller.SimpleAttributeDefinitionBuilder;
  import org.jboss.as.controller.parsing.ParseUtils;
  import org.jboss.as.controller.registry.AttributeAccess;
  import org.jboss.as.controller.registry.ManagementResourceRegistration;
  import org.jboss.dmr.ModelNode;
  import org.jboss.dmr.ModelType;
  import org.jboss.staxmapper.XMLExtendedStreamReader;
  import org.jboss.staxmapper.XMLExtendedStreamWriter;
  
  import de.smartics.properties.api.config.cache.CacheConfiguration;
  import de.smartics.properties.spi.config.config.PropertiesConfiguration;
  
  /**
   * Defines the cache information of a configuration.
   * <p>
   * Example XML fragment of a cache within a configuration:
   * </p>
   *
   * <pre>
   * {@markupExample "Cache Element"
   * &lt;cache&gt;
   *   &lt;jndiName&gt;java:jboss/infinispan/container/smartics-properties&lt;/jndiName&gt;
   * &lt;/cache&gt;}
   * </pre>
   */
  public final class CacheComponent extends AbstractComponent
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The name of the configuration XML element that holds the cache information.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    public static final String CACHE_ELEMENT_NAME = "cache";
  
    /**
     * The attribute that holds the JNDI name of the cache container.
     */
    public static final SimpleAttributeDefinition JNDI_NAME =
        new SimpleAttributeDefinitionBuilder("cache.jndiName", ModelType.STRING,
            true).setXmlName("jndiName").setAllowExpression(true)
            .setFlags(AttributeAccess.Flag.RESTART_ALL_SERVICES).build();
  
    /**
     * The attribute that holds the name of the cache within the container.
     */
    public static final SimpleAttributeDefinition CACHE_NAME =
        new SimpleAttributeDefinitionBuilder("cache.cacheName", ModelType.STRING,
            true).setXmlName("cacheName").setAllowExpression(true)
            .setFlags(AttributeAccess.Flag.RESTART_ALL_SERVICES).build();
  
    private static final AttributeDefinition[] DEFINITIONS = { JNDI_NAME,
                                                              CACHE_NAME };
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    public CacheComponent(final OperationStepHandler writeHandler)
    {
      super(writeHandler);
    }
  
    // ****************************** Inner Classes *****************************
  
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   public void registerAttributes(
       final ManagementResourceRegistration resourceRegistration)
   {
     resourceRegistration.registerReadWriteAttribute(JNDI_NAME, null,
         writeHandler);
     resourceRegistration.registerReadWriteAttribute(CACHE_NAME, null,
         writeHandler);
   }
 
   public void populateModel(final ModelNode operation, final ModelNode model)
     throws OperationFailedException
   {
     JNDI_NAME.validateAndSet(operation, model);
     CACHE_NAME.validateAndSet(operation, model);
   }
 
   public void read(final XMLExtendedStreamReader reader,
       final ModelNode addOperation) throws XMLStreamException
   {
     ParseUtils.requireNoAttributes(reader);
 
     while (reader.hasNext() && reader.nextTag() != END_ELEMENT)
     {
       if (reader.isStartElement())
       {
         final String localName = reader.getLocalName();
 
         if (localName.equals(JNDI_NAME.getXmlName()))
         {
           readAttribute(reader, addOperation, JNDI_NAME);
         }
         else if (localName.equals(CACHE_NAME.getXmlName()))
         {
           readAttribute(reader, addOperation, CACHE_NAME);
         }
         else
         {
           throw ParseUtils.unexpectedElement(reader);
         }
       }
     }
   }
 
   public void write(final XMLExtendedStreamWriter writer, final ModelNode config)
     throws XMLStreamException
   {
     if (isAtLeastOneDefined(config, DEFINITIONS))
     {
       writer.writeStartElement(CACHE_ELEMENT_NAME);
 
       for (final AttributeDefinition definition : DEFINITIONS)
       {
         writeAttribute(writer, config, definition);
       }
 
       writer.writeEndElement();
     }
   }
 
   public void apply(final String identifier,
       final PropertiesConfiguration propertiesConfig, final ModelNode model)
   {
     final CacheConfiguration cacheConfig =
         propertiesConfig.getCacheConfiguration();
     cacheConfig.setCacheId(identifier);
     final String jndiName = getAttribute(model, JNDI_NAME);
     cacheConfig.setJndiName(jndiName);
     final String cacheName = getAttribute(model, CACHE_NAME);
     cacheConfig.setCacheName(cacheName);
   }
 
   // --- object basics --------------------------------------------------------
 
 }