/*
    * 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.admin.resources.representation.xml;
  
  import java.io.OutputStream;
  import java.io.PrintStream;
  import java.io.UnsupportedEncodingException;
  import java.net.URI;
  import java.util.List;
  
  import javax.ws.rs.core.Link;
  
  import org.apache.commons.lang.ObjectUtils;
  import org.apache.commons.lang3.StringEscapeUtils;
  
  import de.smartics.properties.admin.domain.model.AppRelations;
  import de.smartics.properties.admin.domain.model.PropertiesConfiguration;
  import de.smartics.properties.admin.resources.controller.PropertyResource;
  import de.smartics.properties.admin.resources.representation.share.BreadcrumbHelper;
  import de.smartics.properties.admin.resources.representation.xml.share.AbstractXmlRepresentationRenderer;
  import de.smartics.properties.api.config.domain.DescribedProperty;
  import de.smartics.properties.api.config.domain.ValidatedProperty;
  import de.smartics.properties.api.config.domain.key.ConfigurationKey;
  import de.smartics.resteasy.hypermedia.renderer.LinkDescriptor;
  import de.smartics.resteasy.hypermedia.renderer.LinkDescriptorJaxrs;
  import de.smartics.resteasy.hypermedia.renderer.LinkMetadata;
  import de.smartics.resteasy.hypermedia.renderer.ResourceContext;
  
  /**
   * Displays a single property in an XML page.
   */
  public final class PropertyKeysXmlRepresentationRenderer extends
      AbstractXmlRepresentationRenderer<PropertiesConfiguration>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The domain object to render.
     */
    private final PropertiesConfiguration domainObject;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param context the context information to render the representation.
     * @param domainObject the domain object to render.
     * @param entityStream the stream to write to.
     */
    public PropertyKeysXmlRepresentationRenderer(final ResourceContext context,
        final PropertiesConfiguration domainObject,
        final OutputStream entityStream)
    {
      super(context, entityStream);
      this.domainObject = domainObject;
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    @Override
    protected void httpBody() throws IllegalStateException
    {
      final String encoding = context.getResponse().getCharacterEncoding();
      try
      {
        final PrintStream output = new PrintStream(entityStream, true, encoding);
  
        output.append("<?xml version=\"1.0\" encoding=\"").append(encoding)
            .append("\"?>\n\n");
        output.append("<properties config=\"")
            .append(StringEscapeUtils.escapeXml(domainObject.getKey()))
           .append("\">\n");
 
       for (final DescribedProperty property : domainObject.getProperties())
       {
         renderRow(output, property);
       }
       output.append("</properties>\n");
     }
     catch (final UnsupportedEncodingException e)
     {
       throw new IllegalStateException(
           "Cannot write properties to XML file due to unsupported encoding '"
               + encoding + "'.", e);
     }
   }
 
   private void renderRow(final PrintStream output,
       final DescribedProperty property)
   {
     final String value;
     if (property instanceof ValidatedProperty)
     {
       value =
           ObjectUtils.toString(((ValidatedProperty) property)
               .getValidatedValue());
     }
     else
     {
       value = property.getValue();
     }
 
     final String key = property.getName();
     final String source = createConfigSource(property);
     output.append("  <property name=\"")
         .append(StringEscapeUtils.escapeXml(key)).append("\" source=\"")
         .append(StringEscapeUtils.escapeXml(source)).append("\">");
 
     if (value != null)
     {
       output.append(StringEscapeUtils.escapeXml(value));
     }
     output.append("</property>\n");
   }
 
   private String createConfigSource(final DescribedProperty property)
   {
     final ConfigurationKey<?> configurationKey = property.getConfigurationKey();
     final String label =
         configurationKey == null ? "default" : configurationKey.toString();
     return label;
   }
 
   @Override
   protected List<LinkDescriptor> hyperLinks()
   {
     final List<LinkDescriptor> links =
         BreadcrumbHelper.adjustSelf(breadcrumb.configuration(domainObject
             .getKey()));
 
     for (final DescribedProperty property : domainObject.getProperties())
     {
       final String name = property.getName();
       final LinkDescriptor link = createLink(name);
       links.add(link);
     }
 
     return links;
   }
 
   private LinkDescriptor createLink(final String propertyName)
   {
     final URI uri =
         context.getUriInfo().getBaseUriBuilder()
             .path(PropertyResource.class, "getAsXml")
             .build(new Object[] { domainObject.getKey(), propertyName }, false);
     final Link link =
         Link.fromUri(uri).rel(AppRelations.PROPERTY + " " + propertyName)
             .build();
     final LinkMetadata metadata = new LinkMetadata();
 
     final LinkDescriptorJaxrs descriptor =
         new LinkDescriptorJaxrs(link, metadata);
     return descriptor;
   }
 
   @Override
   protected void close()
   {
   }
 
   // --- object basics --------------------------------------------------------
 
 }