org.apache.camel.builder.endpoint.dsl

Interface CMEndpointBuilderFactory.CMEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

CMEndpointBuilderFactory

public static interface CMEndpointBuilderFactory.CMEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the CM SMS Gateway component.

Method Summary

Modifier and Type	Method and Description
default CMEndpointBuilderFactory.CMEndpointBuilder	defaultFrom(String defaultFrom) This is the sender name.
default CMEndpointBuilderFactory.CMEndpointBuilder	defaultMaxNumberOfParts(int defaultMaxNumberOfParts) If it is a multipart message forces the max number.
default CMEndpointBuilderFactory.CMEndpointBuilder	defaultMaxNumberOfParts(String defaultMaxNumberOfParts) If it is a multipart message forces the max number.
default CMEndpointBuilderFactory.CMEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default CMEndpointBuilderFactory.CMEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default CMEndpointBuilderFactory.CMEndpointBuilder	productToken(String productToken) The unique token to use.
default CMEndpointBuilderFactory.CMEndpointBuilder	testConnectionOnStartup(boolean testConnectionOnStartup) Whether to test the connection to the SMS Gateway on startup.
default CMEndpointBuilderFactory.CMEndpointBuilder	testConnectionOnStartup(String testConnectionOnStartup) Whether to test the connection to the SMS Gateway on startup.

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

defaultFrom

default CMEndpointBuilderFactory.CMEndpointBuilder defaultFrom(String defaultFrom)

This is the sender name. The maximum length is 11 characters. The option is a: <code>java.lang.String</code> type. Required: true Group: producer

Parameters:

defaultFrom - the value to set

Returns:

the dsl builder

defaultMaxNumberOfParts

default CMEndpointBuilderFactory.CMEndpointBuilder defaultMaxNumberOfParts(int defaultMaxNumberOfParts)

If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters, if so, the message will be cut into multiple 153 characters parts limited by these parameters. The option is a: <code>int</code> type. Default: 8 Group: producer

Parameters:

defaultMaxNumberOfParts - the value to set

Returns:

the dsl builder

defaultMaxNumberOfParts

default CMEndpointBuilderFactory.CMEndpointBuilder defaultMaxNumberOfParts(String defaultMaxNumberOfParts)

If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters, if so, the message will be cut into multiple 153 characters parts limited by these parameters. The option will be converted to a <code>int</code> type. Default: 8 Group: producer

Parameters:

defaultMaxNumberOfParts - the value to set

Returns:

the dsl builder

lazyStartProducer

default CMEndpointBuilderFactory.CMEndpointBuilder 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 CMEndpointBuilderFactory.CMEndpointBuilder 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

productToken

default CMEndpointBuilderFactory.CMEndpointBuilder productToken(String productToken)

The unique token to use. The option is a: <code>java.lang.String</code> type. Required: true Group: producer

Parameters:

productToken - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default CMEndpointBuilderFactory.CMEndpointBuilder testConnectionOnStartup(boolean testConnectionOnStartup)

Whether to test the connection to the SMS Gateway on startup. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default CMEndpointBuilderFactory.CMEndpointBuilder testConnectionOnStartup(String testConnectionOnStartup)

Whether to test the connection to the SMS Gateway on startup. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder