org.apache.camel.builder.endpoint.dsl

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 Type	Method and Description
default ServerEndpointBuilderFactory.ServerEndpointBuilder	acknowledgeWindow(short acknowledgeWindow) Parameter W - Acknowledgment window.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	acknowledgeWindow(String acknowledgeWindow) Parameter W - Acknowledgment window.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	adsuAddressType(ServerEndpointBuilderFactory.ASDUAddressType adsuAddressType) The common ASDU address size.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	adsuAddressType(String adsuAddressType) The common ASDU address size.
default ServerEndpointBuilderFactory.AdvancedServerEndpointBuilder	advanced()
default ServerEndpointBuilderFactory.ServerEndpointBuilder	causeOfTransmissionType(ServerEndpointBuilderFactory.CauseOfTransmissionType causeOfTransmissionType) The cause of transmission type.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	causeOfTransmissionType(String causeOfTransmissionType) The cause of transmission type.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	causeSourceAddress(byte causeSourceAddress) Whether to include the source address.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	causeSourceAddress(String causeSourceAddress) Whether to include the source address.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	connectionId(String connectionId) An identifier grouping connection instances.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	connectionTimeout(int connectionTimeout) Timeout in millis to wait for client to establish a connected connection.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	connectionTimeout(String connectionTimeout) Timeout in millis to wait for client to establish a connected connection.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	dataModuleOptions(Object dataModuleOptions) Data module options.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	dataModuleOptions(String dataModuleOptions) Data module options.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	filterNonExecute(boolean filterNonExecute) Filter out all requests which don't have the execute bit set.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	filterNonExecute(String filterNonExecute) Filter out all requests which don't have the execute bit set.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	ignoreBackgroundScan(boolean ignoreBackgroundScan) Whether background scan transmissions should be ignored.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	ignoreBackgroundScan(String ignoreBackgroundScan) Whether background scan transmissions should be ignored.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	ignoreDaylightSavingTime(boolean ignoreDaylightSavingTime) Whether to ignore or respect DST.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	ignoreDaylightSavingTime(String ignoreDaylightSavingTime) Whether to ignore or respect DST.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	informationObjectAddressType(ServerEndpointBuilderFactory.InformationObjectAddressType informationObjectAddressType) The information address size.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	informationObjectAddressType(String informationObjectAddressType) The information address size.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	maxUnacknowledged(short maxUnacknowledged) Parameter K - Maximum number of un-acknowledged messages.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	maxUnacknowledged(String maxUnacknowledged) Parameter K - Maximum number of un-acknowledged messages.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	protocolOptions(Object protocolOptions) Protocol options.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	protocolOptions(String protocolOptions) Protocol options.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	timeout1(int timeout1) Timeout T1 in milliseconds.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	timeout1(String timeout1) Timeout T1 in milliseconds.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	timeout2(int timeout2) Timeout T2 in milliseconds.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	timeout2(String timeout2) Timeout T2 in milliseconds.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	timeout3(int timeout3) Timeout T3 in milliseconds.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	timeout3(String timeout3) Timeout T3 in milliseconds.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	timeZone(String timeZone) The timezone to use.
default ServerEndpointBuilderFactory.ServerEndpointBuilder	timeZone(TimeZone timeZone) The timezone to use.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default ServerEndpointBuilderFactory.AdvancedServerEndpointBuilder advanced()

Specified by:

advanced in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

advanced in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

dataModuleOptions

default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

dataModuleOptions in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

dataModuleOptions

default ServerEndpointBuilderFactory.ServerEndpointBuilder dataModuleOptions(String dataModuleOptions)

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

Specified by:

dataModuleOptions in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

dataModuleOptions in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

filterNonExecute

default ServerEndpointBuilderFactory.ServerEndpointBuilder filterNonExecute(boolean filterNonExecute)

Filter out all requests which don't have the execute bit set. The option is a: boolean type. Default: true Group: common

Specified by:

filterNonExecute in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

filterNonExecute in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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 boolean type. Default: true Group: common

Specified by:

filterNonExecute in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

filterNonExecute in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

protocolOptions

default ServerEndpointBuilderFactory.ServerEndpointBuilder protocolOptions(Object protocolOptions)

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

Specified by:

protocolOptions in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

protocolOptions in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

protocolOptions

default ServerEndpointBuilderFactory.ServerEndpointBuilder protocolOptions(String protocolOptions)

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

Specified by:

