org.apache.camel.builder.endpoint.dsl

Interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

CometdEndpointBuilderFactory.CometdEndpointBuilder

Enclosing interface:

CometdEndpointBuilderFactory

public static interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the CometD component.

Method Summary

Modifier and Type	Method and Description
default CometdEndpointBuilderFactory.AdvancedCometdEndpointConsumerBuilder	advanced()
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	allowedOrigins(String allowedOrigins) The origins domain that support to cross, if the crosssOriginFilterOn is true.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	baseResource(String baseResource) The root directory for the web resources or classpath.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	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.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	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.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	crossOriginFilterOn(boolean crossOriginFilterOn) If true, the server will support for cross-domain filtering.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	crossOriginFilterOn(String crossOriginFilterOn) If true, the server will support for cross-domain filtering.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	filterPath(String filterPath) The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	interval(int interval) The client side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	interval(String interval) The client side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	jsonCommented(boolean jsonCommented) If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	jsonCommented(String jsonCommented) If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	logLevel(int logLevel) Logging level.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	logLevel(String logLevel) Logging level.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	maxInterval(int maxInterval) The max client side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	maxInterval(String maxInterval) The max client side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	multiFrameInterval(int multiFrameInterval) The client side poll timeout, if multiple connections are detected from the same browser.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	multiFrameInterval(String multiFrameInterval) The client side poll timeout, if multiple connections are detected from the same browser.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	sessionHeadersEnabled(boolean sessionHeadersEnabled) Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	sessionHeadersEnabled(String sessionHeadersEnabled) Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	timeout(int timeout) The server side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder	timeout(String timeout) The server side poll timeout in milliseconds.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default CometdEndpointBuilderFactory.AdvancedCometdEndpointConsumerBuilder advanced()

allowedOrigins

default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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.CometdEndpointConsumerBuilder 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

bridgeErrorHandler

default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

sessionHeadersEnabled

default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder sessionHeadersEnabled(boolean sessionHeadersEnabled)

Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

sessionHeadersEnabled - the value to set

Returns:

the dsl builder

sessionHeadersEnabled

default CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder sessionHeadersEnabled(String sessionHeadersEnabled)

Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

sessionHeadersEnabled - the value to set

Returns:

the dsl builder