Core Development Guide

Windup Core Development Guide

Introduction

This guide is for developers who plan to contribute to the Windup source code base or provide Java-based rule add-ons.

If you are new to Windup, it is recommended that you start with the Windup User Guide. It provides detailed information about system requirements and detailed instructions on how to install and execute Windup. It also contains tips to optimize performance and provides links to other sources of information about Windup.

If you would like to contribute custom XML-based rules, see the Windup Rules Development Guide.

Get Started

After you configure Maven, you are ready to create, install, and test your first Windup Java-based rule add-on.

• Install and Configure Maven

• Create Your First Java-based Rule Add-on

Prepare Your Development Environment

If you only plan to create custom Windup Java-based rule add-ons, you can skip this chapter. However, if plan to contribute back to the core code base, the following sections describe how to access and build the Windup source code.

• Get the Windup Source Code

• Build Windup from Source

Understand the Windup Architecture and Structure

• Windup Architectural Components

• Windup Project Structure

Rules and Rulesets

• Windup Processing Overview

• Rules Execution Lifecyle

• Rule Phases

• Available Rules Utilities

• Rule Story Points

• Difference Between XML-based and Java-based Rules

Create and Test Java Rule Add-ons

This guide focuses on how to create Java-based rule add-ons. For instructions on how to create XML-based rules, see the Windup Rules Development Guide.

• Java-based Rule Structure

• Basic Rule Execution Flow Patterns

• Create a Basic Java-based Rule Add-on

Debugging, Profiling, and Logging

• Debugging, Profiling, and Logging

Developer Contributing Information

• Developer Guidelines and Conventions

• Submit Code Updates to the Windup Project

Appendix

• About the WINDUP_HOME Variable

• Windup Project Information - Github repository, IRC, Mailing lists, …​