Package org.apache.camel.builder.endpoint.dsl

Interface ClientEndpointBuilderFactory.ClientEndpointBuilder

All Superinterfaces:

ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder, ClientEndpointBuilderFactory.ClientEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

ClientEndpointBuilderFactory

public static interface ClientEndpointBuilderFactory.ClientEndpointBuilder
extends ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder, ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Builder for endpoint for the IEC 60870 Client component.

Method Summary

Modifier and Type	Method	Description
default ClientEndpointBuilderFactory.ClientEndpointBuilder	acknowledgeWindow(short acknowledgeWindow)	Parameter W - Acknowledgment window.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	acknowledgeWindow(String acknowledgeWindow)	Parameter W - Acknowledgment window.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	adsuAddressType(String adsuAddressType)	The common ASDU address size.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	adsuAddressType(ClientEndpointBuilderFactory.ASDUAddressType adsuAddressType)	The common ASDU address size.
default ClientEndpointBuilderFactory.AdvancedClientEndpointBuilder	advanced()
default ClientEndpointBuilderFactory.ClientEndpointBuilder	causeOfTransmissionType(String causeOfTransmissionType)	The cause of transmission type.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	causeOfTransmissionType(ClientEndpointBuilderFactory.CauseOfTransmissionType causeOfTransmissionType)	The cause of transmission type.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	causeSourceAddress(byte causeSourceAddress)	Whether to include the source address.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	causeSourceAddress(String causeSourceAddress)	Whether to include the source address.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	connectionId(String connectionId)	An identifier grouping connection instances.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	connectionTimeout(int connectionTimeout)	Timeout in millis to wait for client to establish a connected connection.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	connectionTimeout(String connectionTimeout)	Timeout in millis to wait for client to establish a connected connection.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	dataModuleOptions(Object dataModuleOptions)	Data module options.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	dataModuleOptions(String dataModuleOptions)	Data module options.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	ignoreBackgroundScan(boolean ignoreBackgroundScan)	Whether background scan transmissions should be ignored.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	ignoreBackgroundScan(String ignoreBackgroundScan)	Whether background scan transmissions should be ignored.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	ignoreDaylightSavingTime(boolean ignoreDaylightSavingTime)	Whether to ignore or respect DST.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	ignoreDaylightSavingTime(String ignoreDaylightSavingTime)	Whether to ignore or respect DST.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	informationObjectAddressType(String informationObjectAddressType)	The information address size.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	informationObjectAddressType(ClientEndpointBuilderFactory.InformationObjectAddressType informationObjectAddressType)	The information address size.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	maxUnacknowledged(short maxUnacknowledged)	Parameter K - Maximum number of un-acknowledged messages.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	maxUnacknowledged(String maxUnacknowledged)	Parameter K - Maximum number of un-acknowledged messages.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	protocolOptions(Object protocolOptions)	Protocol options.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	protocolOptions(String protocolOptions)	Protocol options.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	timeout1(int timeout1)	Timeout T1 in milliseconds.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	timeout1(String timeout1)	Timeout T1 in milliseconds.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	timeout2(int timeout2)	Timeout T2 in milliseconds.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	timeout2(String timeout2)	Timeout T2 in milliseconds.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	timeout3(int timeout3)	Timeout T3 in milliseconds.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	timeout3(String timeout3)	Timeout T3 in milliseconds.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	timeZone(String timeZone)	The timezone to use.
default ClientEndpointBuilderFactory.ClientEndpointBuilder	timeZone(TimeZone timeZone)	The timezone to use.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

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.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default ClientEndpointBuilderFactory.AdvancedClientEndpointBuilder advanced()

Specified by:

advanced in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

advanced in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

dataModuleOptions

default ClientEndpointBuilderFactory.ClientEndpointBuilder dataModuleOptions(Object dataModuleOptions)

Data module options. The option is a: <code>org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions</code> type. Group: common

Specified by:

dataModuleOptions in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

dataModuleOptions in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

dataModuleOptions - the value to set

Returns:

the dsl builder

dataModuleOptions

default ClientEndpointBuilderFactory.ClientEndpointBuilder dataModuleOptions(String dataModuleOptions)

Data module options. The option will be converted to a <code>org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions</code> type. Group: common

Specified by:

dataModuleOptions in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

dataModuleOptions in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

dataModuleOptions - the value to set

Returns:

the dsl builder

protocolOptions

default ClientEndpointBuilderFactory.ClientEndpointBuilder protocolOptions(Object protocolOptions)

Protocol options. The option is a: <code>org.eclipse.neoscada.protocol.iec60870.ProtocolOptions</code> type. Group: common

Specified by:

protocolOptions in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

protocolOptions in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

protocolOptions - the value to set

Returns:

the dsl builder

protocolOptions

default ClientEndpointBuilderFactory.ClientEndpointBuilder protocolOptions(String protocolOptions)

Protocol options. The option will be converted to a <code>org.eclipse.neoscada.protocol.iec60870.ProtocolOptions</code> type. Group: common

Specified by:

protocolOptions in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

protocolOptions in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

protocolOptions - the value to set

Returns:

the dsl builder

acknowledgeWindow

