Create a new GraphSearch Plugin

This section describes how to create a new GraphSearch Plugin using Maven Archetype Template.

An Archetype is a project template with predefined project structure, resources and configurations which can be used to generate new projects. To simplify the development process, PoolParty offers such a template to quickly populate a minimalistic Java project with a basic plugin implementation. Then developers will only need to focus on implementing the core business logic.

Note

Before you start, make sure that the development environment is prepared as we described it in Development Environment Setup.

Open a terminal window and run the following command which will generate a new project from the archetype:

mvn archetype:generate \
  -DarchetypeGroupId=biz.poolparty.graphsearch \
  -DarchetypeArtifactId=poolparty-recommender-plugin-archetype \
  -DarchetypeVersion=8.0.0 \
  -DgroupId=biz.poolparty \
  -DartifactId=custom-plugin \ 
  -Dversion=1.0-SNAPSHOT
  -P poolparty-profile

Maven will download the dependencies and prompt project configuration for review. After confirmation a project with name "custom-plugin" will be created under the current working directory.

The project can be immediately built with the following:

mvn clean package

This project then you can deploy to GraphSearch for testing. Finally, you can implement the core logic of the plugin.