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

Interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    ServerEndpointBuilderFactory.ServerEndpointBuilder
    Enclosing interface:
    ServerEndpointBuilderFactory
    public static interface ServerEndpointBuilderFactory.ServerEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the IEC 60870 Server component.

    • Method Detail

      • dataModuleOptions

        default ServerEndpointBuilderFactory.ServerEndpointProducerBuilder dataModuleOptions​(Object 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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

      • filterNonExecute

        default ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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
        Parameters:
        filterNonExecute - the value to set
        Returns:
        the dsl builder

      • filterNonExecute

        default ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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
        Parameters:
        filterNonExecute - the value to set
        Returns:
        the dsl builder

      • protocolOptions

        default ServerEndpointBuilderFactory.ServerEndpointProducerBuilder protocolOptions​(Object 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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

      • lazyStartProducer

        default ServerEndpointBuilderFactory.ServerEndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default ServerEndpointBuilderFactory.ServerEndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • acknowledgeWindow

        default ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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 ServerEndpointBuilderFactory.ServerEndpointProducerBuilder 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