default ClientEndpointBuilderFactory.ClientEndpointBuilder acknowledgeWindow(short acknowledgeWindow)

Parameter W - Acknowledgment window. The option is a: <code>short</code> type. Default: 10 Group: connection

Specified by:

acknowledgeWindow in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

acknowledgeWindow in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

acknowledgeWindow - the value to set

Returns:

the dsl builder

acknowledgeWindow

default ClientEndpointBuilderFactory.ClientEndpointBuilder acknowledgeWindow(String acknowledgeWindow)

Parameter W - Acknowledgment window. The option will be converted to a <code>short</code> type. Default: 10 Group: connection

Specified by:

acknowledgeWindow in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

acknowledgeWindow in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

acknowledgeWindow - the value to set

Returns:

the dsl builder

adsuAddressType

default ClientEndpointBuilderFactory.ClientEndpointBuilder adsuAddressType(ClientEndpointBuilderFactory.ASDUAddressType adsuAddressType)

The common ASDU address size. May be either SIZE_1 or SIZE_2. The option is a: <code>org.eclipse.neoscada.protocol.iec60870.ASDUAddressType</code> type. Group: connection

Specified by:

adsuAddressType in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

adsuAddressType in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

adsuAddressType - the value to set

Returns:

the dsl builder

adsuAddressType

default ClientEndpointBuilderFactory.ClientEndpointBuilder adsuAddressType(String adsuAddressType)

The common ASDU address size. May be either SIZE_1 or SIZE_2. The option will be converted to a <code>org.eclipse.neoscada.protocol.iec60870.ASDUAddressType</code> type. Group: connection

Specified by:

adsuAddressType in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

adsuAddressType in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

adsuAddressType - the value to set

Returns:

the dsl builder

causeOfTransmissionType

default ClientEndpointBuilderFactory.ClientEndpointBuilder causeOfTransmissionType(ClientEndpointBuilderFactory.CauseOfTransmissionType causeOfTransmissionType)

The cause of transmission type. May be either SIZE_1 or SIZE_2. The option is a: <code>org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType</code> type. Group: connection

Specified by:

causeOfTransmissionType in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

causeOfTransmissionType in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

causeOfTransmissionType - the value to set

Returns:

the dsl builder

causeOfTransmissionType

default ClientEndpointBuilderFactory.ClientEndpointBuilder causeOfTransmissionType(String causeOfTransmissionType)

The cause of transmission type. May be either SIZE_1 or SIZE_2. The option will be converted to a <code>org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType</code> type. Group: connection

Specified by:

causeOfTransmissionType in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

causeOfTransmissionType in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

causeOfTransmissionType - the value to set

Returns:

the dsl builder

informationObjectAddressType

default ClientEndpointBuilderFactory.ClientEndpointBuilder informationObjectAddressType(ClientEndpointBuilderFactory.InformationObjectAddressType informationObjectAddressType)

The information address size. May be either SIZE_1, SIZE_2 or SIZE_3. The option is a: <code>org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType</code> type. Group: connection

Specified by:

informationObjectAddressType in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

informationObjectAddressType in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

informationObjectAddressType - the value to set

Returns:

the dsl builder

informationObjectAddressType

default ClientEndpointBuilderFactory.ClientEndpointBuilder informationObjectAddressType(String informationObjectAddressType)

The information address size. May be either SIZE_1, SIZE_2 or SIZE_3. The option will be converted to a <code>org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType</code> type. Group: connection

Specified by:

informationObjectAddressType in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

informationObjectAddressType in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

informationObjectAddressType - the value to set

Returns:

the dsl builder

maxUnacknowledged

default ClientEndpointBuilderFactory.ClientEndpointBuilder maxUnacknowledged(short maxUnacknowledged)

Parameter K - Maximum number of un-acknowledged messages. The option is a: <code>short</code> type. Default: 15 Group: connection

Specified by:

maxUnacknowledged in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

maxUnacknowledged in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

maxUnacknowledged - the value to set

Returns:

the dsl builder

maxUnacknowledged

default ClientEndpointBuilderFactory.ClientEndpointBuilder maxUnacknowledged(String maxUnacknowledged)

Parameter K - Maximum number of un-acknowledged messages. The option will be converted to a <code>short</code> type. Default: 15 Group: connection

Specified by:

maxUnacknowledged in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

maxUnacknowledged in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

maxUnacknowledged - the value to set

Returns:

the dsl builder

timeout1

default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout1(int timeout1)

Timeout T1 in milliseconds. The option is a: <code>int</code> type. Default: 15000 Group: connection

Specified by:

timeout1 in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

timeout1 in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

timeout1 - the value to set

Returns:

the dsl builder

timeout1

default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout1(String timeout1)

Timeout T1 in milliseconds. The option will be converted to a <code>int</code> type. Default: 15000 Group: connection

Specified by:

timeout1 in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

timeout1 in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

timeout1 - the value to set

Returns:

the dsl builder

timeout2

default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout2(int timeout2)

Timeout T2 in milliseconds. The option is a: <code>int</code> type. Default: 10000 Group: connection

Specified by:

timeout2 in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

timeout2 in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

