attributeGroup "jmsConnectorAttributes"

Namespace:	http://www.mulesoft.org/schema/mule/jms
Content:	22 attributes
Defined:	globally in mule-jms.xsd; see XML source
Includes:	definitions of 22 attributes
Used:	at 3 locations

XML Representation Summary

<...

redeliveryHandlerFactory-ref	=	xsd:string
acknowledgementMode	=	("AUTO_ACKNOWLEDGE" \| "CLIENT_ACKNOWLEDGE" \| "DUPS_OK_ACKNOWLEDGE") : "AUTO_ACKNOWLEDGE"
clientId	=	xsd:string
durable	=	(xsd:string \| xsd:boolean)
noLocal	=	(xsd:string \| xsd:boolean)
persistentDelivery	=	(xsd:string \| xsd:boolean)
honorQosHeaders	=	(xsd:string \| xsd:boolean)
maxRedelivery	=	(xsd:string \| xsd:int)
cacheJmsSessions	=	(xsd:string \| xsd:boolean)
eagerConsumer	=	(xsd:string \| xsd:boolean)
specification	=	("1.0.2b" \| "1.1") : "1.0.2b"
username	=	xsd:string
password	=	xsd:string
numberOfConsumers	=	(xsd:string \| xsd:int)
jndiInitialFactory	=	xsd:string
jndiProviderUrl	=	xsd:string
jndiProviderProperties-ref	=	xsd:string
connectionFactoryJndiName	=	xsd:string
jndiDestinations	=	xsd:boolean
forceJndiDestinations	=	xsd:boolean
disableTemporaryReplyToDestinations	=	xsd:boolean
embeddedMode	=	xsd:boolean : "false"

...>

Known Usage Locations

In definitions of global complexTypes (2):
genericConnectorType, vendorJmsConnectorType
In definitions of anonymous complexTypes of elements (1):
custom-connector

XML Source (w/o annotations (22); see within schema source)

<xsd:attributeGroup name="jmsConnectorAttributes">

<xsd:attribute name="redeliveryHandlerFactory-ref" type="xsd:string"/>

<xsd:attribute default="AUTO_ACKNOWLEDGE" name="acknowledgementMode">

<xsd:simpleType>

<xsd:restriction base="xsd:NMTOKEN">

<xsd:enumeration value="AUTO_ACKNOWLEDGE"/>

<xsd:enumeration value="CLIENT_ACKNOWLEDGE"/>

<xsd:enumeration value="DUPS_OK_ACKNOWLEDGE"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:attribute>

<xsd:attribute name="clientId" type="xsd:string"/>

<xsd:attribute name="durable" type="mule:substitutableBoolean"/>

<xsd:attribute name="noLocal" type="mule:substitutableBoolean"/>

<xsd:attribute name="persistentDelivery" type="mule:substitutableBoolean"/>

<xsd:attribute name="honorQosHeaders" type="mule:substitutableBoolean"/>

<xsd:attribute name="maxRedelivery" type="mule:substitutableInt"/>

<xsd:attribute name="cacheJmsSessions" type="mule:substitutableBoolean"/>

<xsd:attribute name="eagerConsumer" type="mule:substitutableBoolean"/>

<xsd:attribute default="1.0.2b" name="specification">

<xsd:simpleType>

<xsd:restriction base="xsd:NMTOKEN">

<xsd:enumeration value="1.0.2b"/>

<xsd:enumeration value="1.1"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:attribute>

<xsd:attribute name="username" type="xsd:string"/>

<xsd:attribute name="password" type="xsd:string"/>

<xsd:attribute name="numberOfConsumers" type="mule:substitutableInt"/>

<xsd:attribute name="jndiInitialFactory" type="xsd:string"/>

<xsd:attribute name="jndiProviderUrl" type="xsd:string"/>

<xsd:attribute name="jndiProviderProperties-ref" type="xsd:string"/>

<xsd:attribute name="connectionFactoryJndiName" type="xsd:string"/>

<xsd:attribute name="jndiDestinations" type="xsd:boolean"/>

<xsd:attribute name="forceJndiDestinations" type="xsd:boolean"/>

