master/component.json

{
  "component": {
    "kind": "component",
    "name": "master",
    "title": "Master",
    "description": "Have only a single consumer in a cluster consuming from a given endpoint; with automatic failover if the JVM dies.",
    "deprecated": false,
    "firstVersion": "1.0.0",
    "label": "clustering",
    "javaType": "org.apache.camel.component.master.MasterComponent",
    "supportLevel": "Stable",
    "nativeSupported": true,
    "metadata": {
      "quarkusVersion": "3.36.0",
      "camelArtifact": "org.apache.camel:camel-master",
      "camelVersion": "4.20.0"
    },
    "groupId": "org.apache.camel.quarkus",
    "artifactId": "camel-quarkus-master",
    "version": "4.20.0 (CEQ 3.36.0)",
    "scheme": "master",
    "extendsScheme": "",
    "syntax": "master:namespace:delegateUri",
    "async": false,
    "api": false,
    "consumerOnly": true,
    "producerOnly": false,
    "lenientProperties": true,
    "browsable": false,
    "remote": true
  },
  "componentProperties": {
    "bridgeErrorHandler": {
      "index": 0,
      "kind": "property",
      "displayName": "Bridge Error Handler",
      "group": "consumer",
      "label": "consumer",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."
    },
    "autowiredEnabled": {
      "index": 1,
      "kind": "property",
      "displayName": "Autowired Enabled",
      "group": "advanced",
      "label": "advanced",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": true,
      "description": "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."
    },
    "backOffDelay": {
      "index": 2,
      "kind": "property",
      "displayName": "Back Off Delay",
      "group": "advanced",
      "label": "advanced",
      "required": false,
      "type": "integer",
      "javaType": "long",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "description": "When the master becomes leader then backoff is in use to repeat starting the consumer until the consumer is successfully started or max attempts reached. This option is the delay in millis between start attempts."
    },
    "backOffMaxAttempts": {
      "index": 3,
      "kind": "property",
      "displayName": "Back Off Max Attempts",
      "group": "advanced",
      "label": "advanced",
      "required": false,
      "type": "integer",
      "javaType": "int",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "description": "When the master becomes leader then backoff is in use to repeat starting the consumer until the consumer is successfully started or max attempts reached. This option is the maximum number of attempts to try."
    },
    "service": {
      "index": 4,
      "kind": "property",
      "displayName": "Service",
      "group": "advanced",
      "label": "advanced",
      "required": false,
      "type": "object",
      "javaType": "org.apache.camel.cluster.CamelClusterService",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "description": "Inject the service to use."
    },
    "serviceSelector": {
      "index": 5,
      "kind": "property",
      "displayName": "Service Selector",
      "group": "advanced",
      "label": "advanced",
      "required": false,
      "type": "object",
      "javaType": "org.apache.camel.cluster.CamelClusterService.Selector",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "description": "Inject the service selector used to lookup the CamelClusterService to use."
    }
  },
  "properties": {
    "namespace": {
      "index": 0,
      "kind": "path",
      "displayName": "Namespace",
      "group": "consumer",
      "label": "",
      "required": true,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The name of the cluster namespace to use"
    },
    "delegateUri": {
      "index": 1,
      "kind": "path",
      "displayName": "Delegate Uri",
      "group": "consumer",
      "label": "",
      "required": true,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The endpoint uri to use in master/slave mode"
    },
    "bridgeErrorHandler": {
      "index": 2,
      "kind": "parameter",
      "displayName": "Bridge Error Handler",
      "group": "consumer (advanced)",
      "label": "consumer,advanced",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."
    },
    "exceptionHandler": {
      "index": 3,
      "kind": "parameter",
      "displayName": "Exception Handler",
      "group": "consumer (advanced)",
      "label": "consumer,advanced",
      "required": false,
      "type": "object",
      "javaType": "org.apache.camel.spi.ExceptionHandler",
      "optionalPrefix": "consumer.",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."
    },
    "exchangePattern": {
      "index": 4,
      "kind": "parameter",
      "displayName": "Exchange Pattern",
      "group": "consumer (advanced)",
      "label": "consumer,advanced",
      "required": false,
      "type": "enum",
      "javaType": "org.apache.camel.ExchangePattern",
      "enum": [
        "InOnly",
        "InOut"
      ],
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "description": "Sets the exchange pattern when the consumer creates an exchange."
    }
  },
  "propertiesSchema": {
    "properties": {
      "namespace": {
        "title": "Namespace",
        "description": "The name of the cluster namespace to use",
        "type": "string",
        "$comment": "group:consumer"
      },
      "delegateUri": {
        "title": "Delegate Uri",
        "description": "The endpoint uri to use in master/slave mode",
        "type": "string",
        "$comment": "group:consumer"
      },
      "bridgeErrorHandler": {
        "title": "Bridge Error Handler",
        "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.",
        "type": "boolean",
        "$comment": "group:consumer (advanced)",
        "default": false
      },
      "exceptionHandler": {
        "title": "Exception Handler",
        "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.",
        "type": "string",
        "$comment": "group:consumer (advanced)",
        "format": "bean:org.apache.camel.spi.ExceptionHandler"
      },
      "exchangePattern": {
        "title": "Exchange Pattern",
        "description": "Sets the exchange pattern when the consumer creates an exchange.",
        "type": "string",
        "enum": [
          "InOnly",
          "InOut"
        ],
        "$comment": "group:consumer (advanced)"
      }
    },
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "required": [
      "namespace",
      "delegateUri"
    ]
  }
}