timeout2 - the value to set

Returns:

the dsl builder

timeout2

default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout2(String timeout2)

Timeout T2 in milliseconds. The option will be converted to a <code>int</code> type. Default: 10000 Group: connection

Specified by:

timeout2 in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

timeout2 in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

timeout2 - the value to set

Returns:

the dsl builder

timeout3

default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout3(int timeout3)

Timeout T3 in milliseconds. The option is a: <code>int</code> type. Default: 20000 Group: connection

Specified by:

timeout3 in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

timeout3 in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

timeout3 - the value to set

Returns:

the dsl builder

timeout3

default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout3(String timeout3)

Timeout T3 in milliseconds. The option will be converted to a <code>int</code> type. Default: 20000 Group: connection

Specified by:

timeout3 in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

timeout3 in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

timeout3 - the value to set

Returns:

the dsl builder

causeSourceAddress

default ClientEndpointBuilderFactory.ClientEndpointBuilder causeSourceAddress(byte causeSourceAddress)

Whether to include the source address. The option is a: <code>byte</code> type. Group: data

Specified by:

causeSourceAddress in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

causeSourceAddress in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

causeSourceAddress - the value to set

Returns:

the dsl builder

causeSourceAddress

default ClientEndpointBuilderFactory.ClientEndpointBuilder causeSourceAddress(String causeSourceAddress)

Whether to include the source address. The option will be converted to a <code>byte</code> type. Group: data

Specified by:

causeSourceAddress in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

causeSourceAddress in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

causeSourceAddress - the value to set

Returns:

the dsl builder

connectionTimeout

default ClientEndpointBuilderFactory.ClientEndpointBuilder connectionTimeout(int connectionTimeout)

Timeout in millis to wait for client to establish a connected connection. The option is a: <code>int</code> type. Default: 10000 Group: data

Specified by:

connectionTimeout in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

connectionTimeout in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

connectionTimeout - the value to set

Returns:

the dsl builder

connectionTimeout

default ClientEndpointBuilderFactory.ClientEndpointBuilder connectionTimeout(String connectionTimeout)

Timeout in millis to wait for client to establish a connected connection. The option will be converted to a <code>int</code> type. Default: 10000 Group: data

Specified by:

connectionTimeout in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

connectionTimeout in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

connectionTimeout - the value to set

Returns:

the dsl builder

ignoreBackgroundScan

default ClientEndpointBuilderFactory.ClientEndpointBuilder ignoreBackgroundScan(boolean ignoreBackgroundScan)

Whether background scan transmissions should be ignored. The option is a: <code>boolean</code> type. Default: true Group: data

Specified by:

ignoreBackgroundScan in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

ignoreBackgroundScan in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

ignoreBackgroundScan - the value to set

Returns:

the dsl builder

ignoreBackgroundScan

default ClientEndpointBuilderFactory.ClientEndpointBuilder ignoreBackgroundScan(String ignoreBackgroundScan)

Whether background scan transmissions should be ignored. The option will be converted to a <code>boolean</code> type. Default: true Group: data

Specified by:

ignoreBackgroundScan in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

ignoreBackgroundScan in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

ignoreBackgroundScan - the value to set

Returns:

the dsl builder

ignoreDaylightSavingTime

default ClientEndpointBuilderFactory.ClientEndpointBuilder ignoreDaylightSavingTime(boolean ignoreDaylightSavingTime)

Whether to ignore or respect DST. The option is a: <code>boolean</code> type. Default: false Group: data

Specified by:

ignoreDaylightSavingTime in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

ignoreDaylightSavingTime in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

ignoreDaylightSavingTime - the value to set

Returns:

the dsl builder

ignoreDaylightSavingTime

default ClientEndpointBuilderFactory.ClientEndpointBuilder ignoreDaylightSavingTime(String ignoreDaylightSavingTime)

Whether to ignore or respect DST. The option will be converted to a <code>boolean</code> type. Default: false Group: data

Specified by:

ignoreDaylightSavingTime in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

ignoreDaylightSavingTime in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

ignoreDaylightSavingTime - the value to set

Returns:

the dsl builder

timeZone

default ClientEndpointBuilderFactory.ClientEndpointBuilder timeZone(TimeZone timeZone)

The timezone to use. May be any Java time zone string. The option is a: <code>java.util.TimeZone</code> type. Default: UTC Group: data

Specified by:

timeZone in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

timeZone in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

timeZone - the value to set

Returns:

the dsl builder

timeZone

default ClientEndpointBuilderFactory.ClientEndpointBuilder timeZone(String timeZone)

The timezone to use. May be any Java time zone string. The option will be converted to a <code>java.util.TimeZone</code> type. Default: UTC Group: data

Specified by:

timeZone in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

timeZone in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

timeZone - the value to set

Returns:

the dsl builder

connectionId

default ClientEndpointBuilderFactory.ClientEndpointBuilder connectionId(String connectionId)

An identifier grouping connection instances. The option is a: <code>java.lang.String</code> type. Group: id

Specified by:

connectionId in interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

Specified by:

connectionId in interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

Parameters:

connectionId - the value to set

Returns:

the dsl builder