/*
 * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *   Free SoftwareFoundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.ejb.entity;

import com.caucho.ejb.AbstractContext;
import com.caucho.ejb.AbstractEJBHome;
import com.caucho.ejb.AbstractServer;
import com.caucho.ejb.protocol.HomeSkeletonWrapper;
import com.caucho.log.Log;

import javax.ejb.EJBHome;
import javax.ejb.EJBMetaData;
import javax.ejb.FinderException;
import javax.ejb.Handle;
import javax.ejb.HomeHandle;
import javax.ejb.RemoveException;
import java.io.ObjectStreamException;
import java.io.Serializable;
import java.util.logging.Logger;

/**
 * Abstract base class for an EntityHome.
 */
abstract public class EntityHome extends AbstractEJBHome
  implements EJBHome, Serializable
{
  protected static final Logger log = Log.open(EntityHome.class);

  protected final EntityServer _server;

  protected EntityHome(EntityServer server)
  {
    _server = server;
  }
  
  /**
   * Returns the owning server.
   */
  public EntityServer getServer()
  {
    return _server;
  }

  /**
   * Returns the EJB's meta data.
   */
  public EJBMetaData getEJBMetaData()
  {
    return getServer().getEJBMetaData();
  }

  /**
   * Returns the home handle for the home bean.
   */
  public HomeHandle getHomeHandle()
  {
    return getServer().getHomeHandle();
  }

  /**
   * Returns null, since primary key isn't available to the home.
   */
  public Object getPrimaryKey()
  {
    return null;
  }

  /**
   * Remove the object specified by the handle.
   */
  public void remove(Handle handle)
    throws RemoveException
  {
    getServer().remove(handle);
  }
  
  /**
   * Remove the object specified by the primary key.
   */
  public void remove(Object primaryKey)
    throws RemoveException
  {
    try {
      AbstractContext cxt = getServer().getContext(primaryKey);

      cxt.getEJBLocalObject().remove();
    } catch (FinderException e) {
      throw new RemoveException(String.valueOf(e));
    }
  }

  /**
   * Returns the server.
   */
  public AbstractServer __caucho_getServer()
  {
    return _server;
  }

  /**
   * The home id is null.
   */
  public String __caucho_getId()
  {
    return null;
  }

  /**
   * Serialize the HomeSkeletonWrapper in place of this object.
   *
   * @return the matching skeleton wrapper.
   */
  public Object writeReplace() throws ObjectStreamException
  {
    return new HomeSkeletonWrapper(getHomeHandle());
  }
}
