Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.ejbgen
Annotation Type MessageDriven


@Retention(value=CLASS)
@Target(value=java.lang.annotation.ElementType.TYPE)
public @interface MessageDriven


Required Element Summary
 String destinationType
          (javax.jms.Queue|javax.jms.Topic) Specifies the destination type of the Message-Driven bean.
 String ejbName
          Specifies the name of this Message-Driven bean.
 
Optional Element Summary
 MessageDriven.AcknowledgeMode acknowledgeMode
          (auto-acknowledge|dups-ok-acknowledge) Specifies the acknowledgement mode of this Message-Driven bean.
 Constants.Bool clientsOnSameServer
          (True|False) Specifies whether the clients are colocated with the EJB on the same server.
 String createAsPrincipalName
          Names the principal to be used when ejbCreate would otherwise run with an anonymous principal.
 MessageDriven.DefaultTransaction defaultTransaction
          (NotSupported|Required) Specifies the transaction attribute to be applied to all methods that do not have a specific transaction attribute setting.
 String destinationJndiName
          Gives the JNDI name of the destination of this Message-Driven bean.
 String destinationResourceLink
          Links to an actual JMS Module Reference in WebLogic Server.
 String dispatchPolicy
          Specifies the dispatch policy queue for this bean.
 Constants.Bool durable
          (True|False) If the destination-type is Topic, setting this attribute to True will make the subscription durable.
 Constants.Bool durableSubscriptionDeletion
          Indicates whether you want durable topic subscriptions to be automatically deleted when an MDB is undeployed or removed.
 Constants.Bool generateUniqueJmsClientId
          Indicates whether or not you want the EJB container to generate a unique client-id for every instance of an MDB.
 String initialBeansInFreePool
          Specifies the initial number of beans in the free pool.
 int initSuspendSeconds
          Specifies the initial number of seconds to suspend an MDB's JMS connection when the EJB container detects a JMS resource outage.
 String jmsClientId
          The client id of this EJB.
 String jmsPollingIntervalSeconds
          The number of seconds between each attempt to reconnect to the JMS destination.
 String maxBeansInFreePool
          Specifies the maximum number of beans in the free pool.
 int maxMessagesInTransaction
          Specifies the maximum number of messages in the transaction.
 int maxSuspendSeconds
          Specifies the maximum number of seconds to suspend an MDB's JMS connection when the EJB container detects a JMS resource outage.
 String messageSelector
          Specifies the JMS message selector of this Message-Driven bean.
 String messagingType
          Specifies the messaging listener interface of the message-driven bean.
 String networkAccessPoint
          Assigns a custom network channel that the EJB will use for network communications.
 String passivateAsPrincipalName
          Names the principal to be used when ejbPassivate would otherwise run with an anonymous principal.
 String remoteClientTimeout
          remote client timeout
 String removeAsPrincipalName
          Names the principal to be used when ejbRemove would otherwise run with an anonymous principal.
 String resourceAdapterJndiName
          Specifies the JNDI name of the resource adapter that this MDB receives messages from.
 String runAs
          Specifies the role-name for this EJB.
 String runAsIdentityPrincipal
          Specifies the name of the principal in case the role maps to several principals.
 String runAsPrincipalName
          Specifies the name of the principal in case the role maps to several principals.
 String timerPersistentStore
          Specifies the name of a persistent store on the server's file system where WebLogic Server stores timer objects.
 MessageDriven.MessageDrivenTransactionType transactionType
          (Bean|Container) Specifies where the transactions for this EJB are managed.
 String transTimeoutSeconds
          Specifies the transaction timeout (in seconds).
 Constants.Bool useCallerIdentity
          (True|False) Specifies whether this EJB uses callers identity.
 

Element Detail

ejbName

public abstract String ejbName
Specifies the name of this Message-Driven bean.


destinationType

public abstract String destinationType
(javax.jms.Queue|javax.jms.Topic) Specifies the destination type of the Message-Driven bean.

destinationJndiName

public abstract String destinationJndiName
Gives the JNDI name of the destination of this Message-Driven bean.

Default:
"UNSPECIFIED"

destinationResourceLink

public abstract String destinationResourceLink
Links to an actual JMS Module Reference in WebLogic Server.

Default:
"UNSPECIFIED"

messageSelector

public abstract String messageSelector
Specifies the JMS message selector of this Message-Driven bean.

Default:
"UNSPECIFIED"

durable

public abstract Constants.Bool durable
(True|False) If the destination-type is Topic, setting this attribute to True will make the subscription durable.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

initialBeansInFreePool

public abstract String initialBeansInFreePool
Specifies the initial number of beans in the free pool.

Default:
"UNSPECIFIED"

clientsOnSameServer

public abstract Constants.Bool clientsOnSameServer
(True|False) Specifies whether the clients are colocated with the EJB on the same server.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

