A proposed README file in auto-loaded directories

In my previous post, I suggested not to put unused jar/zip files (*.jar, *.zip) in those directories that are automatically scanned and loaded. But how do we tell such a directory from regular ones? I think we need a quick way to know it without reading official documentations, if there is any.

I propose these magic directories contain a README file that looks like this:

All jar files (*.jar) in this directory are automatically loaded by the application server common classloader. The application server scans this directory in every 5 seconds by default. This scanning interval may be configured in config/server.xml. Note that this scan is non-recursive and any subdirectories are ignored.

WARNING: please do not put unused jar files in this directory to avoid class file conflicts.

For more information, please see the official application server documentation:

No comments: