CometdEndpointBuilderFactory.CometdEndpointProducerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

CometdEndpointBuilderFactory.CometdEndpointBuilder

Enclosing interface:

CometdEndpointBuilderFactory
```
public static interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint producers for the CometD component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default CometdEndpointBuilderFactory.AdvancedCometdEndpointProducerBuilder`	`advanced()`
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`allowedOrigins(String allowedOrigins)` The origins domain that support to cross, if the crosssOriginFilterOn is true.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`baseResource(String baseResource)` The root directory for the web resources or classpath.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`crossOriginFilterOn(boolean crossOriginFilterOn)` If true, the server will support for cross-domain filtering.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`crossOriginFilterOn(String crossOriginFilterOn)` If true, the server will support for cross-domain filtering.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`disconnectLocalSession(boolean disconnectLocalSession)` Whether to disconnect local sessions after publishing a message to its channel.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`disconnectLocalSession(String disconnectLocalSession)` Whether to disconnect local sessions after publishing a message to its channel.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`filterPath(String filterPath)` The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`interval(int interval)` The client side poll timeout in milliseconds.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`interval(String interval)` The client side poll timeout in milliseconds.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`jsonCommented(boolean jsonCommented)` If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`jsonCommented(String jsonCommented)` If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`logLevel(int logLevel)` Logging level.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`logLevel(String logLevel)` Logging level.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`maxInterval(int maxInterval)` The max client side poll timeout in milliseconds.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`maxInterval(String maxInterval)` The max client side poll timeout in milliseconds.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`multiFrameInterval(int multiFrameInterval)` The client side poll timeout, if multiple connections are detected from the same browser.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`multiFrameInterval(String multiFrameInterval)` The client side poll timeout, if multiple connections are detected from the same browser.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`timeout(int timeout)` The server side poll timeout in milliseconds.
`default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder`	`timeout(String timeout)` The server side poll timeout in milliseconds.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

- Method Detail
  - advanced
```
default CometdEndpointBuilderFactory.AdvancedCometdEndpointProducerBuilder advanced()
```
  - allowedOrigins
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder allowedOrigins(String allowedOrigins)
```
    The origins domain that support to cross, if the crosssOriginFilterOn is true. The option is a: <code>java.lang.String</code> type. Default: * Group: common
    
    Parameters:
    
    allowedOrigins - the value to set
    
    Returns:
    
    the dsl builder
  - baseResource
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder baseResource(String baseResource)
```
    The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    baseResource - the value to set
    
    Returns:
    
    the dsl builder
  - crossOriginFilterOn
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder crossOriginFilterOn(boolean crossOriginFilterOn)
```
    If true, the server will support for cross-domain filtering. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    crossOriginFilterOn - the value to set
    
    Returns:
    
    the dsl builder
  - crossOriginFilterOn
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder crossOriginFilterOn(String crossOriginFilterOn)
```
    If true, the server will support for cross-domain filtering. The option will be converted to a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    crossOriginFilterOn - the value to set
    
    Returns:
    
    the dsl builder
  - filterPath
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder filterPath(String filterPath)
```
    The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    filterPath - the value to set
    
    Returns:
    
    the dsl builder
  - interval
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder interval(int interval)
```
    The client side poll timeout in milliseconds. How long a client will wait between reconnects. The option is a: <code>int</code> type. Group: common
    
    Parameters:
    
    interval - the value to set
    
    Returns:
    
    the dsl builder
  - interval
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder interval(String interval)
```
    The client side poll timeout in milliseconds. How long a client will wait between reconnects. The option will be converted to a <code>int</code> type. Group: common
    
    Parameters:
    
    interval - the value to set
    
    Returns:
    
    the dsl builder
  - jsonCommented
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder jsonCommented(boolean jsonCommented)
```
    If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking. The option is a: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    jsonCommented - the value to set
    
    Returns:
    
    the dsl builder
  - jsonCommented
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder jsonCommented(String jsonCommented)
```
    If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking. The option will be converted to a <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    jsonCommented - the value to set
    
    Returns:
    
    the dsl builder
  - logLevel
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder logLevel(int logLevel)
```
    Logging level. 0=none, 1=info, 2=debug. The option is a: <code>int</code> type. Default: 1 Group: common
    
    Parameters:
    
    logLevel - the value to set
    
    Returns:
    
    the dsl builder
  - logLevel
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder logLevel(String logLevel)
```
    Logging level. 0=none, 1=info, 2=debug. The option will be converted to a <code>int</code> type. Default: 1 Group: common
    
    Parameters:
    
    logLevel - the value to set
    
    Returns:
    
    the dsl builder
  - maxInterval
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder maxInterval(int maxInterval)
```
    The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time. The option is a: <code>int</code> type. Default: 30000 Group: common
    
    Parameters:
    
    maxInterval - the value to set
    
    Returns:
    
    the dsl builder
  - maxInterval
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder maxInterval(String maxInterval)
```
    The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time. The option will be converted to a <code>int</code> type. Default: 30000 Group: common
    
    Parameters:
    
    maxInterval - the value to set
    
    Returns:
    
    the dsl builder
  - multiFrameInterval
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder multiFrameInterval(int multiFrameInterval)
```
    The client side poll timeout, if multiple connections are detected from the same browser. The option is a: <code>int</code> type. Default: 1500 Group: common
    
    Parameters:
    
    multiFrameInterval - the value to set
    
    Returns:
    
    the dsl builder
  - multiFrameInterval
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder multiFrameInterval(String multiFrameInterval)
```
    The client side poll timeout, if multiple connections are detected from the same browser. The option will be converted to a <code>int</code> type. Default: 1500 Group: common
    
    Parameters:
    
    multiFrameInterval - the value to set
    
    Returns:
    
    the dsl builder
  - timeout
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder timeout(int timeout)
```
    The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding. The option is a: <code>int</code> type. Default: 240000 Group: common
    
    Parameters:
    
    timeout - the value to set
    
    Returns:
    
    the dsl builder
  - timeout
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder timeout(String timeout)
```
    The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding. The option will be converted to a <code>int</code> type. Default: 240000 Group: common
    
    Parameters:
    
    timeout - the value to set
    
    Returns:
    
    the dsl builder
  - disconnectLocalSession
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder disconnectLocalSession(boolean disconnectLocalSession)
```
    Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    disconnectLocalSession - the value to set
    
    Returns:
    
    the dsl builder
  - disconnectLocalSession
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder disconnectLocalSession(String disconnectLocalSession)
```
    Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    disconnectLocalSession - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default CometdEndpointBuilderFactory.CometdEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder

Interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

allowedOrigins

baseResource

crossOriginFilterOn

crossOriginFilterOn

filterPath

interval

interval

jsonCommented

jsonCommented

logLevel

logLevel

maxInterval

maxInterval

multiFrameInterval

multiFrameInterval

timeout

timeout

disconnectLocalSession

disconnectLocalSession

lazyStartProducer

lazyStartProducer