protocolOptions in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

protocolOptions in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

acknowledgeWindow

default ServerEndpointBuilderFactory.ServerEndpointBuilder acknowledgeWindow(short acknowledgeWindow)

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

Specified by:

acknowledgeWindow in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

acknowledgeWindow in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

acknowledgeWindow

default ServerEndpointBuilderFactory.ServerEndpointBuilder acknowledgeWindow(String acknowledgeWindow)

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

Specified by:

acknowledgeWindow in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

acknowledgeWindow in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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: org.eclipse.neoscada.protocol.iec60870.ASDUAddressType type. Group: connection

Specified by:

adsuAddressType in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

adsuAddressType in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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 org.eclipse.neoscada.protocol.iec60870.ASDUAddressType type. Group: connection

Specified by:

adsuAddressType in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

adsuAddressType in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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: org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType type. Group: connection

Specified by:

causeOfTransmissionType in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

causeOfTransmissionType in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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 org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType type. Group: connection

Specified by:

causeOfTransmissionType in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

causeOfTransmissionType in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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: org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType type. Group: connection

Specified by:

informationObjectAddressType in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

informationObjectAddressType in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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 org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType type. Group: connection

Specified by:

informationObjectAddressType in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

informationObjectAddressType in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

maxUnacknowledged

default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

maxUnacknowledged in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

maxUnacknowledged

default ServerEndpointBuilderFactory.ServerEndpointBuilder maxUnacknowledged(String maxUnacknowledged)

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

Specified by:

maxUnacknowledged in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

maxUnacknowledged in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

timeout1

default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout1(int timeout1)

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

Specified by:

timeout1 in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

timeout1 in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

timeout1

default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout1(String timeout1)

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

Specified by:

timeout1 in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

timeout1 in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

timeout2

default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout2(int timeout2)

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

Specified by:

timeout2 in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

timeout2 in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

timeout2

default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout2(String timeout2)

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

Specified by:

timeout2 in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

timeout2 in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

timeout3

default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout3(int timeout3)

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

Specified by:

timeout3 in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

timeout3 in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

timeout3

default ServerEndpointBuilderFactory.ServerEndpointBuilder timeout3(String timeout3)

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

Specified by:

timeout3 in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

timeout3 in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

causeSourceAddress

default ServerEndpointBuilderFactory.ServerEndpointBuilder causeSourceAddress(byte causeSourceAddress)

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

Specified by:

causeSourceAddress in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

causeSourceAddress in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

causeSourceAddress

default ServerEndpointBuilderFactory.ServerEndpointBuilder causeSourceAddress(String causeSourceAddress)

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

Specified by:

causeSourceAddress in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

causeSourceAddress in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

connectionTimeout

default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

connectionTimeout in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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 int type. Default: 10000 Group: data

Specified by:

connectionTimeout in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

connectionTimeout in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

ignoreBackgroundScan

default ServerEndpointBuilderFactory.ServerEndpointBuilder ignoreBackgroundScan(boolean ignoreBackgroundScan)

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

Specified by:

ignoreBackgroundScan in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

ignoreBackgroundScan in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

ignoreBackgroundScan

default ServerEndpointBuilderFactory.ServerEndpointBuilder ignoreBackgroundScan(String ignoreBackgroundScan)

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

Specified by:

ignoreBackgroundScan in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

ignoreBackgroundScan in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

ignoreDaylightSavingTime

default ServerEndpointBuilderFactory.ServerEndpointBuilder ignoreDaylightSavingTime(boolean ignoreDaylightSavingTime)

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

Specified by:

ignoreDaylightSavingTime in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

ignoreDaylightSavingTime in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

ignoreDaylightSavingTime

default ServerEndpointBuilderFactory.ServerEndpointBuilder ignoreDaylightSavingTime(String ignoreDaylightSavingTime)

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

Specified by:

ignoreDaylightSavingTime in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

ignoreDaylightSavingTime in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

timeZone

default ServerEndpointBuilderFactory.ServerEndpointBuilder 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 interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

timeZone in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

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 java.util.TimeZone type. Default: UTC Group: data

Specified by:

timeZone in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

timeZone in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

connectionId

default ServerEndpointBuilderFactory.ServerEndpointBuilder connectionId(String connectionId)

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

Specified by:

connectionId in interface ServerEndpointBuilderFactory.ServerEndpointConsumerBuilder

Specified by:

connectionId in interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder