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

Interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    ClientEndpointBuilderFactory.ClientEndpointBuilder
    Enclosing interface:
    ClientEndpointBuilderFactory
    public static interface ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the IEC 60870 Client component.

    • Method Detail

      • dataModuleOptions

        default ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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

      • causeSourceAddress

        default ClientEndpointBuilderFactory.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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.ClientEndpointConsumerBuilder 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