/*
 * Copyright (C) 2009 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.exoplatform.services.ext.action;

import org.apache.commons.chain.Context;
import org.exoplatform.container.ExoContainer;

import java.util.HashMap;

import javax.jcr.Item;

/**
 * Created by The eXo Platform SAS<br>
 *
 * InvocationContext is a collection of properties which reflects the state of a current Session.
 * 
 * @author Gennady Azarenkov
 * @version $Id: InvocationContext.java 11907 2008-03-13 15:36:21Z ksm $
 * @LevelAPI Provisional
 */
public class InvocationContext extends HashMap<String, Object> implements Context {

  private static final long serialVersionUID = 8562120359133701200L;

  /**
    * Exo container.
    */
   public static final String EXO_CONTAINER = "exocontainer".intern();

   /**
    * Current item.
    */
   public static final String CURRENT_ITEM = "currentItem".intern();

   /**
    * Previous item.
    */
   public static final String PREVIOUS_ITEM = "previousItem".intern();

   /**
    * Context event.
    */
   public static final String EVENT = "event".intern();

   public boolean getBoolean(final String name)
   {
      if (!containsKey(name))
         return false;
      return (Boolean)(get(name));
   }

   /**
    * @return The related eXo container.
    */
   public final ExoContainer getContainer()
   {
      return (ExoContainer)get(EXO_CONTAINER);
   }

   /**
    * @return The current item.
    */
   public final Item getCurrentItem()
   {
      return (Item)get(CURRENT_ITEM);
   }

   /**
    * @return The previous item before the change.
    */
   public final Item getPreviousItem()
   {
      return (Item)get(PREVIOUS_ITEM);
   }

   /**
    * @return The type of the event.
    */
   public final int getEventType()
   {
      return (Integer)get(EVENT);
   }

   public String getString(final String name)
   {
      if (!containsKey(name))
         return null;
      return (String)(get(name));
   }
}