jmsPollingIntervalSeconds

public abstract String jmsPollingIntervalSeconds
The number of seconds between each attempt to reconnect to the JMS destination.

Default:
"UNSPECIFIED"

removeAsPrincipalName

public abstract String removeAsPrincipalName
Names the principal to be used when ejbRemove would otherwise run with an anonymous principal.

Default:
"UNSPECIFIED"

transactionType

public abstract MessageDriven.MessageDrivenTransactionType transactionType
(Bean|Container) Specifies where the transactions for this EJB are managed.

Default:
weblogic.ejbgen.MessageDriven.MessageDrivenTransactionType.UNSPECIFIED

transTimeoutSeconds

public abstract String transTimeoutSeconds
Specifies the transaction timeout (in seconds).

Default:
"UNSPECIFIED"

useCallerIdentity

public abstract Constants.Bool useCallerIdentity
(True|False) Specifies whether this EJB uses callers identity.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

maxBeansInFreePool

public abstract String maxBeansInFreePool
Specifies the maximum number of beans in the free pool.

Default:
"UNSPECIFIED"

defaultTransaction

public abstract MessageDriven.DefaultTransaction defaultTransaction
(NotSupported|Required) Specifies the transaction attribute to be applied to all methods that do not have a specific transaction attribute setting.

Default:
weblogic.ejbgen.MessageDriven.DefaultTransaction.UNSPECIFIED

runAsIdentityPrincipal

public abstract String runAsIdentityPrincipal
Specifies the name of the principal in case the role maps to several principals.

Default:
"UNSPECIFIED"

runAsPrincipalName

public abstract String runAsPrincipalName
Specifies the name of the principal in case the role maps to several principals.

Default:
"UNSPECIFIED"

dispatchPolicy

public abstract String dispatchPolicy
Specifies the dispatch policy queue for this bean.

Default:
"UNSPECIFIED"

passivateAsPrincipalName

public abstract String passivateAsPrincipalName
Names the principal to be used when ejbPassivate would otherwise run with an anonymous principal.

Default:
"UNSPECIFIED"

acknowledgeMode

public abstract MessageDriven.AcknowledgeMode acknowledgeMode
(auto-acknowledge|dups-ok-acknowledge) Specifies the acknowledgement mode of this Message-Driven bean.

Default:
weblogic.ejbgen.MessageDriven.AcknowledgeMode.UNSPECIFIED

runAs

public abstract String runAs
Specifies the role-name for this EJB.

Default:
"UNSPECIFIED"

jmsClientId

public abstract String jmsClientId
The client id of this EJB.

Default:
"UNSPECIFIED"

createAsPrincipalName

public abstract String createAsPrincipalName
Names the principal to be used when ejbCreate would otherwise run with an anonymous principal.

Default:
"UNSPECIFIED"

networkAccessPoint

public abstract String networkAccessPoint
Assigns a custom network channel that the EJB will use for network communications. A network channel defines a set of connection attributes.

Default:
"UNSPECIFIED"

messagingType

public abstract String messagingType
Specifies the messaging listener interface of the message-driven bean.

Default:
"UNSPECIFIED"

initSuspendSeconds

public abstract int initSuspendSeconds
Specifies the initial number of seconds to suspend an MDB's JMS connection when the EJB container detects a JMS resource outage.

Default:
0

maxSuspendSeconds

public abstract int maxSuspendSeconds
Specifies the maximum number of seconds to suspend an MDB's JMS connection when the EJB container detects a JMS resource outage.

Default:
0

generateUniqueJmsClientId

public abstract Constants.Bool generateUniqueJmsClientId
Indicates whether or not you want the EJB container to generate a unique client-id for every instance of an MDB. Enabling this flag makes it easier to deploy durable MDBs to multiple server instances in a WebLogic Server cluster.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

durableSubscriptionDeletion

public abstract Constants.Bool durableSubscriptionDeletion
Indicates whether you want durable topic subscriptions to be automatically deleted when an MDB is undeployed or removed.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

maxMessagesInTransaction

public abstract int maxMessagesInTransaction
Specifies the maximum number of messages in the transaction.

Default:
0

resourceAdapterJndiName

public abstract String resourceAdapterJndiName
Specifies the JNDI name of the resource adapter that this MDB receives messages from.

Default:
"UNSPECIFIED"

remoteClientTimeout

public abstract String remoteClientTimeout
remote client timeout

Default:
"UNSPECIFIED"

timerPersistentStore

public abstract String timerPersistentStore
Specifies the name of a persistent store on the server's file system where WebLogic Server stores timer objects. If you do not specify a persistent store name, WebLogic Server stores timer objects in the default store.

Default:
"UNSPECIFIED"

Copyright 1996, 2014, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02