Installing a plug-in into CAS

After receiving a plug-in (a JAR or set of JAR files) from a plug-in developer, a CAS application developer installs the plug-in into CAS.

The Content Acquisition System detects each plug-in and validates the extensions within it by checking the uniqueness of extension IDs and by checking for the presence of an annotation of either @CasDataSource or @CasManipulator for each extension.

To install a plug-in into CAS:

  1. Stop Endeca CAS Service.
  2. Navigate to <install path>\CAS\version\lib\cas-server-plugins and create a plugin-name subdirectory for each plug-in. For example: CAS\version\lib\cas-server-plugins\JDBCDataSourceExt
  3. Copy the plug-in JAR or JARs, and any dependent JAR files, to <install path>CAS\version\lib\cas-server-plugins\plugin-name.
  4. Repeat the steps above as necessary for multiple plug-ins.
  5. Start Endeca CAS Service.
You can confirm that an extension is installed by runing the listModules task of the CAS Server Command-line Utility and specifying a moduleType of either SOURCE or MANIPULATOR. The task returns the installed modules. For example, this task shows that a custom data source named Sample Data Source for testing is installed: 
C:\Endeca\CAS\3.0.0\bin>cas-cmd listModules -t SOURCE
Sample Data Source
 *Id: Sample Data Source
 *Type: SOURCE
 *Description: Sample Data Source for testing

File System
 *Id: File System
 *Type: SOURCE
 *Description: No description available for File System
 *Capabilities: 
   *Binary Content Accessible via FileSystem
   *Data Source Filter
   *Has Binary Content
   *Expand Archives