Package org.apache.camel.builder.component.dsl

Interface MllpComponentBuilderFactory.MllpComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.mllp.MllpComponent>
All Known Implementing Classes:
MllpComponentBuilderFactory.MllpComponentBuilderImpl
Enclosing interface:
MllpComponentBuilderFactory
public static interface MllpComponentBuilderFactory.MllpComponentBuilder extends ComponentBuilder<org.apache.camel.component.mllp.MllpComponent>
Builder for the MLLP component.

  • Method Details

    • autoAck

      default MllpComponentBuilderFactory.MllpComponentBuilder autoAck(boolean autoAck)
      Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      autoAck - the value to set
      Returns:
      the dsl builder

    • charsetName

      default MllpComponentBuilderFactory.MllpComponentBuilder charsetName(String charsetName)
      Sets the default charset to use. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      charsetName - the value to set
      Returns:
      the dsl builder

    • configuration

      default MllpComponentBuilderFactory.MllpComponentBuilder configuration(org.apache.camel.component.mllp.MllpConfiguration configuration)
      Sets the default configuration to use when creating MLLP endpoints. The option is a: <code>org.apache.camel.component.mllp.MllpConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • hl7Headers

      default MllpComponentBuilderFactory.MllpComponentBuilder hl7Headers(boolean hl7Headers)
      Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      hl7Headers - the value to set
      Returns:
      the dsl builder

    • requireEndOfData

      default MllpComponentBuilderFactory.MllpComponentBuilder requireEndOfData(boolean requireEndOfData)
      Enable/Disable strict compliance to the MLLP standard. The MLLP standard specifies START_OF_BLOCKhl7 payloadEND_OF_BLOCKEND_OF_DATA, however, some systems do not send the final END_OF_DATA byte. This setting controls whether or not the final END_OF_DATA byte is required or optional. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      requireEndOfData - the value to set
      Returns:
      the dsl builder

    • stringPayload

      default MllpComponentBuilderFactory.MllpComponentBuilder stringPayload(boolean stringPayload)
      Enable/Disable converting the payload to a String. If enabled, HL7 Payloads received from external systems will be validated converted to a String. If the charsetName property is set, that character set will be used for the conversion. If the charsetName property is not set, the value of MSH-18 will be used to determine th appropriate character set. If MSH-18 is not set, then the default ISO-8859-1 character set will be use. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      stringPayload - the value to set
      Returns:
      the dsl builder

    • validatePayload

      default MllpComponentBuilderFactory.MllpComponentBuilder validatePayload(boolean validatePayload)
      Enable/Disable the validation of HL7 Payloads If enabled, HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected, a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      validatePayload - the value to set
      Returns:
      the dsl builder

    • acceptTimeout

      default MllpComponentBuilderFactory.MllpComponentBuilder acceptTimeout(int acceptTimeout)
      Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only. The option is a: <code>int</code> type. Default: 60000 Group: consumer
      Parameters:
      acceptTimeout - the value to set
      Returns:
      the dsl builder

    • backlog

      default MllpComponentBuilderFactory.MllpComponentBuilder backlog(Integer backlog)
      The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full, the connection is refused. The option is a: <code>java.lang.Integer</code> type. Default: 5 Group: consumer
      Parameters:
      backlog - the value to set
      Returns:
      the dsl builder

    • bindRetryInterval

      default MllpComponentBuilderFactory.MllpComponentBuilder bindRetryInterval(int bindRetryInterval)
      TCP Server Only - The number of milliseconds to wait between bind attempts. The option is a: <code>int</code> type. Default: 5000 Group: consumer
      Parameters:
      bindRetryInterval - the value to set
      Returns:
      the dsl builder

    • bindTimeout

      default MllpComponentBuilderFactory.MllpComponentBuilder bindTimeout(int bindTimeout)
      TCP Server Only - The number of milliseconds to retry binding to a server port. The option is a: <code>int</code> type. Default: 30000 Group: consumer
      Parameters:
      bindTimeout - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default MllpComponentBuilderFactory.MllpComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to receive incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. If disabled, the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions by logging them at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • lenientBind

      default MllpComponentBuilderFactory.MllpComponentBuilder lenientBind(boolean lenientBind)
      TCP Server Only - Allow the endpoint to start before the TCP ServerSocket is bound. In some environments, it may be desirable to allow the endpoint to start before the TCP ServerSocket is bound. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      lenientBind - the value to set
      Returns:
      the dsl builder

    • maxConcurrentConsumers

      default MllpComponentBuilderFactory.MllpComponentBuilder maxConcurrentConsumers(int maxConcurrentConsumers)
      The maximum number of concurrent MLLP Consumer connections that will be allowed. If a new connection is received and the maximum is number are already established, the new connection will be reset immediately. The option is a: <code>int</code> type. Default: 5 Group: consumer
      Parameters:
      maxConcurrentConsumers - the value to set
      Returns:
      the dsl builder

    • reuseAddress

      default MllpComponentBuilderFactory.MllpComponentBuilder reuseAddress(Boolean reuseAddress)
      Enable/disable the SO_REUSEADDR socket option. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: consumer
      Parameters:
      reuseAddress - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default MllpComponentBuilderFactory.MllpComponentBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Default: InOut Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • connectTimeout

      default MllpComponentBuilderFactory.MllpComponentBuilder connectTimeout(int connectTimeout)
      Timeout (in milliseconds) for establishing for a TCP connection TCP Client only. The option is a: <code>int</code> type. Default: 30000 Group: producer
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • idleTimeoutStrategy

      default MllpComponentBuilderFactory.MllpComponentBuilder idleTimeoutStrategy(org.apache.camel.component.mllp.MllpIdleTimeoutStrategy idleTimeoutStrategy)
      decide what action to take when idle timeout occurs. Possible values are : RESET: set SO_LINGER to 0 and reset the socket CLOSE: close the socket gracefully default is RESET. The option is a: <code>org.apache.camel.component.mllp.MllpIdleTimeoutStrategy</code> type. Default: RESET Group: producer
      Parameters:
      idleTimeoutStrategy - the value to set
      Returns:
      the dsl builder

    • keepAlive

      default MllpComponentBuilderFactory.MllpComponentBuilder keepAlive(Boolean keepAlive)
      Enable/disable the SO_KEEPALIVE socket option. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: producer
      Parameters:
      keepAlive - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default MllpComponentBuilderFactory.MllpComponentBuilder 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

    • tcpNoDelay

      default MllpComponentBuilderFactory.MllpComponentBuilder tcpNoDelay(Boolean tcpNoDelay)
      Enable/disable the TCP_NODELAY socket option. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: producer
      Parameters:
      tcpNoDelay - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default MllpComponentBuilderFactory.MllpComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • defaultCharset

      default MllpComponentBuilderFactory.MllpComponentBuilder defaultCharset(String defaultCharset)
      Set the default character set to use for byte to/from String conversions. The option is a: <code>java.lang.String</code> type. Default: ISO-8859-1 Group: advanced
      Parameters:
      defaultCharset - the value to set
      Returns:
      the dsl builder

    • logPhi

      default MllpComponentBuilderFactory.MllpComponentBuilder logPhi(Boolean logPhi)
      Whether to log PHI. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: advanced
      Parameters:
      logPhi - the value to set
      Returns:
      the dsl builder

    • logPhiMaxBytes

      default MllpComponentBuilderFactory.MllpComponentBuilder logPhiMaxBytes(Integer logPhiMaxBytes)
      Set the maximum number of bytes of PHI that will be logged in a log entry. The option is a: <code>java.lang.Integer</code> type. Default: 5120 Group: advanced
      Parameters:
      logPhiMaxBytes - the value to set
      Returns:
      the dsl builder

    • maxBufferSize

      default MllpComponentBuilderFactory.MllpComponentBuilder maxBufferSize(int maxBufferSize)
      Maximum buffer size used when receiving or sending data over the wire. The option is a: <code>int</code> type. Default: 1073741824 Group: advanced
      Parameters:
      maxBufferSize - the value to set
      Returns:
      the dsl builder

    • minBufferSize

      default MllpComponentBuilderFactory.MllpComponentBuilder minBufferSize(int minBufferSize)
      Minimum buffer size used when receiving or sending data over the wire. The option is a: <code>int</code> type. Default: 2048 Group: advanced
      Parameters:
      minBufferSize - the value to set
      Returns:
      the dsl builder

    • readTimeout

      default MllpComponentBuilderFactory.MllpComponentBuilder readTimeout(int readTimeout)
      The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received. The option is a: <code>int</code> type. Default: 5000 Group: advanced
      Parameters:
      readTimeout - the value to set
      Returns:
      the dsl builder

    • receiveBufferSize

      default MllpComponentBuilderFactory.MllpComponentBuilder receiveBufferSize(Integer receiveBufferSize)
      Sets the SO_RCVBUF option to the specified value (in bytes). The option is a: <code>java.lang.Integer</code> type. Default: 8192 Group: advanced
      Parameters:
      receiveBufferSize - the value to set
      Returns:
      the dsl builder

    • receiveTimeout

      default MllpComponentBuilderFactory.MllpComponentBuilder receiveTimeout(int receiveTimeout)
      The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame. The option is a: <code>int</code> type. Default: 15000 Group: advanced
      Parameters:
      receiveTimeout - the value to set
      Returns:
      the dsl builder

    • sendBufferSize

      default MllpComponentBuilderFactory.MllpComponentBuilder sendBufferSize(Integer sendBufferSize)
      Sets the SO_SNDBUF option to the specified value (in bytes). The option is a: <code>java.lang.Integer</code> type. Default: 8192 Group: advanced
      Parameters:
      sendBufferSize - the value to set
      Returns:
      the dsl builder

    • idleTimeout

      default MllpComponentBuilderFactory.MllpComponentBuilder idleTimeout(Integer idleTimeout)
      The approximate idle time allowed before the Client TCP Connection will be reset. A null value or a value less than or equal to zero will disable the idle timeout. The option is a: <code>java.lang.Integer</code> type. Group: tcp
      Parameters:
      idleTimeout - the value to set
      Returns:
      the dsl builder