/**
    * This file Copyright (c) 2011-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.jcr.wrapper;
  
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.OutputStream;
  import java.security.AccessControlException;
  
  import javax.jcr.AccessDeniedException;
  import javax.jcr.Credentials;
  import javax.jcr.InvalidItemStateException;
  import javax.jcr.InvalidSerializedDataException;
  import javax.jcr.Item;
  import javax.jcr.ItemExistsException;
  import javax.jcr.ItemNotFoundException;
  import javax.jcr.LoginException;
  import javax.jcr.NamespaceException;
  import javax.jcr.Node;
  import javax.jcr.PathNotFoundException;
  import javax.jcr.Property;
  import javax.jcr.ReferentialIntegrityException;
  import javax.jcr.Repository;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  import javax.jcr.UnsupportedRepositoryOperationException;
  import javax.jcr.ValueFactory;
  import javax.jcr.Workspace;
  import javax.jcr.lock.LockException;
  import javax.jcr.nodetype.ConstraintViolationException;
  import javax.jcr.nodetype.NoSuchNodeTypeException;
  import javax.jcr.retention.RetentionManager;
  import javax.jcr.security.AccessControlManager;
  import javax.jcr.version.VersionException;
  
  import org.xml.sax.ContentHandler;
  import org.xml.sax.SAXException;
  
  /**
   * Wrapper for JCR Session.
   *
   * @version $Id$
   */
  public abstract class DelegateSessionWrapper implements Session, Cloneable {
  
      protected Session wrapped;
  
      protected DelegateSessionWrapper(Session wrapped) {
          this.wrapped = wrapped;
      }
  
      public Session getWrappedSession() {
          return wrapped;
      }
  
      public void setWrappedSession(Session session) {
          this.wrapped = session;
      }
  
      @Override
      public String toString() {
          return wrapped != null ? wrapped.toString() : "";
      }
  
      /////////////
      //
      //  Delegating method stubs
      //
     /////////////
 
     @Override
     public void addLockToken(String lt) {
         getWrappedSession().addLockToken(lt);
     }
 
     @Override
     public void checkPermission(String absPath, String actions) throws AccessControlException, RepositoryException {
         getWrappedSession().checkPermission(absPath, actions);
     }
 
     @Override
     public void exportDocumentView(String absPath, ContentHandler contentHandler, boolean skipBinary, boolean noRecurse) throws PathNotFoundException, SAXException, RepositoryException {
         getWrappedSession().exportDocumentView(absPath, contentHandler, skipBinary, noRecurse);
     }
 
     @Override
     public void exportDocumentView(String absPath, OutputStream out, boolean skipBinary, boolean noRecurse) throws IOException, PathNotFoundException, RepositoryException {
         getWrappedSession().exportDocumentView(absPath, out, skipBinary, noRecurse);
     }
 
     @Override
     public void exportSystemView(String absPath, ContentHandler contentHandler, boolean skipBinary, boolean noRecurse) throws PathNotFoundException, SAXException, RepositoryException {
         getWrappedSession().exportSystemView(absPath, contentHandler, skipBinary, noRecurse);
     }
 
     @Override
     public void exportSystemView(String absPath, OutputStream out, boolean skipBinary, boolean noRecurse) throws IOException, PathNotFoundException, RepositoryException {
         getWrappedSession().exportSystemView(absPath, out, skipBinary, noRecurse);
     }
 
     @Override
     public AccessControlManager getAccessControlManager() throws UnsupportedRepositoryOperationException, RepositoryException {
         return getWrappedSession().getAccessControlManager();
     }
 
     @Override
     public Object getAttribute(String name) {
         return getWrappedSession().getAttribute(name);
     }
 
     @Override
     public String[] getAttributeNames() {
         return getWrappedSession().getAttributeNames();
     }
 
     @Override
     public ContentHandler getImportContentHandler(String parentAbsPath, int uuidBehavior) throws PathNotFoundException, ConstraintViolationException, VersionException, LockException, RepositoryException {
         return getWrappedSession().getImportContentHandler(parentAbsPath, uuidBehavior);
     }
 
     @Override
     public Item getItem(String absPath) throws PathNotFoundException, RepositoryException {
         return getWrappedSession().getItem(absPath);
     }
 
     @Override
     public String[] getLockTokens() {
         return getWrappedSession().getLockTokens();
     }
 
     @Override
     public String getNamespacePrefix(String uri) throws NamespaceException, RepositoryException {
         return getWrappedSession().getNamespacePrefix(uri);
     }
 
     @Override
     public String[] getNamespacePrefixes() throws RepositoryException {
         return getWrappedSession().getNamespacePrefixes();
     }
 
     @Override
     public String getNamespaceURI(String prefix) throws NamespaceException, RepositoryException {
         return getWrappedSession().getNamespaceURI(prefix);
     }
 
     @Override
     public Node getNode(String absPath) throws PathNotFoundException, RepositoryException {
         return getWrappedSession().getNode(absPath);
     }
 
     @Override
     public Node getNodeByIdentifier(String id) throws ItemNotFoundException, RepositoryException {
         return getWrappedSession().getNodeByIdentifier(id);
     }
 
     @Override
     public Node getNodeByUUID(String uuid) throws ItemNotFoundException, RepositoryException {
         return getWrappedSession().getNodeByUUID(uuid);
     }
 
     @Override
     public Property getProperty(String absPath) throws PathNotFoundException, RepositoryException {
         return getWrappedSession().getProperty(absPath);
     }
 
     @Override
     public Repository getRepository() {
         return getWrappedSession().getRepository();
     }
 
     @Override
     public RetentionManager getRetentionManager() throws UnsupportedRepositoryOperationException, RepositoryException {
         return getWrappedSession().getRetentionManager();
     }
 
     @Override
     public Node getRootNode() throws RepositoryException {
         return getWrappedSession().getRootNode();
     }
 
     @Override
     public String getUserID() {
         return getWrappedSession().getUserID();
     }
 
     @Override
     public ValueFactory getValueFactory() throws UnsupportedRepositoryOperationException, RepositoryException {
         return getWrappedSession().getValueFactory();
     }
 
     @Override
     public Workspace getWorkspace() {
         return getWrappedSession().getWorkspace();
     }
 
     @Override
     public boolean hasCapability(String methodName, Object target, Object[] arguments) throws RepositoryException {
         return getWrappedSession().hasCapability(methodName, target, arguments);
     }
 
     @Override
     public boolean hasPendingChanges() throws RepositoryException {
         return getWrappedSession().hasPendingChanges();
     }
 
     @Override
     public boolean hasPermission(String absPath, String actions) throws RepositoryException {
         return getWrappedSession().hasPermission(absPath, actions);
     }
 
     @Override
     public Session impersonate(Credentials credentials) throws LoginException, RepositoryException {
         return getWrappedSession().impersonate(credentials);
     }
 
     @Override
     public void importXML(String parentAbsPath, InputStream in, int uuidBehavior) throws IOException, PathNotFoundException, ItemExistsException, ConstraintViolationException, VersionException, InvalidSerializedDataException, LockException, RepositoryException {
         getWrappedSession().importXML(parentAbsPath, in, uuidBehavior);
     }
 
     @Override
     public boolean isLive() {
         return getWrappedSession().isLive();
     }
 
     @Override
     public boolean itemExists(String absPath) throws RepositoryException {
         return getWrappedSession().itemExists(absPath);
     }
 
     @Override
     public void logout() {
         getWrappedSession().logout();
     }
 
     @Override
     public void move(String srcAbsPath, String destAbsPath) throws ItemExistsException, PathNotFoundException, VersionException, ConstraintViolationException, LockException, RepositoryException {
         getWrappedSession().move(srcAbsPath, destAbsPath);
     }
 
     @Override
     public boolean nodeExists(String absPath) throws RepositoryException {
         return getWrappedSession().nodeExists(absPath);
     }
 
     @Override
     public boolean propertyExists(String absPath) throws RepositoryException {
         return getWrappedSession().propertyExists(absPath);
     }
 
     @Override
     public void refresh(boolean keepChanges) throws RepositoryException {
         getWrappedSession().refresh(keepChanges);
     }
 
     @Override
     public void removeItem(String absPath) throws VersionException, LockException, ConstraintViolationException, AccessDeniedException, RepositoryException {
         getWrappedSession().removeItem(absPath);
     }
 
     @Override
     public void removeLockToken(String lt) {
         getWrappedSession().removeLockToken(lt);
     }
 
     @Override
     public void save() throws AccessDeniedException, ItemExistsException, ReferentialIntegrityException, ConstraintViolationException, InvalidItemStateException, VersionException, LockException, NoSuchNodeTypeException, RepositoryException {
         getWrappedSession().save();
     }
 
     @Override
     public void setNamespacePrefix(String prefix, String uri) throws NamespaceException, RepositoryException {
         getWrappedSession().setNamespacePrefix(prefix, uri);
     }
 
     /**
      * @return the unwrapped proper JCRSession
      */
     public Session unwrap() {
         Session session = getWrappedSession();
         if (session instanceof DelegateSessionWrapper) {
             session = ((DelegateSessionWrapper) session).unwrap();
         }
         return session;
     }
 
     /**
      * Removes a wrapper by type. The wrapper can be deep in a chain of wrappers in which case wrappers before it will
      * be cloned creating a new chain that leads to the same real node.
      */
     public Session deepUnwrap(Class<? extends DelegateSessionWrapper> wrapper) {
 
         if (this.getClass().equals(wrapper)) {
             return getWrappedSession();
         }
 
         Session next = getWrappedSession();
 
         // If the next session is the real node then we can skip cloning ourselves.
         // This happens when the wrapper to remove isn't present
         if (!(next instanceof DelegateSessionWrapper)) {
             return this;
         }
 
         // We let the next wrapper do deepUnwrap first, if it returns itself then the wrapper isn't in the chain and cloning is not necessary
         Session deepUnwrappedNext = ((DelegateSessionWrapper) next).deepUnwrap(wrapper);
         if (deepUnwrappedNext == next) {
             return this;
         }
 
         try {
             DelegateSessionWrapper clone = ((DelegateSessionWrapper) this.clone());
             clone.initClone(deepUnwrappedNext);
             return clone;
         } catch (CloneNotSupportedException e) {
             throw new RuntimeException("Failed to unwrap " + this.getClass().getName() + " due to " + e.getMessage(), e);
         }
     }
 
     protected void initClone(Session newSession) {
         setWrappedSession(newSession);
     }
 
     @Override
     protected Object clone() throws CloneNotSupportedException {
         // just shallow clone ... keep it that way at least for wrappedSession otherwise deepUnwrap generates zillions of objects unnecessarily
         return super.clone();
     }
 
     @Override
     public boolean equals(Object obj) {
         if (obj == this) {
             return true;
         }
         if (obj == null || !(obj instanceof DelegateSessionWrapper)) {
             return false;
         }
         DelegateSessionWrapper that = (DelegateSessionWrapper) obj;
         return this.getClass().equals(that.getClass()) && this.wrapped.equals(that.wrapped);
     }
 
 }