License

Packaging

Usage:

# Analyse a given Alfresco extension   java -jar alfresco-extension-inspector.jar<extension-filename> [--target-version=6.1.0[-7.0.0]| --target-inventory=<report_file_path>.json] [--verbose=[true| false]]# Generate an inventory report for a given war file   java -jar alfresco-extension-inspector.jar --inventory<alfresco-war-filename> [--o=<report_file_path>.json]# Help command   java -jar alfresco-extension-inspector.jar --help# List all versions with bundled inventories   java -jar alfresco-extension-inspector.jar --list-known-alfresco-versions

   --target-version                     An Alfresco version or a range of Alfresco versions.   --target-inventory                   A file path of an existing WAR inventory.   --verbose                            Verbose output.   --inventory                          Creates an inventory reportin json formatfor the specified war or extension file.   [--o=<report_file_path>.json]        A file pathfor the new inventory report.   --help                               Shows this screen.   --list-known-alfresco-versions       Lists all Alfresco versions with inventory reports includedin the tool.

Inventory

Inventory command:

java -jar alfresco-extension-inspector-<version>.jar --inventory<alfresco_war_path> [--o=<report_file_path>]

Output

{"schemaVersion" :"1.0","alfrescoVersion" :"6.2.1","resources" :     {"ALFRESCO_PUBLIC_API" :       [         {"type" :"ALFRESCO_PUBLIC_API","id" :"package.ClassName1","deprecated" :false,"implicit" :false        },        {"type" :"ALFRESCO_PUBLIC_API","id" :"package.ClassName2","deprecated" :true,"implicit" :true        },...      ],"CLASSPATH_ELEMENT" :       [        {"type" :"CLASSPATH_ELEMENT","id" :"org/alfresco/package1/AClass.class","definingObject" :"WEB-INF/lib/alfresco-library.jar"        },        {"type" :"CLASSPATH_ELEMENT","id" :"com/3rdparty/packageA/AClass.class","definingObject" :"WEB-INF/lib/3rdparty-library.jar"        },...      ],"BEAN" :       [        {"type" :"BEAN","id" :"beanName","definingObject" :"alfresco/aContext.xml@WEB-INF/lib/alfresco-library.jar"        },...      ],"FILE" :       [        {"type" :"FILE","id" :"WEB-INF/classes/aFile.ext","definingObject" :"WEB-INF/classes/aFile.ext"        },        {"type" :"FILE","id" :"WEB-INF/lib/aLibrary.jar","definingObject" :"WEB-INF/lib/aLibrary.jar"        },...      ]}

Adding a new supported inventory to the Inspector

Analyser

Analyser command:

java -jar alfresco-extension-inspector-<version>.jar<extension-filename> [--target-version=6.1.0[-7.0.0]| --target-inventory=/path/to/war_inventory.json] [--verbose=[true| false]]

   --target-version                     An Alfresco version or a range of Alfresco versions.   --target-inventory                   A file path of an existing WAR inventory.   --verbose                            Verbose output.

Output

Bean naming conflicts---------------------The following Spring beans defined in the extension module are in conflict with beans defined in the ACS repository:    extension_beanSpring beans are the basic building blocks of the ACS repository. Replacing these will alter the behaviour of the system and can lead to unexpected behaviour.Since all these beans are subject to change between Alfresco versions and even in service packs, these modifications are typically bound to a specific Alfresco version.You should avoid redefining default beans of the ACS repository in your extensions to reduce the cost of upgrades.It is possible that these conflicts only exist in specific ACS versions. Run this tool with the -verbose option to get a complete list of versions where each of these files has conflicts.Beans instantiating internal classes------------------------------------The following Spring beans defined in the extension module instantiate internal classes:    extension_bean (class=org.alfresco.repo.... )These classes are considered an internal implementation detail of the ACS repository and do not constitute a supported extension point. They might change or completely disappear between ACS versions and even in service packs.Classpath conflicts-------------------The following files and libraries in the extension module cause conflicts on the Java classpath:    /lib/alfresco-test.jarAmbiguous resources on the Java classpath render the behaviour of the JVM undefined (see Java specification).Although it might be possible that the repository can still start-up, you can expect erroneous behavior in certain situations. Problems of this kind are typically very hard to detect and trace back to their root cause.It is possible that these conflicts only exist in specific ACS versions. Run this tool with the -verbose option to get a complete list of versions where each of these files has conflicts.Custom code using internal classes----------------------------------The following classes defined in the extension module are using internal repository classes:    org.alfresco.repo...Internal repository classes:    org.alfresco.repo...These classes are considered an internal implementation detail of the ACS repository and might change or completely disappear between ACS versions and even between service packs.For a complete usage matrix, use the -verbose option of this tool.Custom code using 3rd party libraries managed by the ACS repository-------------------------------------------------------------------The code provided by the extension module is using these 3rd party libraries brought by the ACS repository:    /WEB-INF/lib/test-1.0.0.jarThese 3rd party libraries are managed by the ACS repository and are subject to constant change, even in service packs and hotfixes.Each of these libraries has its own backward compatibility strategy, which will make it really hard for this extension to keep up with these changes.Incompatible jakarta migration dependencies-------------------------------------------The following classes defined in the extension module are using incompatible jakarta migration dependencies:org.alfresco.utility.data.DataEmailorg.alfresco.utility.data.DataEmail$1Jakarta migration dependencies:jakarta.mail.Authenticatorjakarta.mail.Flagsjakarta.mail.Flags$Flagjakarta.mail.Folderjakarta.mail.Messagejakarta.mail.MessagingExceptionjakarta.mail.Sessionjakarta.mail.Storejakarta.mail.internet.MimeMessagejakarta.mail.search.AndTermjakarta.mail.search.FlagTermjakarta.mail.search.SearchTermClasses using non-jakarta migrated dependencies are incompatible with a jakarta migrated ACS version, and vice versa.For a complete usage matrix, use the -verbose option of this tool.REPORT SUMMARYAcross the provided target versions, the following number of conflicts have been found:+--------------------------+-----+|Type                      |Total|+--------------------------+-----+|BEAN_OVERWRITE            |1    |+--------------------------+-----+|BEAN_RESTRICTED_CLASS     |1    |+--------------------------+-----+|CLASSPATH_CONFLICT        |1    |+--------------------------+-----+|ALFRESCO_INTERNAL_USAGE   |2    |+--------------------------+-----+|WAR_LIBRARY_USAGE         |1    |+--------------------------+-----+|JAKARTA_MIGRATION_CONFLICT|2    |+--------------------------+-----+(use option --verbose for version details)

Implementation details

Build and release process