jakarta.ejb.ActivationConfigProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ejb-api Show documentation
Jakarta Enterprise Beans
There is a newer version: 1.2.2.1-jre17
/*
 * 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 jakarta.ejb;

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

/**
 * Used to provide information to the deployer about the configuration of a message driven bean in its operational
 * environment.
 * 
 * The following standard properties are recognized for Jakarta Messaging message driven beans:
 * 

 * acknowledgeMode. This property is used to specify the Jakarta Messaging acknowledgement mode for the message
 * delivery when bean-managed transaction demarcation is used. Its values are Auto_acknowledge or
 * Dups_ok_acknowledge. If this property is not specified, Jakarta Messaging AUTO_ACKNOWLEDGE semantics are
 * assumed.
 *
 * 
messageSelector. This property is used to specify the Jakarta Messaging message selector to be used in determining
 * which messages a Jakarta Messaging message driven bean is to receive.
 *
 * 
destinationType. This property is used to specify whether the message driven bean is intended to be
 * used with a queue or a topic. The value must be either jakarta.jms.Queue or jakarta.jms.Topic.
 *
 * 
destinationLookup. This property is used to specify the Jakarta Messaging queue or topic from which a Jakarta Messaging
 * message-driven bean is to receive messages.
 *
 * 
connectionFactoryLookup. This property is used to specify the Jakarta Messaging connection factory that will be
 * used to connect to the Jakarta Messaging provider from which a Jakarta Messaging message-driven bean is to receive messages.
 *
 * 
subscriptionDurability. If the message driven bean is intended to be used with a topic, this
 * property may be used to indicate whether a durable or non-durable subscription should be used. The value of this
 * property must be either Durable or NonDurable
 *
 * 
subscriptionName. This property is used to specify the name of the durable subscription if the
 * message-driven bean is intended to be used with a Topic, and the bean provider has indicated that a durable
 * subscription should be used.
 *
 * 
clientId. This property is used to specify the Jakarta Messaging client identifier that will be used when
 * connecting to the Jakarta Messaging provider from which a Jakarta Messaging message-driven bean is to receive messages. If this property is not
 * specified then the client identifier will be left unset.
 *
 * 
 *
 * @since EJB 3.0
 */
@Target({})
@Retention(RetentionPolicy.RUNTIME)
public @interface ActivationConfigProperty {
    /**
     * propertyName.
     *
     * @return a {@link java.lang.String} object.
     */
    String propertyName();

    /**
     * propertyValue.
     *
     * @return a {@link java.lang.String} object.
     */
    String propertyValue();
}