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
-
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, getUri
-
-
-
-
Method Detail
-
advanced
default ClientEndpointBuilderFactory.AdvancedClientEndpointBuilder advanced()
- Specified by:
advanced
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
advanced
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
dataModuleOptions
default ClientEndpointBuilderFactory.ClientEndpointBuilder dataModuleOptions(Object dataModuleOptions)
Data module options. The option is a:org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions
type. Group: common- Specified by:
dataModuleOptions
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
dataModuleOptions
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
dataModuleOptions
default ClientEndpointBuilderFactory.ClientEndpointBuilder dataModuleOptions(String dataModuleOptions)
Data module options. The option will be converted to aorg.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions
type. Group: common- Specified by:
dataModuleOptions
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
dataModuleOptions
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
protocolOptions
default ClientEndpointBuilderFactory.ClientEndpointBuilder protocolOptions(Object protocolOptions)
Protocol options. The option is a:org.eclipse.neoscada.protocol.iec60870.ProtocolOptions
type. Group: common- Specified by:
protocolOptions
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
protocolOptions
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
protocolOptions
default ClientEndpointBuilderFactory.ClientEndpointBuilder protocolOptions(String protocolOptions)
Protocol options. The option will be converted to aorg.eclipse.neoscada.protocol.iec60870.ProtocolOptions
type. Group: common- Specified by:
protocolOptions
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
protocolOptions
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
acknowledgeWindow
default ClientEndpointBuilderFactory.ClientEndpointBuilder acknowledgeWindow(short acknowledgeWindow)
Parameter W - Acknowledgment window. The option is a:short
type. Default: 10 Group: connection- Specified by:
acknowledgeWindow
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
acknowledgeWindow
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
acknowledgeWindow
default ClientEndpointBuilderFactory.ClientEndpointBuilder acknowledgeWindow(String acknowledgeWindow)
Parameter W - Acknowledgment window. The option will be converted to ashort
type. Default: 10 Group: connection- Specified by:
acknowledgeWindow
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
acknowledgeWindow
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
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:org.eclipse.neoscada.protocol.iec60870.ASDUAddressType
type. Group: connection- Specified by:
adsuAddressType
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
adsuAddressType
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
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 aorg.eclipse.neoscada.protocol.iec60870.ASDUAddressType
type. Group: connection- Specified by:
adsuAddressType
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
adsuAddressType
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
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:org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType
type. Group: connection- Specified by:
causeOfTransmissionType
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
causeOfTransmissionType
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
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 aorg.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType
type. Group: connection- Specified by:
causeOfTransmissionType
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
causeOfTransmissionType
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
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:org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType
type. Group: connection- Specified by:
informationObjectAddressType
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
informationObjectAddressType
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
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 aorg.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType
type. Group: connection- Specified by:
informationObjectAddressType
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
informationObjectAddressType
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
maxUnacknowledged
default ClientEndpointBuilderFactory.ClientEndpointBuilder maxUnacknowledged(short maxUnacknowledged)
Parameter K - Maximum number of un-acknowledged messages. The option is a:short
type. Default: 15 Group: connection- Specified by:
maxUnacknowledged
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
maxUnacknowledged
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
maxUnacknowledged
default ClientEndpointBuilderFactory.ClientEndpointBuilder maxUnacknowledged(String maxUnacknowledged)
Parameter K - Maximum number of un-acknowledged messages. The option will be converted to ashort
type. Default: 15 Group: connection- Specified by:
maxUnacknowledged
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
maxUnacknowledged
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
timeout1
default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout1(int timeout1)
Timeout T1 in milliseconds. The option is a:int
type. Default: 15000 Group: connection- Specified by:
timeout1
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
timeout1
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
timeout1
default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout1(String timeout1)
Timeout T1 in milliseconds. The option will be converted to aint
type. Default: 15000 Group: connection- Specified by:
timeout1
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
timeout1
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
timeout2
default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout2(int timeout2)
Timeout T2 in milliseconds. The option is a:int
type. Default: 10000 Group: connection- Specified by:
timeout2
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
timeout2
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
timeout2
default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout2(String timeout2)
Timeout T2 in milliseconds. The option will be converted to aint
type. Default: 10000 Group: connection- Specified by:
timeout2
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
timeout2
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
timeout3
default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout3(int timeout3)
Timeout T3 in milliseconds. The option is a:int
type. Default: 20000 Group: connection- Specified by:
timeout3
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
timeout3
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
timeout3
default ClientEndpointBuilderFactory.ClientEndpointBuilder timeout3(String timeout3)
Timeout T3 in milliseconds. The option will be converted to aint
type. Default: 20000 Group: connection- Specified by:
timeout3
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
timeout3
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
causeSourceAddress
default ClientEndpointBuilderFactory.ClientEndpointBuilder causeSourceAddress(byte causeSourceAddress)
Whether to include the source address. The option is a:byte
type. Group: data- Specified by:
causeSourceAddress
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
causeSourceAddress
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
causeSourceAddress
default ClientEndpointBuilderFactory.ClientEndpointBuilder causeSourceAddress(String causeSourceAddress)
Whether to include the source address. The option will be converted to abyte
type. Group: data- Specified by:
causeSourceAddress
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
causeSourceAddress
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
connectionTimeout
default ClientEndpointBuilderFactory.ClientEndpointBuilder connectionTimeout(int connectionTimeout)
Timeout in millis to wait for client to establish a connected connection. The option is a:int
type. Default: 10000 Group: data- Specified by:
connectionTimeout
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
connectionTimeout
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
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 aint
type. Default: 10000 Group: data- Specified by:
connectionTimeout
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
connectionTimeout
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
ignoreBackgroundScan
default ClientEndpointBuilderFactory.ClientEndpointBuilder ignoreBackgroundScan(boolean ignoreBackgroundScan)
Whether background scan transmissions should be ignored. The option is a:boolean
type. Default: true Group: data- Specified by:
ignoreBackgroundScan
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
ignoreBackgroundScan
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
ignoreBackgroundScan
default ClientEndpointBuilderFactory.ClientEndpointBuilder ignoreBackgroundScan(String ignoreBackgroundScan)
Whether background scan transmissions should be ignored. The option will be converted to aboolean
type. Default: true Group: data- Specified by:
ignoreBackgroundScan
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
ignoreBackgroundScan
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
ignoreDaylightSavingTime
default ClientEndpointBuilderFactory.ClientEndpointBuilder ignoreDaylightSavingTime(boolean ignoreDaylightSavingTime)
Whether to ignore or respect DST. The option is a:boolean
type. Default: false Group: data- Specified by:
ignoreDaylightSavingTime
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
ignoreDaylightSavingTime
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
ignoreDaylightSavingTime
default ClientEndpointBuilderFactory.ClientEndpointBuilder ignoreDaylightSavingTime(String ignoreDaylightSavingTime)
Whether to ignore or respect DST. The option will be converted to aboolean
type. Default: false Group: data- Specified by:
ignoreDaylightSavingTime
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
ignoreDaylightSavingTime
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
timeZone
default ClientEndpointBuilderFactory.ClientEndpointBuilder timeZone(TimeZone timeZone)
The timezone to use. May be any Java time zone string. The option is a:java.util.TimeZone
type. Default: UTC Group: data- Specified by:
timeZone
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
timeZone
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
timeZone
default ClientEndpointBuilderFactory.ClientEndpointBuilder timeZone(String timeZone)
The timezone to use. May be any Java time zone string. The option will be converted to ajava.util.TimeZone
type. Default: UTC Group: data- Specified by:
timeZone
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
timeZone
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
connectionId
default ClientEndpointBuilderFactory.ClientEndpointBuilder connectionId(String connectionId)
An identifier grouping connection instances. The option is a:java.lang.String
type. Group: id- Specified by:
connectionId
in interfaceClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
- Specified by:
connectionId
in interfaceClientEndpointBuilderFactory.ClientEndpointProducerBuilder
-
-