com.sun.ejb.containers.EJBLocalHomeImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ejb-container Show documentation
The newest version!
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.ejb.containers;

import com.sun.enterprise.container.common.spi.util.IndirectlySerializable;
import com.sun.enterprise.container.common.spi.util.SerializableObjectFactory;

import jakarta.ejb.CreateException;
import jakarta.ejb.EJBException;
import jakarta.ejb.EJBLocalHome;
import jakarta.ejb.RemoveException;

import java.io.IOException;
import java.lang.reflect.Method;
import java.rmi.RemoteException;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Implementation of the {@link EJBLocalHome} interface.
 * This class is also the base class for all generated concrete EJBLocalHome implementations.
 *
 * At deployment time, one instance of the EJBLocalHome is created for each EJB class in a JAR that
 * has a local home.
 *
 * @author Mahesh Kannan
 */
public abstract class EJBLocalHomeImpl implements EJBLocalHome, IndirectlySerializable {

    private static final Logger _logger = EjbContainerUtilImpl.getLogger();
    private BaseContainer container;

    /**
     * Called from BaseContainer only.
     */
    final void setContainer(BaseContainer container) {
        this.container = container;
    }

    /**
     * Called from concrete EJBLocalHome implementation.
     */
    protected final BaseContainer getContainer() {
        return container;
    }


    /**
     * Get the EJBLocalHome corresponding to an EJBLocalHomeImpl.
     * These objects are one and the same when the local home is generated,
     * but distinct in the case of dynamic proxies. Therefore, code can't
     * assume it can cast an EJBLocalHomeImpl to the EJBLocalHome that
     * the client uses, and vice-versa. This is overridden in the
     * InvocationHandler.
     *
     * @return this
     */
    protected EJBLocalHome getEJBLocalHome() {
        return this;
    }

    /**
     * Create a new EJBLocalObjectImpl and new EJB if necessary.
     * This is called from the concrete "HelloEJBHomeImpl" create method.
     *
     * @return the EJBObjectImpl for the bean.
     */
    protected EJBLocalObjectImpl createEJBLocalObjectImpl() throws CreateException {
        return container.createEJBLocalObjectImpl();
    }

    /**
     * Create a new EJBLocalBusinessObjectImpl and new EJB if necessary.
     *
     * @param intfName
     * @return {@link EJBLocalObjectImpl}
     * @throws CreateException
     */
    protected final EJBLocalObjectImpl createEJBLocalBusinessObjectImpl(String intfName) throws CreateException {
        // intfName is the Generated interface name in the case of the no-interface view
        return container.createEJBLocalBusinessObjectImpl(intfName);
    }

    /**
     * This is the implementation of the jakarta.ejb.EJBLocalHome remove method.
     */
    @Override
    public final void remove(Object primaryKey) throws RemoveException, EJBException {
        if (container.getContainerInfo().type != BaseContainer.ContainerType.ENTITY) {
            // Session beans dont have primary keys. EJB2.0 Section 6.6.
            throw new RemoveException("Attempt to call remove(Object primaryKey) on a session bean.");
        }

        container.authorizeLocalMethod(BaseContainer.EJBLocalHome_remove_Pkey);

        Method method=null;
        try {
            method = EJBLocalHome.class.getMethod("remove", new Class[] {Object.class});
        } catch (NoSuchMethodException e) {
            _logger.log(Level.FINE, "Exception in method remove()", e);
        }

        try {
            container.doEJBHomeRemove(primaryKey, method, true);
        } catch (RemoteException re) {
            // This should never be thrown for local invocations, but it's
            // part of the removeBean signature.  If for some strange
            // reason it happens, convert to EJBException
            throw new EJBException("unexpected RemoteException", re);
        }
    }

    @Override
    public SerializableObjectFactory getSerializableObjectFactory() {
        return new SerializableLocalHome(container.getEjbDescriptor().getUniqueId());
    }

    public static final class SerializableLocalHome implements SerializableObjectFactory {

        private static final long serialVersionUID = 1L;
        private final long ejbId;

        public SerializableLocalHome(long uniqueId) {
            this.ejbId = uniqueId;
        }


        @Override
        public Object createObject() throws IOException {
            // Return the LocalHome by getting the target container based
            // on the ejb id. Note that we can assume this is the
            // LocalHome rather than a LocalBusinessHome since the
            // LocalBusinessHome is never visible to the application and
            // would never be stored in SFSB state.
            BaseContainer container = EjbContainerUtilImpl.getInstance().getContainer(ejbId);
            return container.getEJBLocalHome();
        }
    }
}