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

Interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
ClientEndpointBuilderFactory.ClientEndpointBuilder
Enclosing interface:
ClientEndpointBuilderFactory
public static interface ClientEndpointBuilderFactory.ClientEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the IEC 60870 Client component.

  • Method Details

    • advanced

      default ClientEndpointBuilderFactory.AdvancedClientEndpointProducerBuilder advanced()

    • dataModuleOptions

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      dataModuleOptions - the value to set
      Returns:
      the dsl builder

    • dataModuleOptions

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      dataModuleOptions - the value to set
      Returns:
      the dsl builder

    • protocolOptions

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      protocolOptions - the value to set
      Returns:
      the dsl builder

    • protocolOptions

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder protocolOptions(String protocolOptions)
      Protocol options. The option will be converted to a <code>org.eclipse.neoscada.protocol.iec60870.ProtocolOptions</code> type. Group: common
      Parameters:
      protocolOptions - the value to set
      Returns:
      the dsl builder

    • acknowledgeWindow

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder acknowledgeWindow(short acknowledgeWindow)
      Parameter W - Acknowledgment window. The option is a: <code>short</code> type. Default: 10 Group: connection
      Parameters:
      acknowledgeWindow - the value to set
      Returns:
      the dsl builder

    • acknowledgeWindow

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder acknowledgeWindow(String acknowledgeWindow)
      Parameter W - Acknowledgment window. The option will be converted to a <code>short</code> type. Default: 10 Group: connection
      Parameters:
      acknowledgeWindow - the value to set
      Returns:
      the dsl builder

    • adsuAddressType

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      adsuAddressType - the value to set
      Returns:
      the dsl builder

    • adsuAddressType

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      adsuAddressType - the value to set
      Returns:
      the dsl builder

    • causeOfTransmissionType

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      causeOfTransmissionType - the value to set
      Returns:
      the dsl builder

    • causeOfTransmissionType

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      causeOfTransmissionType - the value to set
      Returns:
      the dsl builder

    • informationObjectAddressType

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      informationObjectAddressType - the value to set
      Returns:
      the dsl builder

    • informationObjectAddressType

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      informationObjectAddressType - the value to set
      Returns:
      the dsl builder

    • maxUnacknowledged

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder maxUnacknowledged(short maxUnacknowledged)
      Parameter K - Maximum number of un-acknowledged messages. The option is a: <code>short</code> type. Default: 15 Group: connection
      Parameters:
      maxUnacknowledged - the value to set
      Returns:
      the dsl builder

    • maxUnacknowledged

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      maxUnacknowledged - the value to set
      Returns:
      the dsl builder

    • timeout1

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder timeout1(int timeout1)
      Timeout T1 in milliseconds. The option is a: <code>int</code> type. Default: 15000 Group: connection
      Parameters:
      timeout1 - the value to set
      Returns:
      the dsl builder

    • timeout1

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder timeout1(String timeout1)
      Timeout T1 in milliseconds. The option will be converted to a <code>int</code> type. Default: 15000 Group: connection
      Parameters:
      timeout1 - the value to set
      Returns:
      the dsl builder

    • timeout2

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder timeout2(int timeout2)
      Timeout T2 in milliseconds. The option is a: <code>int</code> type. Default: 10000 Group: connection
      Parameters:
      timeout2 - the value to set
      Returns:
      the dsl builder

    • timeout2

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder timeout2(String timeout2)
      Timeout T2 in milliseconds. The option will be converted to a <code>int</code> type. Default: 10000 Group: connection
      Parameters:
      timeout2 - the value to set
      Returns:
      the dsl builder

    • timeout3

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder timeout3(int timeout3)
      Timeout T3 in milliseconds. The option is a: <code>int</code> type. Default: 20000 Group: connection
      Parameters:
      timeout3 - the value to set
      Returns:
      the dsl builder

    • timeout3

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder timeout3(String timeout3)
      Timeout T3 in milliseconds. The option will be converted to a <code>int</code> type. Default: 20000 Group: connection
      Parameters:
      timeout3 - the value to set
      Returns:
      the dsl builder

    • causeSourceAddress

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder causeSourceAddress(byte causeSourceAddress)
      Whether to include the source address. The option is a: <code>byte</code> type. Group: data
      Parameters:
      causeSourceAddress - the value to set
      Returns:
      the dsl builder

    • causeSourceAddress

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder causeSourceAddress(String causeSourceAddress)
      Whether to include the source address. The option will be converted to a <code>byte</code> type. Group: data
      Parameters:
      causeSourceAddress - the value to set
      Returns:
      the dsl builder

    • connectionTimeout

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      connectionTimeout - the value to set
      Returns:
      the dsl builder

    • connectionTimeout

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      connectionTimeout - the value to set
      Returns:
      the dsl builder

    • ignoreBackgroundScan

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder ignoreBackgroundScan(boolean ignoreBackgroundScan)
      Whether background scan transmissions should be ignored. The option is a: <code>boolean</code> type. Default: true Group: data
      Parameters:
      ignoreBackgroundScan - the value to set
      Returns:
      the dsl builder

    • ignoreBackgroundScan

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      ignoreBackgroundScan - the value to set
      Returns:
      the dsl builder

    • ignoreDaylightSavingTime

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder ignoreDaylightSavingTime(boolean ignoreDaylightSavingTime)
      Whether to ignore or respect DST. The option is a: <code>boolean</code> type. Default: false Group: data
      Parameters:
      ignoreDaylightSavingTime - the value to set
      Returns:
      the dsl builder

    • ignoreDaylightSavingTime

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder ignoreDaylightSavingTime(String ignoreDaylightSavingTime)
      Whether to ignore or respect DST. The option will be converted to a <code>boolean</code> type. Default: false Group: data
      Parameters:
      ignoreDaylightSavingTime - the value to set
      Returns:
      the dsl builder

    • timeZone

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      timeZone - the value to set
      Returns:
      the dsl builder

    • timeZone

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder 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
      Parameters:
      timeZone - the value to set
      Returns:
      the dsl builder

    • connectionId

      default ClientEndpointBuilderFactory.ClientEndpointProducerBuilder connectionId(String connectionId)
      An identifier grouping connection instances. The option is a: <code>java.lang.String</code> type. Group: id
      Parameters:
      connectionId - the value to set
      Returns:
      the dsl builder