/**
    * This file Copyright (c) 2003-2013 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.module.delta;
  
  import info.magnolia.jcr.util.PropertyUtil;
  import info.magnolia.jcr.util.SessionUtil;
  import info.magnolia.module.InstallContext;
  
  import java.io.InputStream;
  import java.math.BigDecimal;
  import java.util.Calendar;
  
  import javax.jcr.Binary;
  import javax.jcr.RepositoryException;
  import javax.jcr.Node;
  import javax.jcr.Session;
  import javax.jcr.Value;
  
  /**
   * Sets a new value for a property. Consider using CheckAndModifyPropertyValueTask if you want your update tasks
   * to only modify expected values.
   * @see CheckAndModifyPropertyValueTask
   *
   * @author fgiust
   * @version $Revision: $ ($Author: $)
   */
  public class SetPropertyTask extends PropertyValuesTask {
  
      private final String workspaceName;
  
      private final String nodePath;
  
      private final String propertyName;
  
      private final Object newValue;
  
      public SetPropertyTask(String workspaceName, String nodePath, String propertyName, String newValue) {
          this("Set " + nodePath + "/" + propertyName, workspaceName, nodePath, propertyName, newValue);
      }
  
      public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, String newValue) {
          this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
      }
  
      public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, Value newValue) {
          this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
      }
  
      public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, Node newValue) {
          this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
      }
  
      public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, Binary newValue) {
          this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
      }
  
      public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, Calendar newValue) {
          this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
      }
  
      public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, BigDecimal newValue) {
          this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
      }
  
      public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, Long newValue) {
          this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
      }
  
     public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, Double newValue) {
         this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
     }
 
     public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, Boolean newValue) {
         this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
     }
 
     public SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, InputStream newValue) {
         this(taskName, workspaceName, nodePath, propertyName, (Object) newValue);
     }
 
     private SetPropertyTask(String taskName, String workspaceName, String nodePath, String propertyName, Object newValue) {
         super(taskName, "Sets " + nodePath + "/" + propertyName + " to " + newValue + ".");
         this.workspaceName = workspaceName;
         this.nodePath = nodePath;
         this.propertyName = propertyName;
         this.newValue = newValue;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void execute(InstallContext installContext) {
         try {
             final Session session = installContext.getJCRSession(workspaceName);
             final Node node = SessionUtil.getNode(session, nodePath);
 
             PropertyUtil.setProperty(node, propertyName, this.newValue);
         } catch (RepositoryException e) {
             final String msg = format("Unable to set property \"{0}\" to value \"{1}\" on node \"{2}\".", propertyName, newValue, nodePath);
             installContext.error(msg, e);
         }
     }
 }