大综合_百度文库
两大类热门资源免费畅读
续费一年阅读会员，立省24元！
上传于||暂无简介
阅读已结束，如果下载本文需要使用0下载券
想免费下载更多文档？
下载文档到电脑，查找使用更方便
还剩165页未读，继续阅读
你可能喜欢From Terraria Wiki
(Redirected from )
Biomes refer to the different types of areas that a Terraria world can contain. Biomes can each contain their own characteristic terrain , collectible , backdrops, , , theme music, and other traits.
The most common biomes are , located on the surface. Going farther left or right will eventually lead to
or the , , , , the , and at the far right and left of the world, the two .
"Underground" biomes begin at the
layer and include the
biome, the
biome, the
biome, and the . The sky contains .
The world is also divided into
that describe world characteristics depending on depth. The Surface, Underground, and Cavern layers can each contain several different biomes. In contrast, , the layer appearing at the very top of the world, and , the layer covering the very bottom of the map, additionally sport their own biome characteristics across the entire map horizontally, rather than containing multiple biomes.
After the initial defeat of the
in The Underworld, the world converts to , and new points of Corruption or Crimson will form, as well as a new environment, , in addition to underground versions of those.
Space is a layer appearing at the top of the world: 700 feet and above, for medium worlds. The sky is dark and stars are visible, even when the Sun is still up, and gravity affects players less. Nothing much happens in Space, except for the exclusive background and music.
Biomes that appear above the
layer operate as surface biomes, even though they can and do often extend underground. The actual "Underground" versions of biomes, such as the
biome, with distinct underground characteristics, do not begin until Cavern layer depths.
Forests are the most common
biome, and are where the player usually spawns upon starting a new world. Green
grows across the , which can spawn , , and . Forests appear whenever no other biome is valid.
Snow biomes are winter-themed and predominately made of
blocks. They are occasionally home to the player's spawn in a new world. Snow falls constantly, though this is only an aesthetic effect. The Snow Biome is always located opposite to the Jungle and thus on the same side of the map as the Dungeon.
Deserts are large expanses of
that require at least 1000 sand or other desert themed blocks. They are common between Forests.
The Jungle is a difficult surface biome composed of Jungle Grass, Vines, Mud and Jungle Trees. The sky appears a vibrant green color.
respawn automatically without the need to plant . The Jungle will always be located on the opposite side of the map from the Snow and Dungeon. Very easy to find.
A world will always generate with either Crimson or Corruption, but never both. Each are hazardous biomes that offer access to important loot, , and .
The Corruption follows a spooky theme and features vertical chasms, , and Demon .
The Crimson follows a gory theme and features angled chasms, , and Crimson Altars.
The surface version of the Mushroom biome does not occur naturally, but can be cultivated by players, using
or an imported
on surface-level . Regardless of the time it will always appear darker than night.
At each end of every map stands a deep body of , where dangerous swimming enemies are found, and
contain ocean-themed loot.
The Cavern layer marks the beginning of distinct Underground biome variants, with separate characteristics from their surface versions.
The Cavern layer equivalent to the Snow biome. Many ledges and bodies of water will have a thin layer of ice over them, and while they can support the player's weight they can break if you land on them with high enough speed. Ice Chests contain ice-themed equipment. It contains more dangerous enemies than its surface counterpart.
This biome features glowing mushrooms on top of mud, and if there is enough height in the cavern, giant mushrooms can grow as well. It has a unique background.
The Underground Jungle is a difficult biome found at Cavern depth under the surface Jungle. Its dense catacomb of compartments contain several hazards and dense vegetation, as well as important loot and . In Hardmode, valuable
can be mined here. After the
have been defeated,
spawn, allowing the player to summon , an important . The
is also found here, where the
boss can be summoned after Plantera is defeated.
is a difficult pre-Hardmode biome found at Cavern layer under the surface Desert. The biome is always sphere-shaped and contains various types of
as well as ancient-Egyptian themed mobs in hardmode.
The Underworld is a difficult area located along the entire bottom of the world.
pools cover much of its terrain and dangerous enemies spawn often.
can be mined here,
offer valuable loot (some within their ), and unique furniture, and the
can be summoned here in order to activate .
Hardmode biomes spawn or convert as a result of the game transitioning to Hardmode.
The Hallow is the "anti-corruption" biome, which is automatically created once the player activates
by defeating the . The biome has pastel-colored imagery but is nevertheless highly difficult.
The Underground Hallow is located beneath surface Hallow, starting at the
layer. It has a different soundtrack from the overworld Hallow, and contains even more difficult enemies as well as valuable items.
The Underground Corruption is created in the
layer upon defeating the . It shares the same feel as the overworld Corruption, but has different enemies, a different soundtrack (a mix of the regular Underground and Corruption soundtrack), and it's the only place to find
and . All enemies from the overworld version are present, as well as , , and .
The alternative to the Underground Corruption, which functions and is spawned in mostly the same way. The Underground Crimson, like the Corruption variety, will have enemies occasionally drop .
This is the only place where enemies drop .
When the world enters , several Deserts of the world will become either , , or . These have their own backgrounds, and spawn unique versions of the . Sand is replaced by , , or .
Biomes in this category tend to be small in number and size.
They have unique characteristics and monster spawns.
The Dungeon is a difficult labyrinth leading from the Surface down to near-Underworld depths. The
stands at the entrance, and using him to defeat
will allow you to access to the inside. If you go into the Dungeon before Skeletron is defeated, one or more
will spawn and kill you (if you travel below 0 depth). The items/loot found in the Dungeon are rare, valuable, and some cannot be found elsewhere.
Whenever a
is destroyed, there is a chance that within the next day the game will spawn a meteor and display the message "A meteorite has landed!". The meteor will crash into land and turn a large portion of the surrounding tiles into . Meteorite will burn the player if they do not have an
that nullifies fire's effects, and/or an . Meteorite requires a , , or better, in order to mine the meteorite.
are the only enemies that spawn instead of the other natives.
Spider Nests are rare mini-biomes that can be located underground, noted by the black background wall and the numerous webs filling the area.
This biome will spawn
when entered.
filling this area rapidly grow back, which is a unique feature of the biome. Spider Nests are the only location where one can find
and all unique treasures discovered therein. The
is found in this biome.
The Bee Hive occurs in the . Bee Hives are made from Hive blocks and contain
and often a . If you destroy the larva, it will summon the
boss. When you break the Hive Block, a bee will come out. They can sometimes have them with two or three next to them.
A large structure found in the Underground Jungle, the Jungle Temple is an end-game biome that can be accessed with a key dropped by . It is densely packed with unique enemies and , and its large final chamber allows the player to summon the
Cave area made completely out of marble. Contains enemies such as
Cave area made completely of . Contains enemies such as
Treasure rooms are spawned with world creation and appear as if they were man-made structures. They generally contain loot and furniture.
are typically wooden buildings full of dusty, broken furniture as well as chests, vases, and occasionally usable furniture and decorations.
They are found in the underground in the cavern, glowing mushroom, jungle, desert, and snow biomes. As of 1.3.0.1, underground cabins now spawn with wood and walls that are unique to their biome.
are small brick buildings and typically contain only a single chest and a light source.
They are found in the
and several can appear in one biome.
Ruined houses are generated at World creation in The Underworld in the middle third of the Underworld. They are towers with multiple levels, constructed with missing parts for a "ruined" look, from Obsidian Brick or Hellstone Brick.
They are sometimes partially submerged in lava and often contain deposits of hellstone just outside their walls.
is filled with concentrated gem deposits of one or more varieties and features a unique background (a gemstone wall) that is speckled with gems of the same color found in the Gemstone Cave.
Floating Islands are independent masses of land in the sky. Once located, and when the player obtains the tools to reach them, they have access to their unique furniture and some powerful loot.
(Arch Wyvern and
in Hardmode) attack at their height.
Pyramids are rarely generated in the
at world creation. They are made of
and contain a narrow passage. The treasure room is filled with coins, vases and a gold chest that can contain unique loot, also in the mobile version there is usually another secret room containing more vases money and chest.
There is also a passage to a mine at the bottom.
are huge, thick trees that can be generated. Cutting the tree yields regular . Some of those trees can be hollow and lead deep underground. There may be rooms containing
with related loot inside, as well as , , ,
and other Living Wood furniture.
Houses an , an
or a fake sword. Every shrine will contain one breakable background sword sprite, which has a 2/3 chance of being a fake sword and a 1/3 chance of being a real sword, which has a 1/10 chance of dropping the Arkhalis, instead of the Enchanted Sword, when destroyed.
A Mini Biome found in the
Biome that is made entirely of
and the occasional ore vein.
Exclusive to the
, Heart Shrines are heart-shaped caves sometimes found in Snow biomes. They hold two
and a chest that may contain "heart"-items. They can contain Heart Lanterns, Heart Statues, Heart Potions, and stuff like that.
It has been suggested that this page/section be rewritten.Reason: "Corrupt and Crimson Deserts should be listed above, as they have unique spawns and items"
While many of the basic biomes appear at world generation or triggered by events, it is possible for hybridized biomes to be synthesized by player action or, in Hardmode, by world mechanics.
Hybrid biomes are those created by the requirements being met for multiple biomes in a certain space. The simplest examples are Hallowed or corrupted D however, not only Deserts can be hybridized. Floating Islands can be corrupted or Hallowed upon entry of Hardmode, and such high-layered biomes are even required by some
quests. Player action can similarly introduce Corruption, Crimson, Hallow, Desert, Jungle, Mushroom, Meteorite, or Snow biomes to any location from Underworld to Sky and likely even Space. This can lead to, for example in an Underworld Crimson, Underworld and Crimson enemies both spawning in the applicable areas.
The discussion of the area used for counting required blocks for the existence of biomes at a location appears to be 50 tiles to each side and approximately 42 below and 44 above. Note that Compatible Biomes lists the biomes which can co-exist in the same general location, and has nothing to do with spreading mechanics.
Block Requirements
Compatible Biomes
Above the Underworld
Sky, Surface, Underground, Cavern, Ocean
Corruption
At least 200
Corrupt Grass,
s, Corrupt , or
Not Forest, Meteorite, or Hallow
At least 200
Crimson Grass,
s, Crimson , or
Not Forest, Meteorite, or Hallow
At least 100
Mushroom Grass or
Not Forest or Meteorite
At least 80
Jungle Grass,
s, Jungle , or Jungle
Not Forest or Meteorite
At least 100
Hallowed Grass,
s, or Hallowed
Not Forest, Meteorite, Corruption, or Crimson
At least 1,000
Not Forest or Meteorite
At least 1,000 block spaces of water
Outer lateral edges of the world, above Cavern layer
Not Meteorite, Corrupted Desert, Crimson Desert, or Hallowed Desert
At least 300
s, and possibly other Snow Biome blocks
Not Meteorite or Desert
At least 50
At least 250
and a naturally-placed Wall other than Dirt Wall
Below -4 feet
Note that the requirement for naturally-placed Walls makes a synthetic Dungeon biome nearly impossible and, if accomplished, it would be unable to spawn Hardmode Dungeon enemies or
(as they require naturally-placed ), though it may be useful for creating a lake for farming . It appears that the only option for expanding the space in which Hardmode Dungeon enemies can spawn is by mining blocks already inside the area in which the Dungeon originally generated, without damaging any naturally-placed Walls they are covering.
 ·  · Biomes 
 •  •  •  •  •  •  •  •  • 
 •  •  •   •  •  •  •  •  • 
