org.apache.camel.builder.endpoint.dsl

Interface CometdEndpointBuilderFactory.CometdEndpointBuilder

All Superinterfaces:

CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder, CometdEndpointBuilderFactory.CometdEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

CometdEndpointBuilderFactory

public static interface CometdEndpointBuilderFactory.CometdEndpointBuilder
extends CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder, CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Builder for endpoint for the CometD component.

Method Summary

Modifier and Type	Method and Description
default CometdEndpointBuilderFactory.AdvancedCometdEndpointBuilder	advanced()
default CometdEndpointBuilderFactory.CometdEndpointBuilder	allowedOrigins(String allowedOrigins) The origins domain that support to cross, if the crosssOriginFilterOn is true.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	baseResource(String baseResource) The root directory for the web resources or classpath.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	crossOriginFilterOn(boolean crossOriginFilterOn) If true, the server will support for cross-domain filtering.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	crossOriginFilterOn(String crossOriginFilterOn) If true, the server will support for cross-domain filtering.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	filterPath(String filterPath) The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	interval(int interval) The client side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	interval(String interval) The client side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	jsonCommented(boolean jsonCommented) If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	jsonCommented(String jsonCommented) If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	logLevel(int logLevel) Logging level.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	logLevel(String logLevel) Logging level.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	maxInterval(int maxInterval) The max client side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	maxInterval(String maxInterval) The max client side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	multiFrameInterval(int multiFrameInterval) The client side poll timeout, if multiple connections are detected from the same browser.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	multiFrameInterval(String multiFrameInterval) The client side poll timeout, if multiple connections are detected from the same browser.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	timeout(int timeout) The server side poll timeout in milliseconds.
default CometdEndpointBuilderFactory.CometdEndpointBuilder	timeout(String timeout) The server side poll timeout in milliseconds.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, sessionHeadersEnabled, sessionHeadersEnabled

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

disconnectLocalSession, disconnectLocalSession, lazyStartProducer, lazyStartProducer

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default CometdEndpointBuilderFactory.AdvancedCometdEndpointBuilder advanced()

Specified by:

advanced in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

advanced in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

allowedOrigins

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

Specified by:

allowedOrigins in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

allowedOrigins in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

allowedOrigins - the value to set

Returns:

the dsl builder

baseResource

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

Specified by:

baseResource in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

baseResource in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

baseResource - the value to set

Returns:

the dsl builder

crossOriginFilterOn

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

Specified by:

crossOriginFilterOn in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

crossOriginFilterOn in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

crossOriginFilterOn - the value to set

Returns:

the dsl builder

crossOriginFilterOn

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

Specified by:

crossOriginFilterOn in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

crossOriginFilterOn in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

crossOriginFilterOn - the value to set

Returns:

the dsl builder

filterPath

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

Specified by:

filterPath in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

filterPath in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

filterPath - the value to set

Returns:

the dsl builder

interval

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

Specified by:

interval in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

interval in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

interval - the value to set

Returns:

the dsl builder

interval

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

Specified by:

interval in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

interval in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

interval - the value to set

Returns:

the dsl builder

jsonCommented

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

Specified by:

jsonCommented in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

jsonCommented in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

jsonCommented - the value to set

Returns:

the dsl builder

jsonCommented

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

Specified by:

jsonCommented in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

jsonCommented in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

jsonCommented - the value to set

Returns:

the dsl builder

logLevel

default CometdEndpointBuilderFactory.CometdEndpointBuilder logLevel(int logLevel)

Logging level. 0=none, 1=info, 2=debug. The option is a: <code>int</code> type. Default: 1 Group: common

Specified by:

logLevel in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

logLevel in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

logLevel - the value to set

Returns:

the dsl builder

logLevel

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

Specified by:

logLevel in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

logLevel in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

logLevel - the value to set

Returns:

the dsl builder

maxInterval

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

Specified by:

maxInterval in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

maxInterval in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

maxInterval - the value to set

Returns:

the dsl builder

maxInterval

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

Specified by:

maxInterval in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

maxInterval in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

maxInterval - the value to set

Returns:

the dsl builder

multiFrameInterval

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

Specified by:

multiFrameInterval in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

multiFrameInterval in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

multiFrameInterval - the value to set

Returns:

the dsl builder

multiFrameInterval

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

Specified by:

multiFrameInterval in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

multiFrameInterval in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

multiFrameInterval - the value to set

Returns:

the dsl builder

timeout

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

Specified by:

timeout in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

timeout in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

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

Specified by:

timeout in interface CometdEndpointBuilderFactory.CometdEndpointConsumerBuilder

Specified by:

timeout in interface CometdEndpointBuilderFactory.CometdEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder