001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005 *
006 * The contents of this file are subject to the terms of either the GNU
007 * General Public License Version 2 only ("GPL") or the Common
008 * Development and Distribution License("CDDL") (collectively, the
009 * "License"). You may not use this file except in compliance with the
010 * License. You can obtain a copy of the License at
011 * http://www.netbeans.org/cddl-gplv2.html
012 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013 * specific language governing permissions and limitations under the
014 * License. When distributing the software, include this License Header
015 * Notice in each file and include the License file at
016 * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017 * particular file as subject to the "Classpath" exception as provided
018 * by Sun in the GPL Version 2 section of the License file that
019 * accompanied this code. If applicable, add the following below the
020 * License Header, with the fields enclosed by brackets [] replaced by
021 * your own identifying information:
022 * "Portions Copyrighted [year] [name of copyright owner]"
023 *
024 * Contributor(s):
025 *
026 * The Original Software is NetBeans. The Initial Developer of the Original
027 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028 * Microsystems, Inc. All Rights Reserved.
029 *
030 * If you wish your version of this file to be governed by only the CDDL
031 * or only the GPL Version 2, indicate your decision by adding
032 * "[Contributor] elects to include this software in this distribution
033 * under the [CDDL or GPL Version 2] license." If you do not indicate a
034 * single choice of license, a recipient has the option to distribute
035 * your version of this file under either the CDDL, the GPL Version 2 or
036 * to extend the choice of license to its licensees as provided above.
037 * However, if you add GPL Version 2 code and therefore, elected the GPL
038 * Version 2 license, then the option applies only if the new code is
039 * made subject to such option by the copyright holder.
040 */
041
042 package org.netbeans.modules.j2ee.deployment.plugins.spi.config;
043
044 import org.netbeans.modules.j2ee.deployment.common.api.ConfigurationException;
045
046 /**
047 * Configuration for EJB resources.
048 * <p>
049 * Implementation of this interface should be registered in the {@link ModuleConfiguration}
050 * lookup.
051 *
052 * @since 1.23
053 * @author sherold
054 */
055 public interface EjbResourceConfiguration {
056
057 /**
058 * Returns a JNDI name for the given EJB or <code>null</code> if the EJB has
059 * no JNDI name assigned.
060 *
061 * @param ejbName EJB name
062 *
063 * @return JNDI name bound to the EJB or <code>null</code> if the EJB has no
064 * JNDI name assigned.
065 *
066 * @throws ConfigurationException if there is some problem with EJB configuration.
067 *
068 * @since 1.31
069 */
070 public String findJndiNameForEjb(String ejbName)
071 throws ConfigurationException;
072
073 /**
074 * Binds an EJB reference name with an EJB JNDI name.
075 *
076 * @param referenceName name used to identify the EJB
077 * @param jndiName JNDI name of the referenced EJB
078 *
079 * @throws ConfigurationException if there is some problem with EJB configuration
080 *
081 * @since 1.26
082 */
083 public void bindEjbReference(String referenceName, String jndiName)
084 throws ConfigurationException;
085
086 /**
087 * Binds an EJB reference name with an EJB name within the EJB scope.
088 *
089 * @param ejbName EJB name
090 * @param ejbType EJB type - the possible values are
091 * org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.SESSION,
092 * org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.ENTITY and
093 * org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.MESSAGE_DRIVEN
094 * @param referenceName name used to identify the referenced EJB
095 * @param jndiName JNDI name of the referenced EJB
096 *
097 * @throws NullPointerException if any of parameters is null
098 * @throws ConfigurationException if there is some problem with EJB configuration
099 * @throws IllegalArgumentException if ejbType doesn't have one of allowed values
100 *
101 * @since 1.26
102 */
103 public void bindEjbReferenceForEjb(String ejbName, String ejbType,
104 String referenceName, String jndiName)
105 throws ConfigurationException;
106 }
|