Infinispan has a highly extensible architecture, making it easy to add extensions wherever needed. This guide walks you through how to create extensions.
This guide is only for those who are looking to extend Infinispan beyond it's core use cases.
Infinispan makes use of a command/visitor pattern to implement the various top-level methods you see on the public-facing API. This is explained in further detail in the Architectural Overview on the Infinispan public wiki. However, these commands - and their corresponding visitors - are hard-coded as a part of Infinispan's core module, making it impossible for module authors to extend and enhance Infinispan to create new arbitrary commands and visitors.
However, since Infinispan 5.0, this capability has now been added. As a module author (such as infinispan-tree, infinispan-query, etc.) you can now define your own commands. From Infinispan 5.1 onwards, you do so by:
- Create a META-INF/services/org.infinispan.commands.module.ModuleCommandExtensions file and ensure this is packaged in your jar.
- Implementing ModuleCommandFactory and ModuleCommandInitializer from infinispan-core.
- Implementing ModuleCommandExtensions from infinispan-core.
- Specifing the fully-qualified class name of the ModuleCommandExtensions implementation in META-INF/services/org.infinispan.commands.module.ModuleCommandExtensions.
- Implement your custom commands and visitors for these commands
Here is an example of an META-INF/services/org.infinispan.commands.module.ModuleCommandExtensions file, configured accordingly:
For a full, working example of a sample module that makes use of custom commands and visitors, check out Infinispan Sample Module.
This is the list of Command identifiers that are used by Infinispan based modules or frameworks. Infinispan users should avoid using ids within these ranges. (RANGES to be finalised yet!)
Being this a single byte, ranges can't be too large.
|Infinispan Query:||100 - 119|
|Hibernate Search:||120 - 139|