Page History

Introduction to Programming Components

An orientation to programming with Aspire for those approaching it for the first time and includes fundamental Java classes, Groovy scripting, setting up your environment, and “next steps” AspireObject Class Detailed information on the AspireObject class, including benefits, challenges, JSON and XML support, basic usage, naming conventions, and content and attribute supportJob Class Detailed information on the Job class, including uses, basic structure, creating jobs and sub-jobs, and terminating and routing jobsComponentImpl Class Detailed information on the ComponentImpl class, including usage, fetching Aspire, accessing directories and files, naming conventions, and parsing configurationAspire Framework Utilities An overview of the various programming utilities provided in the Aspire framework.

Creating a New Pipeline Stage

Contains information on creating a new pipeline stage using the Maven Archetype, including how to edit, build, change the source code, and use the new stage in an Aspire installation  Adding New Components to Your Distribution Provides step-by-step instructions for adding a new component or pipeline stage to your Aspire distributions

Javadocs

• Latest Javadoc Version
• All Javadoc Versions

Component Development Topics

The following is a library of additional component programming topics.

Main Topics

• Aspire Development FAQ - Answers to many common problems!
• Connector Development Topics
  • Scanner test harness

Developer Environment Setup

• Developer Environment Setup Instructions - Maven, Eclipse, M2Eclipse, Jira, JDK, etc.
• Connecting to the Search Technologies Maven Repository
• Connecting your Maven POM file to the Search Technologies Repository
• Eclipse plus Maven
• Editing New Stages Inside Eclipse

Additional Topics

• Imports and Export Packages in Maven
• Accessing other components - OSGi friendly method for accessing other components from your component
• Programming components which use the Branch Handler
• Programming components to use the Metadata Mapper
• Techniques for Unit Testing
• Creating Admin Pages for Components
• Adding Logging to your Component
• Reporting Status - How to override the getStatus() properly to report status from your component to the admin user interface
• How to Include Third-Party Jars in Your Component
• Calling out to a 3rd Party jar from Groovy
• Creating Non-Stage Components - Such as feeders and shared data sources
  • Developing connectors
  • Scanner test harness
• Handling Components with Long Initialization Times - Using background threads for initialization
• Modifying pipeline stages to support job batching
• Using Dynamic XML Forms (DXF)
• Aspire Startup Procedure
• Exception Error Resolution List
• Password Decryption
• Aspire Object XPath