---
apiVersion: v1
kind: ConfigMap
metadata:
  labels:
    funktion.fabric8.io/kind: Connector
  name: sjms
data:
  deployment.yml: |
    ---
    apiVersion: extensions/v1beta1
    kind: Deployment
    metadata:
      labels:
        funktion.fabric8.io/kind: Subscription
        connector: sjms
    spec:
      replicas: 1
      template:
        metadata:
          labels:
            funktion.fabric8.io/kind: Subscription
            connector: sjms
        spec:
          containers:
          - image: funktion/connector-sjms:${project.version}
            name: connector
  schema.yml: |
    ---
    component:
      kind: component
      scheme: sjms
      syntax: sjms:destinationType:destinationName
      title: Simple JMS
      description: The sjms component (simple jms) allows messages to be sent to (or consumed from) a JMS Queue or Topic.
      label: messaging
      deprecated: false
      async: true
      javaType: org.apache.camel.component.sjms.SjmsComponent
      groupId: org.apache.camel
      artifactId: camel-sjms
      version: 2.18.3
    componentProperties:
      connectionFactory:
        kind: property
        type: object
        javaType: javax.jms.ConnectionFactory
        deprecated: false
        secret: false
        description: A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource.
        order: 0
      headerFilterStrategy:
        kind: property
        type: object
        javaType: org.apache.camel.spi.HeaderFilterStrategy
        deprecated: false
        secret: false
        description: To use a custom HeaderFilterStrategy to filter header to and from Camel message.
        order: 1
      connectionResource:
        kind: property
        type: object
        javaType: org.apache.camel.component.sjms.jms.ConnectionResource
        deprecated: false
        secret: false
        description: A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details.
        order: 2
      connectionCount:
        kind: property
        type: integer
        javaType: java.lang.Integer
        deprecated: false
        secret: false
        description: The maximum number of connections available to endpoints started under this component
        order: 3
      jmsKeyFormatStrategy:
        kind: property
        type: object
        javaType: org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy
        deprecated: false
        secret: false
        description: 'Pluggable strategy for encoding and decoding JMS keys so they can
          be compliant with the JMS specification. Camel provides one implementation out
          of the box: default. The default strategy will safely marshal dots and hyphens
          (. and -). Can be used for JMS brokers which do not care whether JMS header
          keys contain illegal characters. You can provide your own implementation of
          the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using
          the notation.'
        order: 4
      transactionCommitStrategy:
        kind: property
        type: object
        javaType: org.apache.camel.component.sjms.TransactionCommitStrategy
        deprecated: false
        secret: false
        description: To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch.
        order: 5
      destinationCreationStrategy:
        kind: property
        type: object
        javaType: org.apache.camel.component.sjms.jms.DestinationCreationStrategy
        deprecated: false
        secret: false
        description: To use a custom DestinationCreationStrategy.
        order: 6
      timedTaskManager:
        kind: property
        type: object
        javaType: org.apache.camel.component.sjms.taskmanager.TimedTaskManager
        deprecated: false
        secret: false
        description: To use a custom TimedTaskManager
        order: 7
      messageCreatedStrategy:
        kind: property
        type: object
        javaType: org.apache.camel.component.sjms.jms.MessageCreatedStrategy
        deprecated: false
        secret: false
        description: To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
        order: 8
    properties:
      destinationType:
        kind: path
        group: common
        type: string
        javaType: java.lang.String
        enum:
        - queue
        - topic
        deprecated: false
        secret: false
        defaultValue: queue
        description: The kind of destination to use
        order: 0
      destinationName:
        kind: path
        group: common
        required: true
        type: string
        javaType: java.lang.String
        deprecated: false
        secret: false
        description: DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name.
        order: 1
      acknowledgementMode:
        kind: parameter
        group: common
        type: string
        javaType: org.apache.camel.component.sjms.jms.SessionAcknowledgementType
        enum:
        - SESSION_TRANSACTED
        - CLIENT_ACKNOWLEDGE
        - AUTO_ACKNOWLEDGE
        - DUPS_OK_ACKNOWLEDGE
        deprecated: false
        secret: false
        defaultValue: AUTO_ACKNOWLEDGE
        description: 'The JMS acknowledgement name which is one of: SESSION_TRANSACTED
          CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE'
        order: 2
      bridgeErrorHandler:
        kind: parameter
        group: consumer
        label: consumer
        type: boolean
        javaType: boolean
        optionalPrefix: consumer.
        deprecated: false
        secret: false
        defaultValue: false
        description: Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
        order: 3
      consumerCount:
        kind: parameter
        group: consumer
        label: consumer
        type: integer
        javaType: int
        deprecated: false
        secret: false
        defaultValue: "1"
        description: Sets the number of consumer listeners used for this endpoint.
        order: 4
      durableSubscriptionId:
        kind: parameter
        group: consumer
        label: consumer
        type: string
        javaType: java.lang.String
        deprecated: false
        secret: false
        description: Sets the durable subscription Id required for durable topics.
        order: 5
      synchronous:
        kind: parameter
        group: consumer
        label: consumer
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: true
        description: Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
        order: 6
      exceptionHandler:
        kind: parameter
        group: consumer (advanced)
        label: consumer,advanced
        type: object
        javaType: org.apache.camel.spi.ExceptionHandler
        optionalPrefix: consumer.
        deprecated: false
        secret: false
        description: To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
        order: 7
      exchangePattern:
        kind: parameter
        group: consumer (advanced)
        label: consumer,advanced
        type: string
        javaType: org.apache.camel.ExchangePattern
        enum:
        - InOnly
        - RobustInOnly
        - InOut
        - InOptionalOut
        - OutOnly
        - RobustOutOnly
        - OutIn
        - OutOptionalIn
        deprecated: false
        secret: false
        description: Sets the exchange pattern when the consumer creates an exchange.
        order: 8
      messageSelector:
        kind: parameter
        group: consumer (advanced)
        label: consumer,advanced
        type: string
        javaType: java.lang.String
        deprecated: false
        secret: false
        description: Sets the JMS Message selector syntax.
        order: 9
      namedReplyTo:
        kind: parameter
        group: producer
        label: producer
        type: string
        javaType: java.lang.String
        deprecated: false
        secret: false
        description: Sets the reply to destination name used for InOut producer endpoints.
        order: 10
      persistent:
        kind: parameter
        group: producer
        label: producer
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: true
        description: Flag used to enable/disable message persistence.
        order: 11
      producerCount:
        kind: parameter
        group: producer
        label: producer
        type: integer
        javaType: int
        deprecated: false
        secret: false
        defaultValue: "1"
        description: Sets the number of producers used for this endpoint.
        order: 12
      ttl:
        kind: parameter
        group: producer
        label: producer
        type: integer
        javaType: long
        deprecated: false
        secret: false
        defaultValue: -1
        description: Flag used to adjust the Time To Live value of produced messages.
        order: 13
      allowNullBody:
        kind: parameter
        group: producer (advanced)
        label: producer,advanced
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: true
        description: Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
        order: 14
      prefillPool:
        kind: parameter
        group: producer (advanced)
        label: producer,advanced
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: true
        description: Whether to prefill the producer connection pool on startup or create connections lazy when needed.
        order: 15
      responseTimeOut:
        kind: parameter
        group: producer (advanced)
        label: producer,advanced
        type: integer
        javaType: long
        deprecated: false
        secret: false
        defaultValue: "5000"
        description: Sets the amount of time we should wait before timing out a InOut response.
        order: 16
      asyncStartListener:
        kind: parameter
        group: advanced
        label: advanced
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: false
        description: Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry.
        order: 17
      asyncStopListener:
        kind: parameter
        group: advanced
        label: advanced
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: false
        description: Whether to stop the consumer message listener asynchronously when stopping a route.
        order: 18
      connectionCount:
        kind: parameter
        group: advanced
        label: advanced
        type: integer
        javaType: java.lang.Integer
        deprecated: false
        secret: false
        description: The maximum number of connections available to this endpoint
        order: 19
      connectionFactory:
        kind: parameter
        group: advanced
        label: advanced
        type: object
        javaType: javax.jms.ConnectionFactory
        deprecated: false
        secret: false
        description: Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any
        order: 20
      connectionResource:
        kind: parameter
        group: advanced
        label: advanced
        type: object
        javaType: org.apache.camel.component.sjms.jms.ConnectionResource
        deprecated: false
        secret: false
        description: Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any
        order: 21
      destinationCreationStrategy:
        kind: parameter
        group: advanced
        label: advanced
        type: object
        javaType: org.apache.camel.component.sjms.jms.DestinationCreationStrategy
        deprecated: false
        secret: false
        description: To use a custom DestinationCreationStrategy.
        order: 22
      headerFilterStrategy:
        kind: parameter
        group: advanced
        label: advanced
        type: object
        javaType: org.apache.camel.spi.HeaderFilterStrategy
        deprecated: false
        secret: false
        description: To use a custom HeaderFilterStrategy to filter header to and from Camel message.
        order: 23
      includeAllJMSXProperties:
        kind: parameter
        group: advanced
        label: advanced
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: false
        description: 'Whether to include all JMSXxxx properties when mapping from JMS
          to Camel Message. Setting this to true will include properties such as JMSXAppID
          and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then
          this option does not apply.'
        order: 24
      jmsKeyFormatStrategy:
        kind: parameter
        group: advanced
        label: advanced
        type: object
        javaType: org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy
        deprecated: false
        secret: false
        description: 'Pluggable strategy for encoding and decoding JMS keys so they can
          be compliant with the JMS specification. Camel provides two implementations
          out of the box: default and passthrough. The default strategy will safely marshal
          dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can
          be used for JMS brokers which do not care whether JMS header keys contain illegal
          characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy
          and refer to it using the notation.'
        order: 25
      mapJmsMessage:
        kind: parameter
        group: advanced
        label: advanced
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: true
        description: Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
        order: 26
      messageCreatedStrategy:
        kind: parameter
        group: advanced
        label: advanced
        type: object
        javaType: org.apache.camel.component.sjms.jms.MessageCreatedStrategy
        deprecated: false
        secret: false
        description: To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
        order: 27
      transacted:
        kind: parameter
        group: transaction
        label: consumer,transaction
        type: boolean
        javaType: boolean
        deprecated: false
        secret: false
        defaultValue: false
        description: Specifies whether to use transacted mode
        order: 28
      transactionBatchCount:
        kind: parameter
        group: transaction
        label: consumer,transaction
        type: integer
        javaType: int
        deprecated: false
        secret: false
        defaultValue: -1
        description: If transacted sets the number of messages to process before committing a transaction.
        order: 29
      transactionBatchTimeout:
        kind: parameter
        group: transaction
        label: consumer,transaction
        type: integer
        javaType: long
        deprecated: false
        secret: false
        defaultValue: "5000"
        description: Sets timeout (in millis) for batch transactions the value should be 1000 or higher.
        order: 30
      transactionCommitStrategy:
        kind: parameter
        group: transaction
        label: transaction
        type: object
        javaType: org.apache.camel.component.sjms.TransactionCommitStrategy
        deprecated: false
        secret: false
        description: Sets the commit strategy.
        order: 31
  documentation.adoc: |
    ifdef::env-github[]
    :icon-smile: :smiley:
    :caution-caption: :boom:
    :important-caption: :exclamation:
    :note-caption: :information_source:
    :tip-caption: :bulb:
    :warning-caption: :warning:
    endif::[]

    ifndef::env-github[]
    :icons: font
    :icon-smile: icon:smile-o[fw,role=yellow]
    endif::[]

    [[ConfluenceContent]]
    [[SJMS-SJMSComponent]]
    SJMS Component
    ~~~~~~~~~~~~~~

    *Available as of Camel 2.11*

    The Simple JMS Component, or SJMS, is a JMS client for use with Camel
    that uses well known best practices when it comes to JMS client creation
    and configuration. SJMS contains a brand new JMS client API written
    explicitly for Camel eliminating third party messaging implementations
    keeping it light and resilient. The following features is included:

    * Standard Queue and Topic Support (Durable & Non-Durable)
    * InOnly & InOut MEP Support
    * Asynchronous Producer and Consumer Processing
    * Internal JMS Transaction Support

    Additional key features include:

    * Plugable Connection Resource Management
    * Session, Consumer, & Producer Pooling & Caching Management
    * Batch Consumers and Producers
    * Transacted Batch Consumers & Producers
    * Support for Customizable Transaction Commit Strategies (Local JMS
    Transactions only)

    [NOTE]
    ====
    *Why the S in SJMS*

    S stands for Simple and Standard and Springless. Also camel-jms was
    already taken. {icon-smile}
    ====

    Maven users will need to add the following dependency to their `pom.xml`
    for this component:

    [source,xml]
    ----
    <dependency>
        <groupId>org.apache.camel</groupId>
        <artifactId>camel-sjms</artifactId>
        <version>x.x.x</version>
        <!-- use the same version as your Camel core version -->
    </dependency>
    ----

    [[SJMS-URIformat]]
    URI format
    ++++++++++

    [source]
    ----
    sjms:[queue:|topic:]destinationName[?options]
    ----

    Where `destinationName` is a JMS queue or topic name. By default, the
    `destinationName` is interpreted as a queue name. For example, to
    connect to the queue, `FOO.BAR` use:

    [source]
    ----
    sjms:FOO.BAR
    ----

    You can include the optional `queue:` prefix, if you prefer:

    [source]
    ----
    sjms:queue:FOO.BAR
    ----

    To connect to a topic, you _must_ include the `topic:` prefix. For
    example, to connect to the topic, `Stocks.Prices`, use:

    [source]
    ----
    sjms:topic:Stocks.Prices
    ----

    You append query options to the URI using the following format,
    `?option=value&option=value&...`

    [[SJMS-ComponentOptionsandConfigurations]]
    Component Options and Configurations
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




    // component options: START
    The Simple JMS component supports 9 options which are listed below.



    {% raw %}
    [width="100%",cols="2,1m,7",options="header"]
    |=======================================================================
    | Name | Java Type | Description
    | connectionFactory | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource.
    | headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
    | connectionResource | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details.
    | connectionCount | Integer | The maximum number of connections available to endpoints started under this component
    | jmsKeyFormatStrategy | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
    | transactionCommitStrategy | TransactionCommitStrategy | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch.
    | destinationCreationStrategy | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
    | timedTaskManager | TimedTaskManager | To use a custom TimedTaskManager
    | messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
    |=======================================================================
    {% endraw %}
    // component options: END








    // endpoint options: START
    The Simple JMS component supports 32 endpoint options which are listed below:

    {% raw %}
    [width="100%",cols="2,1,1m,1m,5",options="header"]
    |=======================================================================
    | Name | Group | Default | Java Type | Description
    | destinationType | common | queue | String | The kind of destination to use
    | destinationName | common |  | String | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name.
    | acknowledgementMode | common | AUTO_ACKNOWLEDGE | SessionAcknowledgementType | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
    | bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
    | consumerCount | consumer | 1 | int | Sets the number of consumer listeners used for this endpoint.
    | durableSubscriptionId | consumer |  | String | Sets the durable subscription Id required for durable topics.
    | synchronous | consumer | true | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
    | exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
    | exchangePattern | consumer (advanced) |  | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
    | messageSelector | consumer (advanced) |  | String | Sets the JMS Message selector syntax.
    | namedReplyTo | producer |  | String | Sets the reply to destination name used for InOut producer endpoints.
    | persistent | producer | true | boolean | Flag used to enable/disable message persistence.
    | producerCount | producer | 1 | int | Sets the number of producers used for this endpoint.
    | ttl | producer | -1 | long | Flag used to adjust the Time To Live value of produced messages.
    | allowNullBody | producer (advanced) | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
    | prefillPool | producer (advanced) | true | boolean | Whether to prefill the producer connection pool on startup or create connections lazy when needed.
    | responseTimeOut | producer (advanced) | 5000 | long | Sets the amount of time we should wait before timing out a InOut response.
    | asyncStartListener | advanced | false | boolean | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry.
    | asyncStopListener | advanced | false | boolean | Whether to stop the consumer message listener asynchronously when stopping a route.
    | connectionCount | advanced |  | Integer | The maximum number of connections available to this endpoint
    | connectionFactory | advanced |  | ConnectionFactory | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any
    | connectionResource | advanced |  | ConnectionResource | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any
    | destinationCreationStrategy | advanced |  | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
    | headerFilterStrategy | advanced |  | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
    | includeAllJMSXProperties | advanced | false | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.
    | jmsKeyFormatStrategy | advanced |  | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
    | mapJmsMessage | advanced | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
    | messageCreatedStrategy | advanced |  | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
    | transacted | transaction | false | boolean | Specifies whether to use transacted mode
    | transactionBatchCount | transaction | -1 | int | If transacted sets the number of messages to process before committing a transaction.
    | transactionBatchTimeout | transaction | 5000 | long | Sets timeout (in millis) for batch transactions the value should be 1000 or higher.
    | transactionCommitStrategy | transaction |  | TransactionCommitStrategy | Sets the commit strategy.
    |=======================================================================
    {% endraw %}
    // endpoint options: END





    Below is an example of how to configure the `SjmsComponent` with its
    required `ConnectionFactory` provider. It will create a single connection
    by default and store it using the components internal pooling APIs to
    ensure that it is able to service Session creation requests in a thread
    safe manner.

    [source,java]
    ----
    SjmsComponent component = new SjmsComponent();
    component.setConnectionFactory(new ActiveMQConnectionFactory("tcp://localhost:61616"));
    getContext().addComponent("sjms", component);
    ----

    For a SJMS component that is required to support a durable subscription,
    you can override the default `ConnectionFactoryResource` instance and set
    the `clientId` property.

    [source,java]
    ----
    ConnectionFactoryResource connectionResource = new ConnectionFactoryResource();
    connectionResource.setConnectionFactory(new ActiveMQConnectionFactory("tcp://localhost:61616"));
    connectionResource.setClientId("myclient-id");

    SjmsComponent component = new SjmsComponent();
    component.setConnectionResource(connectionResource);
    component.setMaxConnections(1);
    ----

    [[SJMS-ProducerUsage]]
    Producer Usage
    ^^^^^^^^^^^^^^

    [[SJMS-InOnlyProducer]]
    InOnly Producer - (Default)
    +++++++++++++++++++++++++++

    The _InOnly_ producer is the default behavior of the SJMS Producer
    Endpoint.

    [source,java]
    ----
    from("direct:start")
        .to("sjms:queue:bar");
    ----

    [[SJMS-InOutProducer]]
    InOut Producer
    ++++++++++++++

    To enable _InOut_ behavior append the `exchangePattern` attribute to the
    URI. By default it will use a dedicated TemporaryQueue for each
    consumer.

    [source,java]
    ----
    from("direct:start")
        .to("sjms:queue:bar?exchangePattern=InOut");
    ----

    You can specify a `namedReplyTo` though which can provide a better
    monitor point.

    [source,java]
    ----
    from("direct:start")
        .to("sjms:queue:bar?exchangePattern=InOut&namedReplyTo=my.reply.to.queue");
    ----

    [[SJMS-ConsumerUsage]]
    Consumer Usage
    ^^^^^^^^^^^^^^

    [[SJMS-InOnlyConsumer]]
    InOnly Consumer - (Default)
    +++++++++++++++++++++++++++

    The _InOnly_ xonsumer is the default Exchange behavior of the SJMS
    Consumer Endpoint.

    [source,java]
    ----
    from("sjms:queue:bar")
        .to("mock:result");
    ----

    [[SJMS-InOutConsumer]]
    InOut Consumer
    ++++++++++++++

    To enable _InOut_ behavior append the `exchangePattern` attribute to the
    URI.

    [source,java]
    ----
    from("sjms:queue:in.out.test?exchangePattern=InOut")
        .transform(constant("Bye Camel"));
    ----

    [[SJMS-AdvancedUsageNotes]]
    Advanced Usage Notes
    ^^^^^^^^^^^^^^^^^^^^

    [[SJMS-PlugableConnectionResourceManagementconnectionresource]]
    Plugable Connection Resource Management [[SJMS-connectionresource]]
    +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

    SJMS provides JMS
    http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html[`Connection`]
    resource management through built-in connection pooling. This eliminates
    the need to depend on third party API pooling logic. However there may
    be times that you are required to use an external Connection resource
    manager such as those provided by J2EE or OSGi containers. For this SJMS
    provides an interface that can be used to override the internal SJMS
    Connection pooling capabilities. This is accomplished through the
    https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/jms/ConnectionResource.java[`ConnectionResource`]
    interface.

    The
    https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/jms/ConnectionResource.java[`ConnectionResource`]
    provides methods for borrowing and returning Connections as needed is
    the contract used to provide
    http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html[`Connection`]
    pools to the SJMS component. A user should use when it is necessary to
    integrate SJMS with an external connection pooling manager.

    It is recommended though that for standard
    http://docs.oracle.com/javaee/5/api/javax/jms/ConnectionFactory.html[`ConnectionFactory`]
    providers you use the
    https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/test/java/org/apache/camel/component/sjms/it/ConnectionResourceIT.java[`ConnectionFactoryResource`]
    implementation that is provided with SJMS as-is or extend as it is
    optimized for this component.

    Below is an example of using the plugable ConnectionResource with the
    ActiveMQ `PooledConnectionFactory`:

    [source,java]
    ----
    public class AMQConnectionResource implements ConnectionResource {
        private PooledConnectionFactory pcf;

        public AMQConnectionResource(String connectString, int maxConnections) {
            super();
            pcf = new PooledConnectionFactory(connectString);
            pcf.setMaxConnections(maxConnections);
            pcf.start();
        }

        public void stop() {
            pcf.stop();
        }

        @Override
        public Connection borrowConnection() throws Exception {
            Connection answer = pcf.createConnection();
            answer.start();
            return answer;
        }

        @Override
        public Connection borrowConnection(long timeout) throws Exception {
            // SNIPPED...
        }

        @Override
        public void returnConnection(Connection connection) throws Exception {
            // Do nothing since there isn't a way to return a Connection
            // to the instance of PooledConnectionFactory
            log.info("Connection returned");
        }
    }
    ----

    Then pass in the `ConnectionResource` to the `SjmsComponent`:

    [source,java]
    ----
    CamelContext camelContext = new DefaultCamelContext();
    AMQConnectionResource pool = new AMQConnectionResource("tcp://localhost:33333", 1);
    SjmsComponent component = new SjmsComponent();
    component.setConnectionResource(pool);
    camelContext.addComponent("sjms", component);
    ----

    To see the full example of its usage please refer to the
    https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/test/java/org/apache/camel/component/sjms/it/ConnectionResourceIT.java[`ConnectionResourceIT`].

    [[SJMS-Session,Consumer,&ProducerPooling&CachingManagement]]
    Session, Consumer, & Producer Pooling & Caching Management
    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

    Coming soon ...

    [[SJMS-BatchMessageSupport]]
    Batch Message Support
    +++++++++++++++++++++

    The SjmsProducer supports publishing a collection of messages by
    creating an Exchange that encapsulates a `List`. This SjmsProducer will
    take then iterate through the contents of the List and publish each
    message individually.

    If when producing a batch of messages there is the need to set headers
    that are unique to each message you can use the SJMS
    https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/BatchMessage.java[`BatchMessage`]
    class. When the SjmsProducer encounters a `BatchMessage` list it will
    iterate each `BatchMessage` and publish the included payload and headers.

    Below is an example of using the BatchMessage class. First we create a
    list of `BatchMessage`:

    [source,java]
    ----
    List<BatchMessage<String>> messages = new ArrayList<BatchMessage<String>>();
    for (int i = 1; i <= messageCount; i++) {
        String body = "Hello World " + i;
        BatchMessage<String> message = new BatchMessage<String>(body, null);
        messages.add(message);
    }
    ----

    Then publish the list:

    [source,java]
    ----
    template.sendBody("sjms:queue:batch.queue", messages);
    ----

    [[SJMS-CustomizableTransactionCommitStrategies]]
    Customizable Transaction Commit Strategies (Local JMS Transactions only)
    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

    SJMS provides a developer the means to create a custom and plugable
    transaction strategy through the use of the
    https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/TransactionCommitStrategy.java[`TransactionCommitStrategy`]
    interface. This allows a user to define a unique set of circumstances
    that the
    https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/tx/SessionTransactionSynchronization.java[`SessionTransactionSynchronization`]
    will use to determine when to commit the Session. An example of its use
    is the
    https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/tx/BatchTransactionCommitStrategy.java[`BatchTransactionCommitStrategy`]
    which is detailed further in the next section.

    [[SJMS-TransactedBatchConsumersAndProducers]]
    Transacted Batch Consumers & Producers
    ++++++++++++++++++++++++++++++++++++++

    The SJMS component has been designed to support the batching of local JMS
    transactions on both the Producer and Consumer endpoints. How they are
    handled on each is very different though.

    The SJMS consumer endpoint is a straightforward implementation that will
    process X messages before committing them with the associated Session.
    To enable batched transaction on the consumer first enable transactions
    by setting the `transacted` parameter to true and then adding the
    `transactionBatchCount` and setting it to any value that is greater than
    0. For example the following configuration will commit the Session every
    10 messages:

    [source]
    ----
    sjms:queue:transacted.batch.consumer?transacted=true&transactionBatchCount=10
    ----

    If an exception occurs during the processing of a batch on the consumer
    endpoint, the Session rollback is invoked causing the messages to be
    redelivered to the next available consumer. The counter is also reset to
    0 for the `BatchTransactionCommitStrategy` for the associated Session as
    well. It is the responsibility of the user to ensure they put hooks in
    their processors of batch messages to watch for messages with the
    JMSRedelivered header set to true. This is the indicator that messages
    were rolled back at some point and that a verification of a successful
    processing should occur.

    A transacted batch consumer also carries with it an instance of an
    internal timer that waits a default amount of time (5000ms) between
    messages before committing the open transactions on the Session. The
    default value of 5000ms (minimum of 1000ms) should be adequate for most
    use-cases but if further tuning is necessary simply set the
    `transactionBatchTimeout` parameter.

    [source]
    ----
    sjms:queue:transacted.batch.consumer?transacted=true&transactionBatchCount=10&transactionBatchTimeout=2000
    ----

    The minimal value that will be accepted is 1000ms as the amount of
    context switching may cause unnecessary performance impacts without
    gaining benefit.

    The producer endpoint is handled much differently though. With the
    producer after each message is delivered to its destination the Exchange
    is closed and there is no longer a reference to that message. To make a
    available all the messages available for redelivery you simply enable
    transactions on a Producer Endpoint that is publishing BatchMessages.
    The transaction will commit at the conclusion of the exchange which
    includes all messages in the batch list. Nothing additional need be
    configured. For example:

    [source,java]
    ----
    List<BatchMessage<String>> messages = new ArrayList<BatchMessage<String>>();
    for (int i = 1; i <= messageCount; i++) {
        String body = "Hello World " + i;
        BatchMessage<String> message = new BatchMessage<String>(body, null);
        messages.add(message);
    }
    ----

    Now publish the List with transactions enabled:

    [source,java]
    ----
    template.sendBody("sjms:queue:batch.queue?transacted=true", messages);
    ----

    [[SJMS-AdditionalNotes]]
    Additional Notes
    ^^^^^^^^^^^^^^^^

    [[SJMS-MessageHeaderFormat]]
    Message Header Format
    +++++++++++++++++++++

    The SJMS Component uses the same header format strategy that is used in
    the Camel JMS Component. This plugable strategy ensures that messages
    sent over the wire conform to the JMS Message spec.

    For the `exchange.in.header` the following rules apply for the header
    keys:

    * Keys starting with `JMS` or `JMSX` are reserved.
    * `exchange.in.headers` keys must be literals and all be valid Java
    identifiers (do not use dots in the key name).
    * Camel replaces dots & hyphens and the reverse when when consuming JMS
    messages:

    ** is replaced by _DOT_ and the reverse replacement when Camel consumes
    the message.
    ** is replaced by _HYPHEN_ and the reverse replacement when Camel
    consumes the message. +
    See also the option `jmsKeyFormatStrategy`, which allows use of your own
    custom strategy for formatting keys.

    For the `exchange.in.header`, the following rules apply for the header
    values:

    [[SJMS-MessageContent]]
    Message Content
    +++++++++++++++

    To deliver content over the wire we must ensure that the body of the
    message that is being delivered adheres to the JMS Message
    Specification. Therefore, all that are produced must either be
    primitives or their counter objects (such as `Integer`, `Long`, `Character`).
    The types, `String`, `CharSequence`, `Date`, `BigDecimal` and `BigInteger` are all
    converted to their `toString()` representation. All other types are
    dropped.

    [[SJMS-Clustering]]
    Clustering
    ++++++++++

    When using _InOut_ with SJMS in a clustered environment you must either
    use TemporaryQueue destinations or use a unique named reply to
    destination per InOut producer endpoint. Message correlation is handled
    by the endpoint, not with message selectors at the broker. The InOut
    Producer Endpoint uses Java Concurrency Exchangers cached by the Message
    `JMSCorrelationID`. This provides a nice performance increase while
    reducing the overhead on the broker since all the messages are consumed
    from the destination in the order they are produced by the interested
    consumer.

    Currently the only correlation strategy is to use the `JMSCorrelationId`.
    The _InOut_ Consumer uses this strategy as well ensuring that all
    responses messages to the included `JMSReplyTo` destination also have the
    `JMSCorrelationId` copied from the request as well.

    [[SJMS-TransactionSupporttransactions]]
    Transaction Support [[SJMS-transactions]]
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    SJMS currently only supports the use of internal JMS Transactions. There
    is no support for the Camel Transaction Processor or the Java
    Transaction API (JTA).

    [[SJMS-DoesSpringlessMeanICantUseSpring]]
    Does Springless Mean I Can't Use Spring?
    ++++++++++++++++++++++++++++++++++++++++

    Not at all. Below is an example of the SJMS component using the Spring
    DSL:

    [source,java]
    ----
    <route
        id="inout.named.reply.to.producer.route">
        <from
            uri="direct:invoke.named.reply.to.queue" />
        <to
            uri="sjms:queue:named.reply.to.queue?namedReplyTo=my.response.queue&amp;exchangePattern=InOut" />
    </route>
    ----

    Springless refers to moving away from the dependency on the Spring JMS
    API. A new JMS client API is being developed from the ground up to power
    SJMS.