<xsd:attribute name="disableTemporaryReplyToDestinations" type="xsd:boolean"/>

<xsd:attribute default="false" name="embeddedMode" type="xsd:boolean"/>

</xsd:attributeGroup>

Attribute Detail (all declarations; defined within this component only; 22/22)

acknowledgementMode

Type:	anonymous simpleType (restriction of xsd:NMTOKEN)
Use:	optional

The acknowledgement mode to use: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, or DUPS_OK_ACKNOWLEDGE.

Attribute Value

enumeration of xsd:NMTOKEN

Enumeration:	"AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE"
Default:	"AUTO_ACKNOWLEDGE"

Anonymous simpleType

Type Derivation Tree

xsd:NMTOKEN (restriction)

simpleType

Derivation:

restriction of xsd:NMTOKEN

Facets:

enumeration:

"AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE"

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute default="AUTO_ACKNOWLEDGE" name="acknowledgementMode">

<xsd:simpleType>

<xsd:restriction base="xsd:NMTOKEN">

<xsd:enumeration value="AUTO_ACKNOWLEDGE"/>

<xsd:enumeration value="CLIENT_ACKNOWLEDGE"/>

<xsd:enumeration value="DUPS_OK_ACKNOWLEDGE"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:attribute>

cacheJmsSessions

Type:	mule:substitutableBoolean
Use:	optional

Whether to cache and re-use the JMS session object instead of recreating the connection each time. NOTE: meant for non-transactional use ONLY.

Attribute Value

xsd:string | xsd:boolean

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="cacheJmsSessions" type="mule:substitutableBoolean"/>

clientId

Type:	xsd:string, predefined
Use:	optional

The ID of the JMS client.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="clientId" type="xsd:string"/>

connectionFactoryJndiName

Type:	xsd:string, predefined
Use:	optional

The name to use when looking up the connection factory from JNDI.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="connectionFactoryJndiName" type="xsd:string"/>

disableTemporaryReplyToDestinations

Type:	xsd:boolean, predefined
Use:	optional

If this is set to false (the default), when Mule performs request/response calls a temporary destination will automatically be set up to receive a response from the remote JMS call.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="disableTemporaryReplyToDestinations" type="xsd:boolean"/>

durable

Type:	mule:substitutableBoolean
Use:	optional

Whether to make all topic subscribers durable.

Attribute Value

xsd:string | xsd:boolean

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="durable" type="mule:substitutableBoolean"/>

eagerConsumer

Type:	mule:substitutableBoolean
Use:	optional

Whether to create a consumer right when the connection is created instead of using lazy instantiation in the poll loop.

Attribute Value

xsd:string | xsd:boolean

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="eagerConsumer" type="mule:substitutableBoolean"/>

embeddedMode

Type:	xsd:boolean, predefined
Use:	optional

Some application servers, like WebSphere AS, don't allow certain methods to be called on JMS objects, effectively limiting available features. Embedded mode tells Mule to avoid those whenever possible. Default is false.

Attribute Value

Default:

"false"

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute default="false" name="embeddedMode" type="xsd:boolean"/>

forceJndiDestinations

Type:	xsd:boolean, predefined
Use:	optional

If set to true, Mule fails when a topic or queue cannot be retrieved from JNDI. If set to false, Mule will create a topic or queue from the JMS session if the JNDI lookup fails.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="forceJndiDestinations" type="xsd:boolean"/>

honorQosHeaders

Type:	mule:substitutableBoolean
Use:	optional

If set to true, the message's QoS headers are honored. If false (the default), the connector settings override the message headers.

Attribute Value

xsd:string | xsd:boolean

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="honorQosHeaders" type="mule:substitutableBoolean"/>

jndiDestinations

Type:	xsd:boolean, predefined
Use:	optional

Set this attribute to true if you want to look up queues or topics from JNDI instead of creating them from the session.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="jndiDestinations" type="xsd:boolean"/>

jndiInitialFactory

Type:	xsd:string, predefined
Use:	optional

The initial factory class to use when connecting to JNDI. DEPRECATED: use jndiNameResolver-ref propertie to configure this value.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="jndiInitialFactory" type="xsd:string"/>

jndiProviderProperties-ref

Type:	xsd:string, predefined
Use:	optional

Reference to a Map that contains additional provider properties. DEPRECATED: use jndiNameResolver-ref propertie to configure this value.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="jndiProviderProperties-ref" type="xsd:string"/>

jndiProviderUrl

Type:	xsd:string, predefined
Use:	optional

The URL to use when connecting to JNDI. DEPRECATED: use jndiNameResolver-ref propertie to configure this value.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="jndiProviderUrl" type="xsd:string"/>

maxRedelivery

Type:	mule:substitutableInt
Use:	optional

The maximum number of times to try to redeliver a message. Use -1 to accept messages with any redelivery count.

Attribute Value

xsd:string | xsd:int

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="maxRedelivery" type="mule:substitutableInt"/>

noLocal

Type:	mule:substitutableBoolean
Use:	optional

If set to true, a subscriber will not receive messages that were published by its own connection.

Attribute Value

xsd:string | xsd:boolean

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="noLocal" type="mule:substitutableBoolean"/>

numberOfConsumers

Type:	mule:substitutableInt
Use:	optional

The number of concurrent consumers that will be used to receive JMS messages. (Note: If you use this attribute, you should not configure the 'numberOfConcurrentTransactedReceivers', which has the same effect.)

Attribute Value

xsd:string | xsd:int

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="numberOfConsumers" type="mule:substitutableInt"/>

password

Type:	xsd:string, predefined
Use:	optional

The password for the connection

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="password" type="xsd:string"/>

persistentDelivery

Type:	mule:substitutableBoolean
Use:	optional

If set to true, the JMS provider logs the message to stable storage as it is sent so that it can be recovered if delivery is unsuccessful. A client marks a message as persistent if it feels that the application will have problems if the message is lost in transit. A client marks a message as non-persistent if an occasional lost message is tolerable. Clients use delivery mode to tell a JMS provider how to balance message transport reliability/throughput. Delivery mode only covers the transport of the message to its destination. Retention of a message at the destination until its receipt is acknowledged is not guaranteed by a PERSISTENT delivery mode. Clients should assume that message retention policies are set administratively. Message retention policy governs the reliability of message delivery from destination to message consumer. For example, if a client's message storage space is exhausted, some messages as defined by a site specific message retention policy may be dropped. A message is guaranteed to be delivered once-and-only-once by a JMS Provider if the delivery mode of the messge is persistent and if the destination has a sufficient message retention policy.

Attribute Value

xsd:string | xsd:boolean

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="persistentDelivery" type="mule:substitutableBoolean"/>

redeliveryHandlerFactory-ref

Type:	xsd:string, predefined
Use:	optional

Reference to the redelivery handler.

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="redeliveryHandlerFactory-ref" type="xsd:string"/>

specification

Type:	anonymous simpleType (restriction of xsd:NMTOKEN)
Use:	optional

The JMS specification to use: 1.0.2b (the default) or 1.1

Attribute Value

enumeration of xsd:NMTOKEN

Enumeration:	"1.0.2b", "1.1"
Default:	"1.0.2b"

Anonymous simpleType

Type Derivation Tree

xsd:NMTOKEN (restriction)

simpleType

Derivation:

restriction of xsd:NMTOKEN

Facets:

enumeration:

"1.0.2b", "1.1"

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute default="1.0.2b" name="specification">

<xsd:simpleType>

<xsd:restriction base="xsd:NMTOKEN">

<xsd:enumeration value="1.0.2b"/>

<xsd:enumeration value="1.1"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:attribute>

username

Type:	xsd:string, predefined
Use:	optional

The user name for the connection

XML Source (w/o annotations (1); see within schema source)

<xsd:attribute name="username" type="xsd:string"/>

XML schema documentation generated with DocFlex/XML RE 1.8.5 using DocFlex/XML XSDDoc 2.5.0 template set. All content model diagrams generated by Altova XMLSpy via DocFlex/XML XMLSpy Integration.