| {"component":{"kind":"component","name":"file-watch","title":"File Watch","description":"Get notified about file events in a directory using java.nio.file.WatchService.","deprecated":false,"firstVersion":"3.0.0","label":"file","javaType":"org.apache.camel.component.file.watch.FileWatchComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-file-watch","version":"3.18.1","scheme":"file-watch","extendsScheme":"","syntax":"file-watch:path","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false},"headers":{"CamelFileEventType":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of event. Possible values: CREATE, DELETE, MODIFY.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#EVENT_TYPE_HEADER"},"CamelFileNameOnly":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Only the file name (the name with no leading paths).","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME_ONLY"},"CamelFileAbsolute":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A boolean option specifying whether the consumed file denotes an absolute path or not. Should normally be false for relative paths. Absolute paths should normally not be used but we added to the move option to allow moving files to absolute paths. But can be used elsewhere as well.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_ABSOLUTE"},"CamelFileAbsolutePath":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The absolute path to the file. For relative files this path holds the relative path instead.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_ABSOLUTE_PATH"},"CamelFilePath":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The file path. For relative files this is the starting directory the relative filename. For absolute files this is the absolute path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_PATH"},"CamelFileName":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the consumed file as a relative file path with offset from the starting directory configured on the endpoint.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME"},"CamelFileRelativePath":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The relative path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_RELATIVE_PATH"},"CamelFileNameConsumed":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file that has been consumed","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_NAME_CONSUMED"},"CamelFileParent":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parent path.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_PARENT"},"CamelFileLastModified":{"kind":"header","displayName":"","group":"consumer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Long value containing the last modified timestamp of the file.","constantName":"org.apache.camel.component.file.watch.FileWatchConstants#FILE_LAST_MODIFIED"}},"properties":{"path":{"kind":"path","displayName":"Path","group":"consumer","label":"consumer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path of directory to consume events from."},"antInclude":{"kind":"parameter","displayName":"Ant Include","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"**","description":"ANT style pattern to match files. The file is matched against path relative to endpoint path. Pattern must be also relative (not starting with slash)"},"autoCreate":{"kind":"parameter","displayName":"Auto Create","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Auto create directory if does not exists."},"concurrentConsumers":{"kind":"parameter","displayName":"Concurrent Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"The number of concurrent consumers. Increase this value, if your route is slow to prevent buffering in queue."},"events":{"kind":"parameter","displayName":"Events","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.util.Set<org.apache.camel.component.file.watch.constants.FileEventEnum>","enum":["CREATE","MODIFY","DELETE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"CREATE,MODIFY,DELETE","description":"Comma separated list of events to watch."},"fileHasher":{"kind":"parameter","displayName":"File Hasher","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"io.methvin.watcher.hashing.FileHasher","deprecated":false,"autowired":false,"secret":false,"defaultValue":"#murmur3FFileHasher","description":"Reference to io.methvin.watcher.hashing.FileHasher. This prevents emitting duplicate events on some platforms. For working with large files and if you dont need detect multiple modifications per second per file, use #lastModifiedTimeFileHasher. You can also provide custom implementation in registry."},"pollThreads":{"kind":"parameter","displayName":"Poll Threads","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"description":"The number of threads polling WatchService. Increase this value, if you see OVERFLOW messages in log."},"queueSize":{"kind":"parameter","displayName":"Queue Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"description":"Maximum size of queue between WatchService and consumer. Unbounded by default."},"recursive":{"kind":"parameter","displayName":"Recursive","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Watch recursive in current and child directories (including newly created directories)."},"useFileHashing":{"kind":"parameter","displayName":"Use File Hashing","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Enables or disables file hashing to detect duplicate events. If you disable this, you can get some events multiple times on some platforms and JDKs. Check java.nio.file.WatchService limitations for your target platform."},"bridgeErrorHandler":{"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 occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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":{"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":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."}}} |