org.apache.camel.builder.endpoint.dsl

Interface SmppEndpointBuilderFactory.SmppEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder, SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Enclosing interface:

SmppEndpointBuilderFactory

public static interface SmppEndpointBuilderFactory.SmppEndpointBuilder
extends SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder, SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Builder for endpoint for the SMPP component.

Method Summary

Modifier and Type	Method and Description
default SmppEndpointBuilderFactory.AdvancedSmppEndpointBuilder	advanced()
default SmppEndpointBuilderFactory.SmppEndpointBuilder	alphabet(byte alphabet) Defines encoding of data according the SMPP 3.4 specification, section 5.2.19.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	alphabet(String alphabet) Defines encoding of data according the SMPP 3.4 specification, section 5.2.19.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	dataCoding(byte dataCoding) Defines the data coding according the SMPP 3.4 specification, section 5.2.19.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	dataCoding(String dataCoding) Defines the data coding according the SMPP 3.4 specification, section 5.2.19.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	encoding(String encoding) Defines the encoding scheme of the short message user data.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	httpProxyHost(String httpProxyHost) If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	httpProxyPassword(String httpProxyPassword) If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	httpProxyPort(Integer httpProxyPort) If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	httpProxyPort(String httpProxyPort) If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	httpProxyUsername(String httpProxyUsername) If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	initialReconnectDelay(long initialReconnectDelay) Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	initialReconnectDelay(String initialReconnectDelay) Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	maxReconnect(int maxReconnect) Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	maxReconnect(String maxReconnect) Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	password(String password) The password for connecting to SMSC server.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	proxyHeaders(Map<String,String> proxyHeaders) These headers will be passed to the proxy server while establishing the connection.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	proxyHeaders(String proxyHeaders) These headers will be passed to the proxy server while establishing the connection.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	reconnectDelay(long reconnectDelay) Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	reconnectDelay(String reconnectDelay) Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	splittingPolicy(SmppEndpointBuilderFactory.SmppSplittingPolicy splittingPolicy) You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	splittingPolicy(String splittingPolicy) You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	systemId(String systemId) The system id (username) for connecting to SMSC server.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	systemType(String systemType) This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	usingSSL(boolean usingSSL) Whether using SSL with the smpps protocol.
default SmppEndpointBuilderFactory.SmppEndpointBuilder	usingSSL(String usingSSL) Whether using SSL with the smpps protocol.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

addressRange, bridgeErrorHandler, bridgeErrorHandler

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.SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

destAddr, destAddrNpi, destAddrNpi, destAddrTon, destAddrTon, lazySessionCreation, lazySessionCreation, lazyStartProducer, lazyStartProducer, numberingPlanIndicator, numberingPlanIndicator, priorityFlag, priorityFlag, protocolId, protocolId, registeredDelivery, registeredDelivery, replaceIfPresentFlag, replaceIfPresentFlag, serviceType, sourceAddr, sourceAddrNpi, sourceAddrNpi, sourceAddrTon, sourceAddrTon, typeOfNumber, typeOfNumber

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 SmppEndpointBuilderFactory.AdvancedSmppEndpointBuilder advanced()

Specified by:

advanced in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

advanced in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

initialReconnectDelay

default SmppEndpointBuilderFactory.SmppEndpointBuilder initialReconnectDelay(long initialReconnectDelay)

Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost. The option is a: <code>long</code> type. Default: 5000 Group: common

Specified by:

initialReconnectDelay in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

initialReconnectDelay in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

initialReconnectDelay - the value to set

Returns:

the dsl builder

initialReconnectDelay

default SmppEndpointBuilderFactory.SmppEndpointBuilder initialReconnectDelay(String initialReconnectDelay)

Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost. The option will be converted to a <code>long</code> type. Default: 5000 Group: common

Specified by:

initialReconnectDelay in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

initialReconnectDelay in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

initialReconnectDelay - the value to set

Returns:

the dsl builder

maxReconnect

default SmppEndpointBuilderFactory.SmppEndpointBuilder maxReconnect(int maxReconnect)

Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response. The option is a: <code>int</code> type. Default: 2147483647 Group: common

Specified by:

maxReconnect in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

maxReconnect in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

maxReconnect - the value to set

Returns:

the dsl builder

maxReconnect

default SmppEndpointBuilderFactory.SmppEndpointBuilder maxReconnect(String maxReconnect)

Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response. The option will be converted to a <code>int</code> type. Default: 2147483647 Group: common

Specified by:

maxReconnect in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

maxReconnect in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

maxReconnect - the value to set

Returns:

the dsl builder

reconnectDelay

default SmppEndpointBuilderFactory.SmppEndpointBuilder reconnectDelay(long reconnectDelay)

Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed. The option is a: <code>long</code> type. Default: 5000 Group: common

Specified by:

reconnectDelay in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

reconnectDelay in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

reconnectDelay

default SmppEndpointBuilderFactory.SmppEndpointBuilder reconnectDelay(String reconnectDelay)

Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed. The option will be converted to a <code>long</code> type. Default: 5000 Group: common

Specified by:

reconnectDelay in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

reconnectDelay in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

splittingPolicy

default SmppEndpointBuilderFactory.SmppEndpointBuilder splittingPolicy(SmppEndpointBuilderFactory.SmppSplittingPolicy splittingPolicy)

You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long. The option is a: <code>org.apache.camel.component.smpp.SmppSplittingPolicy</code> type. Default: ALLOW Group: common

Specified by:

splittingPolicy in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

splittingPolicy in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

splittingPolicy - the value to set

Returns:

the dsl builder

splittingPolicy

default SmppEndpointBuilderFactory.SmppEndpointBuilder splittingPolicy(String splittingPolicy)

