{
  "component": {
    "kind": "component",
    "name": "lucene",
    "title": "Lucene",
    "description": "Perform inserts or queries against Apache Lucene databases.",
    "deprecated": false,
    "firstVersion": "2.2.0",
    "label": "database,search",
    "javaType": "org.apache.camel.component.lucene.LuceneComponent",
    "supportLevel": "Stable",
    "groupId": "org.apache.camel",
    "artifactId": "camel-lucene",
    "version": "3.19.0-SNAPSHOT",
    "scheme": "lucene",
    "extendsScheme": "",
    "syntax": "lucene:host:operation",
    "async": false,
    "api": false,
    "consumerOnly": false,
    "producerOnly": true,
    "lenientProperties": false
  },
  "componentProperties": {
    "analyzer": { "kind": "property", "displayName": "Analyzer", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.lucene.analysis.Analyzer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box" },
    "indexDir": { "kind": "property", "displayName": "Index Dir", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.io.File", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "A file system directory in which index files are created upon analysis of the document by the specified analyzer" },
    "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." },
    "maxHits": { "kind": "property", "displayName": "Max Hits", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "An integer value that limits the result set of the search operation" },
    "srcDir": { "kind": "property", "displayName": "Src Dir", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.io.File", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "An optional directory containing files to be used to be analyzed and added to the index at producer startup." },
    "autowiredEnabled": { "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." },
    "config": { "kind": "property", "displayName": "Config", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.lucene.LuceneConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "To use a shared lucene configuration" }
  },
  "headers": {
    "QUERY": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Lucene Query to performed on the index. The query may include wildcards and phrases.", "constantName": "org.apache.camel.component.lucene.LuceneConstants#HEADER_QUERY" },
    "RETURN_LUCENE_DOCS": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Set this header to true to include the actual Lucene documentation when returning hit information.", "constantName": "org.apache.camel.component.lucene.LuceneConstants#HEADER_RETURN_LUCENE_DOCS" }
  },
  "properties": {
    "host": { "kind": "path", "displayName": "Host", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "The URL to the lucene server" },
    "operation": { "kind": "path", "displayName": "Operation", "group": "producer", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.lucene.LuceneOperation", "enum": [ "insert", "query" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "Operation to do such as insert or query." },
    "analyzer": { "kind": "parameter", "displayName": "Analyzer", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.lucene.analysis.Analyzer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box" },
    "indexDir": { "kind": "parameter", "displayName": "Index Dir", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.io.File", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "A file system directory in which index files are created upon analysis of the document by the specified analyzer" },
    "maxHits": { "kind": "parameter", "displayName": "Max Hits", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "An integer value that limits the result set of the search operation" },
    "srcDir": { "kind": "parameter", "displayName": "Src Dir", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.io.File", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.lucene.LuceneConfiguration", "configurationField": "config", "description": "An optional directory containing files to be used to be analyzed and added to the index at producer startup." },
    "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." }
  }
}