com.sun.enterprise.deployment.web.EjbReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dol Show documentation
The newest version!
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 * Copyright (c) 1997, 2018 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.enterprise.deployment.web;

import com.sun.enterprise.deployment.BundleDescriptor;

/**
 * Specialization of ContextParameter that represents a link to an EJB.
 *
 * @author Danny Coward
 */
public interface EjbReference extends ContextParameter {

    /**
     * Get the type of the EJB (Session, Entity or Message-Driven).
     * @return the type of the EJB.
     */
    String getType();

    /**
     * Set the type of the EJB. Allowed values are Session, Entity or
     * Message-driven.
     * @param type the type of the EJB.
     */
    void setType(String type);

    /**
     * Gets the home classname of the referee EJB.
     * @return the class name of the EJB home.
     */
    String getHomeClassName();

    /**
     * Sets the home classname of the referee EJB.
     * @param homeClassName the class name of the EJB home.
     */
    void setHomeClassName(String homeClassName);

    /**
     * Gets the bean instance interface classname of the referee EJB.
     * @return the classname of the EJB remote object.
     */
    String getBeanClassName();

    /**
     * Sets the bean interface classname of the referee EJB.
     * @param beanClassName the classname of the EJB remote object.
     */
    void setBeanClassName(String beanClassName);

    /**
     * Gets the link name of the reference. For use when linking to an EJB
     * within a J2EE application.
     * @return the link name.
     */
    String getLinkName();

    /**
     * Sets the link name of the reference. For use when linking to an EJB
     * within a J2EE application.
     * @param linkName the link name.
     */
    void setLinkName(String linkName);

    /**
     * Tests if the reference to the referree EJB is through local or
     * remote interface
     * @return true if using the local interfaces
     */
    boolean isLocal();

    /**
     * Sets whether the reference uses the local or remote interfaces of
     * the referring EJB
     * @param isLocal true if using the local interface
     */
    void setLocal(boolean isLocal);

    /**
     * Set the referring bundle, i.e. the bundle within which this
     * EJB reference is declared.
     */
    void setReferringBundleDescriptor(BundleDescriptor referringBundle);

    /**
     * @return the referring bundle, i.e. the bundle within which this
     * EJB reference is declared.
     */
    BundleDescriptor getReferringBundleDescriptor();
}