You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long. The option will be converted to a <code>org.apache.camel.component.smpp.SmppSplittingPolicy</code> type. Default: ALLOW Group: common

Specified by:

splittingPolicy in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

splittingPolicy in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

splittingPolicy - the value to set

Returns:

the dsl builder

systemType

default SmppEndpointBuilderFactory.SmppEndpointBuilder systemType(String systemType)

This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters). The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

systemType in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

systemType in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

systemType - the value to set

Returns:

the dsl builder

alphabet

default SmppEndpointBuilderFactory.SmppEndpointBuilder alphabet(byte alphabet)

Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet. The option is a: <code>byte</code> type. Group: codec

Specified by:

alphabet in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

alphabet in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

alphabet - the value to set

Returns:

the dsl builder

alphabet

default SmppEndpointBuilderFactory.SmppEndpointBuilder alphabet(String alphabet)

Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet. The option will be converted to a <code>byte</code> type. Group: codec

Specified by:

alphabet in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

alphabet in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

alphabet - the value to set

Returns:

the dsl builder

dataCoding

default SmppEndpointBuilderFactory.SmppEndpointBuilder dataCoding(byte dataCoding)

Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990). The option is a: <code>byte</code> type. Group: codec

Specified by:

dataCoding in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

dataCoding in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

dataCoding - the value to set

Returns:

the dsl builder

dataCoding

default SmppEndpointBuilderFactory.SmppEndpointBuilder dataCoding(String dataCoding)

Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990). The option will be converted to a <code>byte</code> type. Group: codec

Specified by:

dataCoding in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

dataCoding in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

dataCoding - the value to set

Returns:

the dsl builder

encoding

default SmppEndpointBuilderFactory.SmppEndpointBuilder encoding(String encoding)

Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti. The option is a: <code>java.lang.String</code> type. Default: ISO-8859-1 Group: codec

Specified by:

encoding in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

encoding in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

encoding - the value to set

Returns:

the dsl builder

httpProxyHost

default SmppEndpointBuilderFactory.SmppEndpointBuilder httpProxyHost(String httpProxyHost)

If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy. The option is a: <code>java.lang.String</code> type. Group: proxy

Specified by:

httpProxyHost in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

httpProxyHost in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

httpProxyHost - the value to set

Returns:

the dsl builder

httpProxyPassword

default SmppEndpointBuilderFactory.SmppEndpointBuilder httpProxyPassword(String httpProxyPassword)

If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy. The option is a: <code>java.lang.String</code> type. Group: proxy

Specified by:

httpProxyPassword in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

httpProxyPassword in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

httpProxyPassword - the value to set

Returns:

the dsl builder

httpProxyPort

default SmppEndpointBuilderFactory.SmppEndpointBuilder httpProxyPort(Integer httpProxyPort)

If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy. The option is a: <code>java.lang.Integer</code> type. Default: 3128 Group: proxy

Specified by:

httpProxyPort in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

httpProxyPort in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

httpProxyPort - the value to set

Returns:

the dsl builder

httpProxyPort

default SmppEndpointBuilderFactory.SmppEndpointBuilder httpProxyPort(String httpProxyPort)

If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy. The option will be converted to a <code>java.lang.Integer</code> type. Default: 3128 Group: proxy

Specified by:

httpProxyPort in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

httpProxyPort in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

httpProxyPort - the value to set

Returns:

the dsl builder

httpProxyUsername

default SmppEndpointBuilderFactory.SmppEndpointBuilder httpProxyUsername(String httpProxyUsername)

If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy. The option is a: <code>java.lang.String</code> type. Group: proxy

Specified by:

httpProxyUsername in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

httpProxyUsername in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

httpProxyUsername - the value to set

Returns:

the dsl builder

proxyHeaders

default SmppEndpointBuilderFactory.SmppEndpointBuilder proxyHeaders(Map<String,String> proxyHeaders)

These headers will be passed to the proxy server while establishing the connection. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: proxy

Specified by:

proxyHeaders in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

proxyHeaders in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

proxyHeaders - the value to set

Returns:

the dsl builder

proxyHeaders

default SmppEndpointBuilderFactory.SmppEndpointBuilder proxyHeaders(String proxyHeaders)

These headers will be passed to the proxy server while establishing the connection. The option will be converted to a <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: proxy

Specified by:

proxyHeaders in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

proxyHeaders in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

proxyHeaders - the value to set

Returns:

the dsl builder

password

default SmppEndpointBuilderFactory.SmppEndpointBuilder password(String password)

The password for connecting to SMSC server. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

password in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

password in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

systemId

default SmppEndpointBuilderFactory.SmppEndpointBuilder systemId(String systemId)

The system id (username) for connecting to SMSC server. The option is a: <code>java.lang.String</code> type. Default: smppclient Group: security

Specified by:

systemId in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

systemId in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

systemId - the value to set

Returns:

the dsl builder

usingSSL

default SmppEndpointBuilderFactory.SmppEndpointBuilder usingSSL(boolean usingSSL)

Whether using SSL with the smpps protocol. The option is a: <code>boolean</code> type. Default: false Group: security

Specified by:

usingSSL in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

usingSSL in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

usingSSL - the value to set

Returns:

the dsl builder

usingSSL

default SmppEndpointBuilderFactory.SmppEndpointBuilder usingSSL(String usingSSL)

Whether using SSL with the smpps protocol. The option will be converted to a <code>boolean</code> type. Default: false Group: security

Specified by:

usingSSL in interface SmppEndpointBuilderFactory.SmppEndpointConsumerBuilder

Specified by:

usingSSL in interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

Parameters:

usingSSL - the value to set

Returns:

the dsl builder