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
Modifier and TypeMethodDescriptionacknowledgeWindow(short acknowledgeWindow) Parameter W - Acknowledgment window.acknowledgeWindow(String acknowledgeWindow) Parameter W - Acknowledgment window.adsuAddressType(String adsuAddressType) The common ASDU address size.adsuAddressType(org.eclipse.neoscada.protocol.iec60870.ASDUAddressType adsuAddressType) The common ASDU address size.advanced()causeOfTransmissionType(String causeOfTransmissionType) The cause of transmission type.causeOfTransmissionType(org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType causeOfTransmissionType) The cause of transmission type.causeSourceAddress(byte causeSourceAddress) Whether to include the source address.causeSourceAddress(String causeSourceAddress) Whether to include the source address.connectionId(String connectionId) An identifier grouping connection instances.connectionTimeout(int connectionTimeout) Timeout in millis to wait for client to establish a connected connection.connectionTimeout(String connectionTimeout) Timeout in millis to wait for client to establish a connected connection.dataModuleOptions(String dataModuleOptions) Data module options.dataModuleOptions(org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions dataModuleOptions) Data module options.filterNonExecute(boolean filterNonExecute) Filter out all requests which don't have the execute bit set.filterNonExecute(String filterNonExecute) Filter out all requests which don't have the execute bit set.ignoreBackgroundScan(boolean ignoreBackgroundScan) Whether background scan transmissions should be ignored.ignoreBackgroundScan(String ignoreBackgroundScan) Whether background scan transmissions should be ignored.ignoreDaylightSavingTime(boolean ignoreDaylightSavingTime) Whether to ignore or respect DST.ignoreDaylightSavingTime(String ignoreDaylightSavingTime) Whether to ignore or respect DST.informationObjectAddressType(String informationObjectAddressType) The information address size.informationObjectAddressType(org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType informationObjectAddressType) The information address size.maxUnacknowledged(short maxUnacknowledged) Parameter K - Maximum number of un-acknowledged messages.maxUnacknowledged(String maxUnacknowledged) Parameter K - Maximum number of un-acknowledged messages.protocolOptions(String protocolOptions) Protocol options.protocolOptions(org.eclipse.neoscada.protocol.iec60870.ProtocolOptions protocolOptions) Protocol options.timeout1(int timeout1) Timeout T1 in milliseconds.Timeout T1 in milliseconds.timeout2(int timeout2) Timeout T2 in milliseconds.Timeout T2 in milliseconds.timeout3(int timeout3) Timeout T3 in milliseconds.Timeout T3 in milliseconds.The timezone to use.The timezone to use.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUriMethods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolveMethods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUriMethods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
- Specified by:
advancedin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
advancedin interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder
-
dataModuleOptions
default ServerEndpointBuilderFactory.ServerEndpointBuilder dataModuleOptions(org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions dataModuleOptions) Data module options. The option is a: <code>org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions</code> type. Group: common- Specified by:
dataModuleOptionsin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
dataModuleOptionsin 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:
dataModuleOptionsin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
dataModuleOptionsin 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:
filterNonExecutein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
filterNonExecutein 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:
filterNonExecutein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
filterNonExecutein interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
filterNonExecute- the value to set- Returns:
- the dsl builder
-
protocolOptions
default ServerEndpointBuilderFactory.ServerEndpointBuilder protocolOptions(org.eclipse.neoscada.protocol.iec60870.ProtocolOptions protocolOptions) Protocol options. The option is a: <code>org.eclipse.neoscada.protocol.iec60870.ProtocolOptions</code> type. Group: common- Specified by:
protocolOptionsin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
protocolOptionsin interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
protocolOptions- the value to set- Returns:
- the dsl builder
-
protocolOptions
Protocol options. The option will be converted to a <code>org.eclipse.neoscada.protocol.iec60870.ProtocolOptions</code> type. Group: common- Specified by:
protocolOptionsin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
protocolOptionsin 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:
acknowledgeWindowin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
acknowledgeWindowin 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:
acknowledgeWindowin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
acknowledgeWindowin interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
acknowledgeWindow- the value to set- Returns:
- the dsl builder
-
adsuAddressType
default ServerEndpointBuilderFactory.ServerEndpointBuilder adsuAddressType(org.eclipse.neoscada.protocol.iec60870.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:
adsuAddressTypein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
adsuAddressTypein interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
adsuAddressType- the value to set- Returns:
- the dsl builder
-
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:
adsuAddressTypein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
adsuAddressTypein interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
adsuAddressType- the value to set- Returns:
- the dsl builder
-
causeOfTransmissionType
default ServerEndpointBuilderFactory.ServerEndpointBuilder causeOfTransmissionType(org.eclipse.neoscada.protocol.iec60870.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:
causeOfTransmissionTypein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
causeOfTransmissionTypein 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:
causeOfTransmissionTypein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
causeOfTransmissionTypein interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
causeOfTransmissionType- the value to set- Returns:
- the dsl builder
-
informationObjectAddressType
default ServerEndpointBuilderFactory.ServerEndpointBuilder informationObjectAddressType(org.eclipse.neoscada.protocol.iec60870.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:
informationObjectAddressTypein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
informationObjectAddressTypein 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:
informationObjectAddressTypein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
informationObjectAddressTypein 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:
maxUnacknowledgedin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
maxUnacknowledgedin 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:
maxUnacknowledgedin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
maxUnacknowledgedin interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
maxUnacknowledged- the value to set- Returns:
- the dsl builder
-
timeout1
Timeout T1 in milliseconds. The option is a: <code>int</code> type. Default: 15000 Group: connection- Specified by:
timeout1in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
timeout1in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
timeout1- the value to set- Returns:
- the dsl builder
-
timeout1
Timeout T1 in milliseconds. The option will be converted to a <code>int</code> type. Default: 15000 Group: connection- Specified by:
timeout1in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
timeout1in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
timeout1- the value to set- Returns:
- the dsl builder
-
timeout2
Timeout T2 in milliseconds. The option is a: <code>int</code> type. Default: 10000 Group: connection- Specified by:
timeout2in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
timeout2in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
timeout2- the value to set- Returns:
- the dsl builder
-
timeout2
Timeout T2 in milliseconds. The option will be converted to a <code>int</code> type. Default: 10000 Group: connection- Specified by:
timeout2in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
timeout2in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
timeout2- the value to set- Returns:
- the dsl builder
-
timeout3
Timeout T3 in milliseconds. The option is a: <code>int</code> type. Default: 20000 Group: connection- Specified by:
timeout3in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
timeout3in interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
timeout3- the value to set- Returns:
- the dsl builder
-
timeout3
Timeout T3 in milliseconds. The option will be converted to a <code>int</code> type. Default: 20000 Group: connection- Specified by:
timeout3in interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
timeout3in 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:
causeSourceAddressin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
causeSourceAddressin 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:
causeSourceAddressin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
causeSourceAddressin interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
causeSourceAddress- the value to set- Returns:
- the dsl builder
-
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:
connectionTimeoutin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
connectionTimeoutin 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:
connectionTimeoutin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
connectionTimeoutin 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:
ignoreBackgroundScanin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
ignoreBackgroundScanin 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:
ignoreBackgroundScanin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
ignoreBackgroundScanin 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:
ignoreDaylightSavingTimein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
ignoreDaylightSavingTimein 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:
ignoreDaylightSavingTimein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
ignoreDaylightSavingTimein interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
ignoreDaylightSavingTime- the value to set- Returns:
- the dsl builder
-
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:
timeZonein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
timeZonein interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
timeZone- the value to set- Returns:
- the dsl builder
-
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:
timeZonein interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
timeZonein interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
timeZone- the value to set- Returns:
- the dsl builder
-
connectionId
An identifier grouping connection instances. The option is a: <code>java.lang.String</code> type. Group: id- Specified by:
connectionIdin interfaceServerEndpointBuilderFactory.ServerEndpointConsumerBuilder- Specified by:
connectionIdin interfaceServerEndpointBuilderFactory.ServerEndpointProducerBuilder- Parameters:
connectionId- the value to set- Returns:
- the dsl builder
-