Adding New Components to Your Distribution (Aspire 2)
For Information on Aspire 3.1 Click Here
This page gives the step-by-step instructions for adding a new component or pipeline stage to your distributions. Note that these instructions are specifically for distributions which were built using the Aspire Distribution Archetype.
Step 1: Deploy or Install Your Component
Aspire Maven distribution projects require that all components be stored in either a local or remote repository. When the distribution is re-built (using "mvn clean package assembly:assembly") it will download all of the component jars from a repository into the distribution target directory.
Therefore, any new component must be copied to a repository first. This can be done with:
- mvn install - Copies the component jar to the local repository. The local repository is only available to processes running on the same machine for the same user.
- mvn deploy - Copies the component jar to the remote repository (see Connecting to the Search Technologies Maven Repository) so that the component will be available to anyone creating distributions.
Step 2: Add the Component Configuration Your System Configuration
Now, add your component to the list of components. For example, it might look like this:
<component name="myNewComponent" subType="default" factoryName="aspire-MY-NEW-COMPONENT" />
This component configuration will need to be added either to the pipeline manager's list of components (if it is a new pipeline stage) or to the component manager's list of components, as appropriate.
Step 3: Add the Stage to the Pipeline
If your new component is a pipeline stage, you will need to add it to the pipeline.
For example, it might look like this:
<stages> . . . <stage component="myNewComponent" /> </stages>
Step 4: Reload Your System Configuration
Either restart Aspire, or go to the Aspire Admin home page (http://localhost:50505) and reload your new Aspire system configuration file.
Your new component will be automatically loaded into Aspire from the Maven Repository.