Interface XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    XmppEndpointBuilderFactory.XmppEndpointBuilder
    Enclosing interface:
    XmppEndpointBuilderFactory

    public static interface XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder
    extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the XMPP component.
    • Method Detail

      • room

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder room​(String room)
        If this option is specified, the component will connect to MUC (Multi User Chat). Usually, the domain name for MUC is different from the login domain. For example, if you are supermanjabber.org and want to join the krypton room, then the room URL is kryptonconference.jabber.org. Note the conference part. It is not a requirement to provide the full room JID. If the room parameter does not contain the symbol, the domain part will be discovered and added by Camel. The option is a: java.lang.String type. Group: common
      • testConnectionOnStartup

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder testConnectionOnStartup​(boolean testConnectionOnStartup)
        Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false, Camel will attempt to establish a lazy connection when needed by a producer, and will poll for a consumer connection until the connection is established. Default is true. The option is a: boolean type. Default: true Group: common
      • testConnectionOnStartup

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder testConnectionOnStartup​(String testConnectionOnStartup)
        Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false, Camel will attempt to establish a lazy connection when needed by a producer, and will poll for a consumer connection until the connection is established. Default is true. The option will be converted to a boolean type. Default: true Group: common
      • bridgeErrorHandler

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        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 or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer
      • bridgeErrorHandler

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        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 or ERROR level and ignored. The option will be converted to a boolean type. Default: false Group: consumer
      • connectionPollDelay

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder connectionPollDelay​(int connectionPollDelay)
        The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection, or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds. The option is a: int type. Default: 10 Group: consumer
      • connectionPollDelay

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder connectionPollDelay​(String connectionPollDelay)
        The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection, or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds. The option will be converted to a int type. Default: 10 Group: consumer
      • doc

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder doc​(boolean doc)
        Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true, otherwise false. The option is a: boolean type. Default: false Group: consumer
      • doc

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder doc​(String doc)
        Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true, otherwise false. The option will be converted to a boolean type. Default: false Group: consumer
      • headerFilterStrategy

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder headerFilterStrategy​(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
        To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: filter
      • headerFilterStrategy

        default XmppEndpointBuilderFactory.XmppEndpointConsumerBuilder headerFilterStrategy​(String headerFilterStrategy)
        To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: filter