Package org.eclipse.hono.config

Interface ServiceOptions

@ConfigMapping(prefix="hono.service", namingStrategy=VERBATIM) public interface ServiceOptions
Options for configuring Hono service components.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    corsAllowedOrigin()
    Gets the allowed origin pattern for CORS handler.
    String
    deviceIdPattern()
    Gets the pattern defining valid device identifiers.
    long
    eventLoopBlockedCheckTimeout()
    Gets the time to wait for completion after which a handler is considered to be blocking the vert.x event loop.
    int
    maxPayloadSize()
    Gets the maximum size of a message payload this server accepts from clients.
    boolean
    networkDebugLoggingEnabled()
    Checks whether the server is configured to log TCP traffic.
    int
    receiverLinkCredit()
    Gets the number of AMQP message credits this service flows to a client when the client opens a sender link to this service.
    long
    sendTimeOut()
    Gets the send timeout value in milliseconds, which is to be used when sending a message on the vert.x event bus.
    ServerOptions
    serverOptions()
    Gets the server options.
    String
    tenantIdPattern()
    Gets the pattern defining valid tenant identifiers.
    boolean
    waitForDownstreamConnectionEnabled()
    Checks whether the server waits for downstream connections to be established during startup.

  • Method Details

    • serverOptions

      @WithParentName ServerOptions serverOptions()
      Gets the server options.
      Returns:
      The options.

    • maxPayloadSize

      @WithDefault("2048") int maxPayloadSize()
      Gets the maximum size of a message payload this server accepts from clients.
      Returns:
      The maximum number of bytes.

    • networkDebugLoggingEnabled

      @WithDefault("false") boolean networkDebugLoggingEnabled()
      Checks whether the server is configured to log TCP traffic.
      Returns:
      true if TCP traffic gets logged.

    • waitForDownstreamConnectionEnabled

      @WithDefault("false") boolean waitForDownstreamConnectionEnabled()
      Checks whether the server waits for downstream connections to be established during startup.

      If this property is set to true then startup may take some time or even time out if the downstream container to connect to is not (yet) available.

      Returns:
      true if the server will wait for downstream connections to be established during startup.

    • receiverLinkCredit

      @WithDefault("100") int receiverLinkCredit()
      Gets the number of AMQP message credits this service flows to a client when the client opens a sender link to this service.
      Returns:
      The number of credits.

    • corsAllowedOrigin

      @WithDefault("*") String corsAllowedOrigin()
      Gets the allowed origin pattern for CORS handler.

      The allowed origin pattern for CORS is returned to clients via the Access-Control-Allow-Origin header. It can be used by Web Applications to make sure that requests go only to trusted backend entities.

      Returns:
      The allowed origin pattern for CORS handler.

    • sendTimeOut

      @WithDefault("3000") long sendTimeOut()
      Gets the send timeout value in milliseconds, which is to be used when sending a message on the vert.x event bus.
      Returns:
      The send timeout value in milliseconds.

    • deviceIdPattern

      @WithDefault("^[a-zA-Z0-9-_\\.:=]+$") String deviceIdPattern()
      Gets the pattern defining valid device identifiers.
      Returns:
      The pattern.

    • tenantIdPattern

      @WithDefault("^[a-zA-Z0-9-_\\.]+$") String tenantIdPattern()
      Gets the pattern defining valid tenant identifiers.
      Returns:
      The pattern.

    • eventLoopBlockedCheckTimeout

      @WithDefault("5000") long eventLoopBlockedCheckTimeout()
      Gets the time to wait for completion after which a handler is considered to be blocking the vert.x event loop.
      Returns:
      The timeout value in milliseconds.