javax.ejb.Init Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.ejb;

import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.ElementType;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;

/**
 * Designates a method of a session bean that corresponds to a
 * create<METHOD> method of an adapted home or
 * local home interface (an interface that adapts an EJB 2.1 or earlier
 * EJBHome or EJBLocalHome client view respectively).
 *
 *  The result type of such an Init method is required
 * to be void, and its parameter types must be exactly the same as
 * those of the referenced create<METHOD>
 * method(s).
 *
 * 

 * An Init method is only required to be specified for
 * stateful session beans that provide a RemoteHome or
 * LocalHome interface. 
 *
 * 
 The name of the adapted create<METHOD>
 * method of the home or local home interface must be specified if the
 * adapted interface has more than one
 * create<METHOD> method and the method
 * signatures are not the same.
 *
 * @see LocalHome
 * @see RemoteHome
 *
 * @since EJB 3.0
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Init {

    /**
     * The name of the corresponding
     * create<METHOD> method of the adapted
     * home or local home interface.  This value is used to
     * disambiguate the case where there are multiple
     * create<METHOD> methods on an adapted
     * home and/or local home interface.  If there are multiple
     * create<METHOD> methods on the adapted
     * interface(s) and no value is specified, the
     * create<METHOD> matching is based on
     * signature only.
     * 
     * Note that this value is not required to be specified if there
     * is only a single create<METHOD> method
     * even if the name of the method to which the Init
     * annotation is applied does not match that of the
     * create<METHOD> method.
     */
    String value() default "";

}