Special Biomes
 •   •   •  •  •  • 
 •   •  •  •  •  •  •   • Apache Camel: File2
File ComponentThe File component provides access to file systems, allowing files to be processed by any other Camel
or messages from other components to be saved to disk.URI format
Where directoryName represents the underlying file directory.You can append query options to the URI in the following format, ?option=value&option=value&...URI OptionsCommonNameDefault ValueDescriptionautoCreatetrueAutomatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to.bufferSize128kbWrite buffer sized in bytes.fileNamenullUse
to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an ). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the . If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use
expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the
syntax: mydata-${date:now:yyyyMMdd}.txt. From Camel 2.11 onwards the producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards.flattenfalseFlatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name recived in CamelFileName header will be stripped for any leading paths.charsetnullCamel 2.9.3: this option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. See further below for a examples and more important details.copyAndDeleteOnRenameFailtrueCamel 2.9: whether to fallback and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the
component.renameUsingCopyfalseCamel 2.13.1: Perform rename operations using a copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable (e.g. across different file systems or networks). This option takes precedence over the copyAndDeleteOnRenameFail parameter that will automatically fall back to the copy and delete strategy, but only after additional delays.ConsumerNameDefault ValueDescriptioninitialDelay1000Milliseconds before polling the file/directory starts.delay500Milliseconds before the next poll of the file/directory.useFixedDelay Controls if fixed delay or fixed rate is used. See
in JDK for details. In Camel 2.7.x or older the default value is false. From Camel 2.8 onwards the default value is true.runLoggingLevelTRACECamel 2.8: The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.recursivefalseIf a directory, will look for files in all the sub-directories as well.deletefalseIf true, the file will be deleted after it is processed successfully.noopfalseIf true, the file is not moved or deleted in any way. This option is good for readonly data, or for
type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again.preMovenull (such as ) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order.move.camel (such as ) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done.moveFailednull (such as ) used to dynamically set a different target directory when moving files in case of processing (configured via move defined above) failed. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the “fail” location Camel will handle the error and will not pick up the file again.includenullIs used to include files, if filename matches the regex pattern (matching is case in-sensitive from Camel 2.17 onwards).excludenullIs used to exclude files, if filename matches the regex pattern (matching is case in-sensitive from Camel 2.17 onwards).antIncludenullCamel 2.10: Ant style filter inclusion, for example antInclude=*/.txt. Multiple inclusions may be specified in comma-delimited format. See
for more details about ant path filters.antExcludenullCamel 2.10: Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format. See
for more details about ant path filters.antFilterCaseSensitivetrueCamel 2.11: Ant style filter which is case sensitive or not.idempotentfalseOption to use the
EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again.idempotentKeyExpressionCamel 2.11: To use a custom idempotent key. By default the absolute path of the file is used. You can use the , for example to use the file name and file size, you can do:
.idempotentRepositorynullA pluggable repository
which by default use MemoryMessageIdRepository if none is specified and idempotent is true.inProgressRepositorymemoryA pluggable in-progress repository . The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used.filternullPluggable filter as a org.ponent.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. More details in section below.filterDirectorynullCamel 2.18: Filters the directory based on
language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}filterFilenullCamel 2.18: Filters the file based on
language. For example to filter on file size, you can use ${file:size} & 5000shufflefalseCamel 2.16: To shuffle the list of files (sort in random order)sorternullPluggable sorter as a
class.sortBynullBuilt-in sort using the . Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date. See sorting section below for details.readLocknoneUsed by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted.
This option provides the build in strategies:  none is for no read locks at all.
markerFile Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the
component. changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec. to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. This option is only avail for the
component from Camel 2.8 onwards. Notice that from Camel 2.10.1 onwards the
option fastExistsCheck can be enabled to speedup this readLock strategy, if the FTP server support the LIST operation with a full file name (some servers may not).
fileLock is for using java.nio.channels.FileLock. This option is not avail for the
component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks.
rename is for using a try to rename the file as a test if we can get exclusive read-lock. idempotent Camel 2.16 (only file component) is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. Warning: Most of the read lock strategies are not suitable for use in clustered mode. That is, you cannot have multiple consumers attempting to read the same file in the same directory. In this case, the read locks will not function reliably. The idempotent read lock supports clustered reliably if you use a cluster aware idempotent repository implementation such as from
or .readLockTimeout10000Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. In Camel 2.0 the default value is 0. Starting with Camel 2.1 the default value is 10000. Currently fileLock, changed and rename support the timeout. Notice: For
the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit.readLockCheckInterval1000Camel 2.6: Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. For
the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that ample time is allowed for the read lock process to try to grab the lock before the timeout was hit.readLockMinLength1Camel 2.10.1: This option applied only for readLock=changed. This option allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files.readLockMinAge0Camel 2.15: This option applies only to readLock=change. This option allows you to specify a minimum age a file must be before attempting to acquire the read lock. For example, use readLockMinAge=300s to require that the file is at least 5 minutes old. This can speedup the poll when the file is old enough as it will acquire the read lock immediately. Notice for FTP: file timestamps reported by FTP servers are often reported with resolution of minutes, so readLockMinAge parameter should be defined in minutes, e.g. 60000 for 1 minute. Notice that Camel supports specifying this as 60s, or 1m, etc.readLockLoggingLevelWARNCamel 2.12: Logging level used when a read lock could not be acquired. By default a WARN is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, rename.readLockMarkerFiletrueCamel 2.14: Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application.readLockRemoveOnRollbacktrueCamel 2.16: This option applied only for readLock=idempotent. This option allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit).readLockRemoveOnCommitfalseCamel 2.16: This option applied only for readLock=idempotent. This option allows to specify whether to remove the file name entry from the idempotent repository when processing the file succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions.readLockDeleteOrphanLockFilestrueCamel 2.16: Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory.directoryMustExistfalseCamel 2.5: Similar to startingDirectoryMustExist but this applies during polling recursive sub directories.doneFileNamenullCamel 2.6: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file is always expected in the same folder as the original file. See using done file and writing done file sections for examples.exclusiveReadLockStrategynullPluggable read-lock as a org.ponent.file.GenericFileExclusiveReadLockStrategy implementation.maxMessagesPerPoll0An integer to define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. See more details at . Notice: If this option is in use then the
components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards.eagerMaxMessagesPerPolltrueCamel 2.9.3: Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting.minDepth0Camel 2.8: The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory. This option is supported by
consumer from Camel 2.8.2, 2.9 onwards.maxDepthInteger.MAX_VALUECamel 2.8: The maximum depth to traverse when recursively processing a directory. This option is supported by
consumer from Camel 2.8.2, 2.9 onwards.processStrategynullA pluggable org.ponent.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply.startingDirectoryMustExistfalseCamel 2.5: Whether the starting directory must exist. Mind that the autoCreate option is default enabled, which means the starting directory is normally auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the starting directory must exist. Will thrown an exception if the directory doesn't exist.pollStrategynullA pluggable org.apache.camel.spi.PollingConsumerPollStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an
have been created and being routed in Camel. In other words the error occurred while the polling was gathering information, for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it.sendEmptyMessageWhenIdlefalseCamel 2.9: If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.consumer.bridgeErrorHandlerfalseCamel 2.10: Allows for bridging the consumer to the Camel routing , which mean any exceptions occurred while trying to pickup files, or the likes, will now be processed as a message and handled by the routing . By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that by default will be logged at WARN/ERROR level and ignored. See further below on this page fore more details, at section How to use the Camel error handler to deal with exceptions triggered outside the routing engine.scheduledExecutorServicenullCamel 2.10: Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple file consumers.schedulernullCamel 2.12: To use a custom scheduler to trigger the consumer to run. See more details at , for example there is a , and
based scheduler that supports CRON expressions.backoffMultiplier0Camel 2.12: To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. See more details at .backoffIdleThreshold0Camel 2.12: The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffErrorThreshold0Camel 2.12: The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.onCompletionExceptionHandler Camel 2.16: To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore.probeContentTypefalseCamel 2.17: Whether to enable probing of the content type. If enable then the consumer uses Files#probeContentType(java.nio.file.Path) to determine the content-type of the file, and store that as a header with key Exchange#FILE_CONTENT_TYPE on the Message. Notice from Camel 2.15 onwards this function was introduced and was always enabled. But from Camel 2.17 it is off by default as it can cause issues on some file systems.extendedAttributesnullCamel 2.17: To enable gathering extended file attributes through java.nio.file.attribute classes using Files.getAttribute(ava.nio.file.Path, java.lang.String attribute) or
Files.readAttributes(ava.nio.file.Path, java.lang.String attributes) depending on the option value. This option supports a comma delimited list of attributes to collect i.e. basic:creationTime,posix:group or simple wildcard i.e. posix:*. If the attribute name is not prefixed, the basic attributes are queried. The result is stored as a header with key CamelFileExtendedAttributes and it is of type Map&String, Object& where the key is the name of the attribute (i.e. posix:group) and the value is the attributed returned by the call to Files.getAttribute() or Files.readAttributesDefault behavior for file consumerBy default the file is not locked for the duration of the processing.After the route has completed, files are moved into the .camel subdirectory, so that they appear to be deleted.The File Consumer will always skip any file whose name starts with a dot, such as ., .camel, .m2 or .groovy.Only files (not directories) are matched for valid filename, if options such as: include or exclude are used.ProducerNameDefault ValueDescriptionfileExistOverrideWhat to do if a file already exists with the same name. The following values can be specified: Override, Append, Fail, Ignore, Move, and TryRename (Camel 2.11.1). Override, which is the default, replaces the existing file. Append adds content to the existing file. Fail throws a GenericFileOperationException, indicating that there is already an existing file. Ignore silently ignores the problem and does not override the existing file, but assumes everything is okay. The Move option requires Camel 2.10.1 onwards, and the corresponding moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if moving the file, and there already exists a file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. TryRename Camel 2.11.1 is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers.tempPrefixnullThis option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written to and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by
when uploading big files.tempFileNamenullCamel 2.1: The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the .moveExistingnullCamel 2.10.1:
(such as ) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following
tokens: "file:name", "file:name.ext", "file:name.noext", "file:onlyname", "file:onlyname.noext", "file:ext", and "file:parent". Notice the "file:parent" is not supported by the
component, as the FTP component can only move any existing files to a relative directory based on current dir as base.keepLastModifiedfalseCamel 2.2: Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers.eagerDeleteTargetFiletrueCamel 2.3: Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exist while the temp file is being written. This ensures that the target file is only deleted at the very last moment, just before the temp file is being renamed to the target filename. From Camel 2.10.1 onwards this option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFail is false, then an exception will be thrown if an existing file existed, if it is true, then the existing file is deleted before the move operation.doneFileNamenullCamel 2.6: If provided, then Camel will write a second file (called done file) when the original file has been written. The done file will be empty. This option configures what file name to use. You can either specify a fixed name, or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. See writing done file section for examples.allowNullBodyfalseCamel 2.10.1: Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the `fileExist` option is set to 'Override', then the file will be truncated, and if set to `append` the file will remain unchanged.forceWritestrueCamel 2.10.5/2.11: Whether to force syncing writes to the file system. You can turn this off if you do not want this level of guarantee, for example if writing to logs / this would yield better performance.chmodnullCamel 2.15.0: Specify the file permissions which is sent by the producer, the chmod value must be between 000 and 777; If there is a leading digit like in 0755 we will ignore it.chmodDirectorynullCamel 2.17.0: Specify the directory permissions used when the producer creates missing directories, the chmod value must be between 000 and 777; If there is a leading digit like in 0755 we will ignore it.Default behavior for file producerBy default it will override any existing file, if one exist with the same name.Move and Delete operationsAny move or delete operations is executed after (post command) the r so during processing of the Exchange the file is still located in the inbox folder.Lets illustrate this with an example:
When a file is dropped in the inbox folder, the file consumer notices this and creates a new FileExchange that is routed to the handleOrder bean. The bean then processes the File object. At this point in time the file is still located in the inbox folder. After the bean completes, and thus the route is completed, the file consumer will perform the move operation and move the file to the .done sub-folder.The move and the preMove options are considered as a directory name (though if you use an expression such as , or
then the result of the expression evaluation is the file name to be used - eg if you set
then that's using the
which we use return the file name to be used), which can be either relative or absolute. If relative, the directory is created as a sub-folder from within the folder where the file was consumed.By default, Camel will move consumed files to the .camel sub-folder relative to the directory where the file was consumed.If you want to delete the file after processing, the route should be:
We have introduced a pre move operation to move files before they are processed. This allows you to mark which files have been scanned as they are moved to this sub folder before being processed.
You can combine the pre move and the regular move:
So in this situation, the file is in the inprogress folder when being processed and after it's processed, it's moved to the .done folder.Fine grained control over Move and PreMove optionThe move and preMove options are -based, so we have the full power of the
to do advanced configuration of the directory and name pattern. Camel will, in fact, internally convert the directory name you enter into a
expression. So when we enter move=.done Camel will convert this into: ${file:parent}/.done/${file:onlyname}. This is only done if Camel detects that you have not provided a ${ } in the option value yourself. So when you enter a ${ } Camel will not convert it and thus you have the full power.So if we want to move the file into a backup folder with today's date as the pattern, we can do:
About moveFailedThe moveFailed option allows you to move files that could not be processed succesfully to another location such as a error folder of your choice. For example to move the files in an error folder with a timestamp you can use moveFailed=/error/${file:name.noext}-${date:now:yyyyMMddHHmmssSSS}.${file:ext}.See more examples at The following headers are supported by this component:File producer onlyHeaderDescriptionCamelFileNameSpecifies the name of the file to write (relative to the endpoint directory). This name can be a String; a String wi or an
object. If it's null then Camel will auto-generate a filename based on the message unique ID.CamelFileNameProducedThe actual absolute filepath (path + name) for the output file that was written. This header is set by Camel and its purpose is providing end-users with the name of the file that was written.CamelOverruleFileNameCamel 2.11: Is used for overruling CamelFileName header and use the value instead (but only once, as the producer will remove this header after writing the file). The value can be only be a String. Notice that if the option fileName has been configured, then this is still being evaluated.File consumer onlyHeaderDescriptionCamelFileNameName of the consumed file as a relative file path with offset from the starting directory configured on the endpoint.CamelFileNameOnlyOnly the file name (the name with no leading paths).CamelFileAbsoluteA 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.CamelFileAbsolutePathThe absolute path to the file. For relative files this path holds the relative path instead.CamelFilePathThe file path. For relative files this is the starting directory + the relative filename. For absolute files this is the absolute path.CamelFileRelativePathThe relative path.CamelFileParentThe parent path.CamelFileLengthA long value containing the file size.CamelFileLastModifiedA Long value containing the last modified timestamp of the file. In Camel 2.10.3 and older the type is Date.Batch ConsumerThis component implements the .Exchange Properties, file consumer onlyAs the file consumer implements the BatchConsumer it supports batching the files it polls. By batching we mean that Camel will add the following additional properties to the , so you know the number of files polled, the current index, and whether the batch is already completed.PropertyDescriptionCamelBatchSizeThe total number of files that was polled in this batch.CamelBatchIndexThe current index of the batch. Starts from 0.CamelBatchCompleteA boolean value indicating the last
in the batch. Is only true for the last entry.This allows you for instance to know how many files exist in this batch and for instance let the
aggregate this number of files.Using charsetAvailable as of Camel 2.9.3 The charset option allows for configuring an encoding of the files on both the consumer and producer endpoints. For example if you read utf-8 files, and want to convert the files to iso-8859-1, you can do:
You can also use the convertBodyTo in the route. In the example below we have still input files in utf-8 format, but we want to convert the file content to a byte array in iso-8859-1 format. And then let a bean process the data. Before writing the content to the outbox folder using the current charset.
If you omit the charset on the consumer endpoint, then Camel does not know the charset of the file, and would by default use "UTF-8". However you can configure a JVM system property to override and use a different default encoding with the key org.apache.camel.default.charset.In the example below this could be a problem if the files is not in UTF-8 encoding, which would be the default encoding for read the files. In this example when writing the files, the content has already been converted to a byte array, and thus would write the content directly as is (without any further encodings).
You can also override and control the encoding dynamic when writing files, by setting a property on the exchange with the key Exchange.CHARSET_NAME. For example in the route below we set the property with a value from a message header.
We suggest to keep things simpler, so if you pickup files with the same encoding, and want to write the files in a specific encoding, then favor to use the charset option on the endpoints.Notice that if you have explicit configured a charset option on the endpoint, then that configuration is used, regardless of the Exchange.CHARSET_NAME property.If you have some issues then you can enable DEBUG logging on org.ponent.file, and Camel logs when it reads/write a file using a specific charset. For example the route below will log the following:
And the logs:
Common gotchas with folder and filenamesWhen Camel is producing files (writing files) there are a few gotchas affecting how to set a filename of your choice. By default, Camel will use the message ID as the filename, and since the message ID is normally a unique generated ID, you will end up with filenames such as: ID-MACHINENAME--0. If such a filename is not desired, then you must provide a filename in the CamelFileName message header. The constant, Exchange.FILE_NAME, can also be used.The sample code below produces files using the message ID as the filename:
To use report.txt as the filename you have to do:
... the same as above, but with CamelFileName:
And a syntax where we set the filename on the endpoint with the fileName URI option.
Filename ExpressionFilename can be set either using the expression option or as a string-based
expression in the CamelFileName header. See the
for syntax and samples.Consuming files from folders where others drop files directlyBeware if you consume files from a folder where other applications write files to directly. Take a look at the different readLock options to see what suits your use cases. The best approach is however to write to another folder and after the write move the file in the drop folder. However if you write files directly to the drop folder then the option changed could better detect whether a file is currently being written/copied as it uses a file changed algorithm to see whether the file size / modification changes over a period of time. The other readLock options rely on Java File API that sadly is not always very good at detecting this. You may also want to look at the doneFileName option, which uses a marker file (done file) to signal when a file is done and ready to be consumed.Using done filesAvailable as of Camel 2.6See also section writing done files below.If you want only to consume files when a done file exists, then you can use the doneFileName option on the endpoint.
Will only consume files from the bar folder, if a done file exists in the same directory as the target files. Camel will automatically delete the done file when it's done consuming the files. From Camel 2.9.3 onwards Camel will not automatically delete the done file if noop=true is configured.However it is more common to have one done file per target file. This means there is a 1:1 correlation. To do this you must use dynamic placeholders in the doneFileName option. Currently Camel supports the following two dynamic tokens: file:name and file:name.noext which must be enclosed in ${ }. The consumer only supports the static part of the done file name as either prefix or suffix (not both).
In this example only files will be polled if there exists a done file with the name file name.done. For examplehello.txt - is the file to be consumedhello.txt.done - is the associated done fileYou can also use a prefix for the done file, such as:
hello.txt - is the file to be consumedready-hello.txt - is the associated done fileWriting done filesAvailable as of Camel 2.6After you have written a file you may want to write an additional done file as a kind of marker, to indicate to others that the file is finished and has been written. To do that you can use the doneFileName option on the file producer endpoint.
Will simply create a file named done in the same directory as the target file.However it is more common to have one done file per target file. This means there is a 1:1 correlation. To do this you must use dynamic placeholders in the doneFileName option. Currently Camel supports the following two dynamic tokens: file:name and file:name.noext which must be enclosed in ${ }.
Will for example create a file named done-foo.txt if the target file was foo.txt in the same directory as the target file.
Will for example create a file named foo.txt.done if the target file was foo.txt in the same directory as the target file.
Will for example create a file named foo.done if the target file was foo.txt in the same directory as the target file.SamplesRead from a directory and write to another directory
Read from a directory and write to another directory using a overrule dynamic name
Listen on a directory and create a message for each file dropped there. Copy the contents to the outputdir and delete the file in the inputdir.Reading recursively from a directory and writing to another
Listen on a directory and create a message for each file dropped there. Copy the contents to the outputdir and delete the file in the inputdir. Will scan recursively into sub-directories. Will lay out the files in the same directory structure in the outputdir as the inputdir, including any sub-directories.
Will result in the following output layout:
Using flattenIf you want to store the files in the outputdir directory in the same directory, disregarding the source directory layout (e.g. to flatten out the path), you just add the flatten=true option on the file producer side:
Will result in the following output layout:
Reading from a directory and the default move operationCamel will by default move any processed file into a .camel subdirectory in the directory the file was consumed from.
Affects the layout as follows: before
Read from a directory and process the message in java
The body will be a File object that points to the file that was just dropped into the inputdir directory.Writing to filesCamel is of course also able to write files, i.e. produce files. In the sample below we receive some reports on the SEDA queue that we process before they are being written to a directory.
Write to subdirectory using Exchange.FILE_NAMEUsing a single route, it is possible to write a file to any number of subdirectories. If you have a route setup as such:
You can have myBean set the header Exchange.FILE_NAME to values such as:
This allows you to have a single route to write files to multiple destinations.Writing file through the temporary directory relative to the final destinationSometime you need to temporarily write the files to some directory relative to the destination directory. Such situation usually happens when some external process with limited filtering capabilities is reading from the directory you are writing to. In the example below files will be written to the  /var/myapp/filesInProgress directory and after data transfer is done, they will be atomically moved to the /var/myapp/finalDirectory directory.
Using expression for filenamesIn this sample we want to move consumed files to a backup folder using today's date as a sub-folder name:
for more samples.Avoiding reading the same file more than once (idempotent consumer)Camel supports
directly within the component so it will skip already processed files. This feature can be enabled by setting the idempotent=true option.
Camel uses the absolute file name as the idempotent key, to detect duplicate files. From Camel 2.11 onwards you can customize this key by using an expression in the idempotentKey option. For example to use both the name and the file size as the key
By default Camel uses a in memory based store for keeping track of consumed files, it uses a least recently used cache holding up to 1000 entries. You can plugin your own implementation of this store by using the idempotentRepository option using the # sign in the value to indicate it's a referring to a bean in the
with the specified id.
Camel will log at DEBUG level if it skips a file because it has been consumed before:
Using a file based idempotent repositoryIn this section we will use the file based idempotent repository org.apache.camel.processor.idempotent.FileIdempotentRepository instead of the in-memory based that is used as default. This repository uses a 1st level cache to avoid reading the file repository. It will only use the file repository to store the content of the 1st level cache. Thereby the repository can survive server restarts. It will load the content of the file into the 1st level cache upon startup. The file structure is very simple as it stores the key in separate lines in the file. By default, the file store has a size limit of 1mb. When the file grows larger Camel will truncate the file store, rebuilding the content by flushing the 1st level cache into a fresh empty file.We configure our repository using Spring XML creating our file idempotent repository and define our file consumer to use our repository with the idempotentRepository using # sign to indicate
Using a JPA based idempotent repositoryIn this section we will use the JPA based idempotent repository instead of the in-memory based that is used as default.First we need a persistence-unit in META-INF/persistence.xml where we need to use the class org.apache.camel.processor.idempotent.jpa.MessageProcessed as model.
Then we need to setup a Spring jpaTemplate in the spring XML file:Error formatting macro: snippet: java.lang.IndexOutOfBoundsException: Index: 20, Size: 20 And finally we can create our JPA idempotent repository in the spring XML file as well:
And yes then we just need to refer to the jpaStore bean in the file consumer endpoint using the idempotentRepository using the # syntax option:
Filter using org.ponent.file.GenericFileFilterCamel supports pluggable filtering strategies. You can then configure the endpoint with such a filter to skip certain files being processed.In the sample we have built our own filter that skips files starting with skip in the filename:
And then we can configure our route using the filter attribute to reference our filter (using # notation) that we have defined in the spring XML file:
Filtering using ANT path matcherThe ANT path matcher is shipped out-of-the-box in the camel-spring jar. So you need to depend on camel-spring if you are using Maven. The reasons is that we leverage Spring's
to do the actual matching.The file paths is matched with the following rules:? matches one character* matches zero or more characters** matches zero or more directories in a pathThe sample below demonstrates how to use it:
Sorting using ComparatorCamel supports pluggable sorting strategies. This strategy it to use the build in parator in Java. You can then configure the endpoint with such a comparator and have Camel sort the files before being processed.In the sample we have built our own comparator that just sorts by file name:
And then we can configure our route using the sorter option to reference to our sorter (mySorter) we have defined in the spring XML file:
Sorting using sortByCamel supports pluggable sorting strategies. This strategy it to use the
to configure the sorting. The sortBy option is configured as follows:
Where each group is separated with semi colon. In the simple situations you just use one group, so a simple example could be:
This will sort by file name, you can reverse the order by prefixing reverse: to the group, so the sorting is now Z..A:
As we have the full power of
we can use some of the other parameters, so if we want to sort by file size we do:
You can configure to ignore the case, using ignoreCase: for string comparison, so if you want to use file name sorting but to ignore the case then we do:
You can combine ignore case and reverse, however reverse must be specified first:
In the sample below we want to sort by last modified file, so we do:
And then we want to group by name as a 2nd option so files with same modifcation is sorted by name:
Now there is an issue here, can you spot it? Well the modified timestamp of the file is too fine as it will be in milliseconds, but what if we want to sort by date only and then subgroup by name? Well as we have the true power of
we can use its date command that supports patterns. So this can be solved as:
Yeah, that is pretty powerful, oh by the way you can also use reverse per group, so we could reverse the file names:
Using GenericFileProcessStrategyThe option processStrategy can be used to use a custom GenericFileProcessStrategy that allows you to implement your own begin, commit and rollback logic. For instance lets assume a system writes a file in a folder you should consume. But you should not start consuming the file before another ready file has been written as well.So by implementing our own GenericFileProcessStrategy we can implement this as:In the begin() method we can test whether the special ready file exists. The begin method returns a boolean to indicate if we can consume the file or not.In the abort() method (Camel 2.10) special logic can be executed in case the begin operation returned false, for example to cleanup resources etc.in the commit() method we can move the actual file and also delete the ready file.Using filterThe filter option allows you to implement a custom filter in Java code by implementing the org.ponent.file.GenericFileFilter interface. This interface has an accept method that returns a boolean. Return true to include the file, and false to skip the file. From Camel 2.10 onwards, there is a isDirectory method on GenericFile whether the file is a directory. This allows you to filter unwanted directories, to avoid traversing down unwanted directories.For example to skip any directories which starts with "skip" in the name, can be implemented as follows:
The file and ftp consumers, will by default try to pickup files. Only if that is successful then a Camel
can be created and passed in the Camel routing engine. When the
is processed by the routing engine, then the Camel
takes over (eg the onException / errorHandler in the routes). However outside the scope of the routing engine, any exceptions handling is component specific. Camel offers a org.apache.camel.spi.ExceptionHandler that allows components to use that as a pluggable hook for end users to use their own implementation. Camel offers a default LoggingExceptionHandler that will log the exception at ERROR/WARN level. For the file and ftp components this would be the case. However if you want to bridge the ExceptionHandler so it uses the Camel , then you need to implement a custom ExceptionHandler that will handle the exception by creating a Camel
and send it t then the error handling of the routing engine can get triggered.Here is such an example based upon an unit test.First we have a custom ExceptionHandler where you can see we deal with the exception by sending it to a Camel
named "direct:file-error":
Then we have a Camel route that uses the Camel routing error handler, which is the onException where we handle any IOException being thrown. We then send the message to the same "direct:file-error" endpoint, where we handle it by transforming it to a message, and then being sent to a
endpoint. This is just for testing purpose. You can handle the exception in any custom way you want, such as using a
or sending an email etc.Notice how we configure our custom MyExceptionHandler by using the consumer.exceptionHandler option to refer to #myExceptionHandler which is a id of the bean registered in the . If using Spring XML or OSGi Blueprint, then that would be a &bean id="myExceptionHandler" class="com.foo.MyExceptionHandler"/&:
The source code for this example can be seen Using consumer.bridgeErrorHandlerAvailable as of Camel 2.10If you want to use the Camel
to deal with any exception occurring in the file consumer, then you can enable the consumer.bridgeErrorHandler option as shown below:
So all you have to do is to enable this option, and the error handler in the route will take it from there.Debug loggingThis component has log level TRACE that can be helpful if you have problems.See Also
The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.