/*
    * $Id: GetAsStringVModel.java 901361 2010-01-20 20:10:27Z apetrelli $
    *
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you 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.apache.tiles.velocity.template;
  
  import java.io.IOException;
  import java.io.Writer;
  import java.util.Map;
  
  import javax.servlet.ServletContext;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  import org.apache.tiles.Attribute;
  import org.apache.tiles.TilesContainer;
  import org.apache.tiles.servlet.context.ServletUtil;
  import org.apache.tiles.template.GetAsStringModel;
  import org.apache.tiles.velocity.context.VelocityUtil;
  import org.apache.velocity.context.Context;
  import org.apache.velocity.context.InternalContextAdapter;
  import org.apache.velocity.runtime.Renderable;
  
  /***
   * Wraps {@link GetAsStringModel} to be used in Velocity. For the list of
   * parameters, see
   * {@link GetAsStringModel#start(java.util.Stack, TilesContainer, boolean,
   * String, String, Object, String, String, String, Attribute, Object...)}
   * , {@link GetAsStringModel#end(java.util.Stack, TilesContainer, Writer, boolean, Object...)} and
   * {@link GetAsStringModel#execute(TilesContainer, Writer, boolean, String,
   * String, Object, String, String, String, Attribute, Object...)}.
   *
   * @version $Rev: 901361 $ $Date: 2010-01-20 21:10:27 +0100 (mer, 20 gen 2010) $
   * @since 2.2.0
   * @deprecated Use Velocity directives.
   */
  @Deprecated
  public class GetAsStringVModel implements Executable, BodyExecutable {
  
      /***
       * The template model.
       */
      private GetAsStringModel model;
  
      /***
       * The Servlet context.
       */
      private ServletContext servletContext;
  
      /***
       * Constructor.
       *
       * @param model The template model.
       * @param servletContext The servlet context.
       * @since 2.2.0
       */
      public GetAsStringVModel(GetAsStringModel model,
              ServletContext servletContext) {
          this.model = model;
          this.servletContext = servletContext;
      }
  
      /*** {@inheritDoc} */
      public Renderable execute(HttpServletRequest request,
              HttpServletResponse response, Context velocityContext,
              Map<String, Object> params) {
          return new AbstractDefaultToStringRenderable(velocityContext, params,
                  response, request) {
  
              public boolean render(InternalContextAdapter context, Writer writer)
                      throws IOException {
                  TilesContainer container = ServletUtil.getCurrentContainer(
                          request, servletContext);
                  model.execute(container, writer,
                          VelocityUtil.toSimpleBoolean((Boolean) params
                                  .get("ignore"), false), (String) params
                                  .get("preparer"), (String) params.get("role"),
                          params.get("defaultValue"), (String) params
                                  .get("defaultValueRole"), (String) params
                                  .get("defaultValueType"), (String) params
                                  .get("name"), (Attribute) params.get("value"),
                          velocityContext, request, response, writer);
                 return true;
             }
         };
     }
 
     /*** {@inheritDoc} */
     public void start(HttpServletRequest request, HttpServletResponse response,
             Context velocityContext, Map<String, Object> params) {
         VelocityUtil.getParameterStack(velocityContext).push(params);
         model.start(ServletUtil.getComposeStack(request), ServletUtil
                 .getCurrentContainer(request, servletContext), VelocityUtil
                 .toSimpleBoolean((Boolean) params.get("ignore"), false),
                 (String) params.get("preparer"), (String) params.get("role"),
                 params.get("defaultValue"), (String) params
                         .get("defaultValueRole"), (String) params
                         .get("defaultValueType"), (String) params.get("name"),
                 (Attribute) params.get("value"), velocityContext, request,
                 response);
     }
 
     /*** {@inheritDoc} */
     public Renderable end(HttpServletRequest request, HttpServletResponse response,
             Context velocityContext) {
         Map<String, Object> params = VelocityUtil.getParameterStack(
                 velocityContext).pop();
         return new AbstractDefaultToStringRenderable(velocityContext, params, response, request) {
 
             public boolean render(InternalContextAdapter context, Writer writer)
                     throws IOException {
                 model.end(ServletUtil.getComposeStack(request), ServletUtil
                         .getCurrentContainer(request, servletContext), writer,
                         VelocityUtil.toSimpleBoolean((Boolean) params
                                 .get("ignore"), false), velocityContext,
                         request, response, writer);
                 return true;
             }
         };
     }
 }