Interface ServerEndpointBuilderFactory.ServerEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
,ServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Enclosing interface:
- ServerEndpointBuilderFactory
public static interface ServerEndpointBuilderFactory.ServerEndpointBuilder extends ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder, ServerEndpointBuilderFactory.ServerEndpointProducerBuilder
Builder for endpoint for the IEC 60870 Server component.
-
-
Method Summary
-
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri
-
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
bridgeErrorHandler, bridgeErrorHandler
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ServerEndpointBuilderFactory.ServerEndpointProducerBuilder
lazyStartProducer, lazyStartProducer
-
-
-
-
Method Detail
-
advanced
default ServerEndpointBuilderFactory.AdvancedServerEndpointBuilder advanced()
- Specified by:
advanced
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
advanced
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
-
dataModuleOptions
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
dataModuleOptions
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
dataModuleOptions
- the value to set- Returns:
- the dsl builder
-
dataModuleOptions
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
dataModuleOptions
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
dataModuleOptions
- the value to set- Returns:
- the dsl builder
-
filterNonExecute
default ServerEndpointBuilderFactory.ServerEndpointBuilder filterNonExecute(boolean filterNonExecute)
Filter out all requests which don't have the execute bit set. The option is a: <code>boolean</code> type. Default: true Group: common- Specified by:
filterNonExecute
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
filterNonExecute
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
filterNonExecute
- the value to set- Returns:
- the dsl builder
-
filterNonExecute
default ServerEndpointBuilderFactory.ServerEndpointBuilder filterNonExecute(String filterNonExecute)
Filter out all requests which don't have the execute bit set. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Specified by:
filterNonExecute
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
filterNonExecute
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
filterNonExecute
- the value to set- Returns:
- the dsl builder
-
protocolOptions
default ServerEndpointBuilderFactory.ServerEndpointBuilder protocolOptions(Object protocolOptions)
Protocol options. The option is a: <code>org.eclipse.neoscada.protocol.iec60870.ProtocolOptions</code> type. Group: common- Specified by:
protocolOptions
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
protocolOptions
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
protocolOptions
- the value to set- Returns:
- the dsl builder
-
protocolOptions
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
protocolOptions
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
protocolOptions
- the value to set- Returns:
- the dsl builder
-
acknowledgeWindow
default ServerEndpointBuilderFactory.ServerEndpointBuilder acknowledgeWindow(short acknowledgeWindow)
Parameter W - Acknowledgment window. The option is a: <code>short</code> type. Default: 10 Group: connection- Specified by:
acknowledgeWindow
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
acknowledgeWindow
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
acknowledgeWindow
- the value to set- Returns:
- the dsl builder
-
acknowledgeWindow
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
acknowledgeWindow
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
acknowledgeWindow
- the value to set- Returns:
- the dsl builder
-
adsuAddressType
default ServerEndpointBuilderFactory.ServerEndpointBuilder adsuAddressType(ServerEndpointBuilderFactory.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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
adsuAddressType
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
adsuAddressType
- the value to set- Returns:
- the dsl builder
-
adsuAddressType
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
adsuAddressType
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
adsuAddressType
- the value to set- Returns:
- the dsl builder
-
causeOfTransmissionType
default ServerEndpointBuilderFactory.ServerEndpointBuilder causeOfTransmissionType(ServerEndpointBuilderFactory.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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
causeOfTransmissionType
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
causeOfTransmissionType
- the value to set- Returns:
- the dsl builder
-
causeOfTransmissionType
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
causeOfTransmissionType
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
causeOfTransmissionType
- the value to set- Returns:
- the dsl builder
-
informationObjectAddressType
default ServerEndpointBuilderFactory.ServerEndpointBuilder informationObjectAddressType(ServerEndpointBuilderFactory.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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
informationObjectAddressType
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
informationObjectAddressType
- the value to set- Returns:
- the dsl builder
-
informationObjectAddressType
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
informationObjectAddressType
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
informationObjectAddressType
- the value to set- Returns:
- the dsl builder
-
maxUnacknowledged
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
maxUnacknowledged
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
maxUnacknowledged
- the value to set- Returns:
- the dsl builder
-
maxUnacknowledged
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
maxUnacknowledged
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
maxUnacknowledged
- the value to set- Returns:
- the dsl builder
-
timeout1
default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout1(int timeout1)
Timeout T1 in milliseconds. The option is a: <code>int</code> type. Default: 15000 Group: connection- Specified by:
timeout1
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
timeout1
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
timeout1
- the value to set- Returns:
- the dsl builder
-
timeout1
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
timeout1
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
timeout1
- the value to set- Returns:
- the dsl builder
-
timeout2
default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout2(int timeout2)
Timeout T2 in milliseconds. The option is a: <code>int</code> type. Default: 10000 Group: connection- Specified by:
timeout2
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
timeout2
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
timeout2
- the value to set- Returns:
- the dsl builder
-
timeout2
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
timeout2
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
timeout2
- the value to set- Returns:
- the dsl builder
-
timeout3
default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout3(int timeout3)
Timeout T3 in milliseconds. The option is a: <code>int</code> type. Default: 20000 Group: connection- Specified by:
timeout3
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
timeout3
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
timeout3
- the value to set- Returns:
- the dsl builder
-
timeout3
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
timeout3
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
timeout3
- the value to set- Returns:
- the dsl builder
-
causeSourceAddress
default ServerEndpointBuilderFactory.ServerEndpointBuilder causeSourceAddress(byte causeSourceAddress)
Whether to include the source address. The option is a: <code>byte</code> type. Group: data- Specified by:
causeSourceAddress
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
causeSourceAddress
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
causeSourceAddress
- the value to set- Returns:
- the dsl builder
-
causeSourceAddress
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
causeSourceAddress
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
causeSourceAddress
- the value to set- Returns:
- the dsl builder
-
connectionTimeout
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
connectionTimeout
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
connectionTimeout
- the value to set- Returns:
- the dsl builder
-
connectionTimeout
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
connectionTimeout
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
connectionTimeout
- the value to set- Returns:
- the dsl builder
-
ignoreBackgroundScan
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
ignoreBackgroundScan
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
ignoreBackgroundScan
- the value to set- Returns:
- the dsl builder
-
ignoreBackgroundScan
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
ignoreBackgroundScan
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
ignoreBackgroundScan
- the value to set- Returns:
- the dsl builder
-
ignoreDaylightSavingTime
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
ignoreDaylightSavingTime
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
ignoreDaylightSavingTime
- the value to set- Returns:
- the dsl builder
-
ignoreDaylightSavingTime
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
ignoreDaylightSavingTime
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
ignoreDaylightSavingTime
- the value to set- Returns:
- the dsl builder
-
timeZone
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
timeZone
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
timeZone
- the value to set- Returns:
- the dsl builder
-
timeZone
default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
timeZone
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
timeZone
- the value to set- Returns:
- the dsl builder
-
connectionId
default ServerEndpointBuilderFactory.ServerEndpointBuilder connectionId(String connectionId)
An identifier grouping connection instances. The option is a: <code>java.lang.String</code> type. Group: id- Specified by:
connectionId
in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder
- Specified by:
connectionId
in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
- Parameters:
connectionId
- the value to set- Returns:
- the dsl builder
-
-