powered by ASAP

Java command annotations are used for developing Java commands in PAK.
This chapter describes the functionality of the @JavaCommand annotation.
It also gives an example of how you can use this annotation in your implementation.

1. Basics

@JavaCommand provides two ways of command-developing. One is class-based and
the other enables the user to turn methods from already existing code into commands.

2. Properties

There is a String property called displayname defined for the @JavaCommand annotation.
Usually, the command name is derived from the class name.
However, if a value is assigned to the displayname property the PAK BPMN Editor and Workflow Executor display this value as command name instead of the class name.
The usage of that property is shown in Listing 2.

The default value is an empty String which means that the class name is displayed in the PAK BPMN Editor and Workflow Executor.
The class name is split with spaces between capital letters, while sequential uppercase letters are not split.
Therefore, class name GetElementByJSON, for example, results in the command name „Get Element By JSON“.

3. Usage

@JavaCommand has to either mark a class or a method as a command.

3.1. @JavaCommand on Class-Level

In the following example in Listing 1, line 4 the @JavaCommand annotation is used.
This approach is based on a JavaCommand-Code-Template, useful for developing new command projects.

As the default for the displayname property is an empty String and nothing else is defined for that property, the command name in Listing 1 will be derived by the class name, i.e. „Get Element“.

Listing 1. Example command on class-level
/**
 * @workflowDocu This command gets an element by its id.
 */
@JavaCommand (1)
@CommandGroup("Element")
public class GetElement {

    [..]

}
1 Use of the @JavaCommand annotation with default value of displayname

In contrast to the example before, Listing 2 sets the displayname property to „Get Existing Element“.
This customized command name will then be displayed in the BPMN Editor and Workflow Executor.

Listing 2. Example command on class-level, using a custom value for displayname
/**
 * @workflowDocu This command gets an element by its id.
 */
@JavaCommand(displayname = "Get Existing Element") (1)
@CommandGroup("Element")
public class GetElement {

    [..]

}
1 Use of the @JavaCommand annotation with displayname set to „Get Existing Element“

3.2. @JavaCommand on Method-Level

When @JavaCommand is positioned above a method, the annotated method will be converted into a command if the class
containing the method is annotated with @JavaCommandService.

This is a very basic explanation on how the command-definition on method-level works. For a more detailed explanation on how to process methods,
consider checking out the HowTo Create Commands from Legacy Code.
Listing 3. Example command on method-level
@JavaCommandService (1)
public class AnyExistingClass {

    [...]

    (2)
    /**
     * This command simply returns the word 'hello'
     *
     * @return Docu for my write variable
     */
    @JavaCommand (3)
    @Persistent (4)
    public String getHello() {

        return "hello";

    }
}
1 The class containing the command needs to be marked with @JavaCommandService.
2 The JavaDoc block above the method-body holds the workflow documentation for the command, as well as for the variables within the command.
3 @JavaCommand marks the method as a command.
4 The @Persistent above the method body marks the returned value as a variable of the command with the scope WRITE.

Sonatype Nexus

PAK features connectors and commands for Sonatype Nexus. This means the software can directly interact with Nexus repositories for storing and managing artifacts. Through these connectors, PAK can automate tasks like uploading binaries or retrieving dependencies, ensuring efficient artifact management within Nexus.

Jenkins

PAK has connectors and commands for Jenkins. This allows the software to directly communicate with Jenkins servers, enabling the automation of CI/CD (Continuous Integration/Continuous Deployment) tasks. Through these connectors, PAK can trigger builds, fetch build statuses, or manage job configurations, streamlining the CI/CD processes within Jenkins.

Git Hub

PAK possesses connectors and commands for GitHub. This means the software can interface directly with GitHub repositories, facilitating actions like code pushes, pull requests, or issue tracking. Through these connectors, PAK can automate various GitHub operations, enhancing code collaboration and repository management.

Atlassian Confluence

PAK is equipped with connectors and commands for Atlassian Confluence. This enables the software to directly interact with Confluence spaces and pages. Through these connectors, PAK can automate actions such as creating, updating, or retrieving documentation, ensuring efficient content management and collaboration within Confluence.

Codebeamer

PAK features connectors and commands for Codebeamer. This allows the software to seamlessly integrate with Codebeamer’s ALM (Application Lifecycle Management) platform. Through these connectors, PAK can automate tasks like issue tracking, test management, or requirements tracing, enhancing the coordination and management of software development processes.

JFrog Artifactory

PAK has connectors and commands for JFrog Artifactory. This means the software can directly interface with Artifactory repositories, enabling actions like artifact storage, retrieval, and management. Through these connectors, PAK can automate tasks such as deploying artifacts or managing repository configurations, streamlining the integration and management of binary artifacts within Artifactory.

Amazon Web Services (AWS)

PAK has connectors and commands for Amazon Web Services (AWS). This means the software possesses specialized interfaces to directly interact with AWS services and execute actions on the AWS platform. Through these connectors, PAK can automate AWS-specific commands, such as launching EC2 instances, managing S3 buckets, or configuring Lambda functions. This allows for efficient integration, management, and automation of AWS resources and services directly from PAK.

Atlassian Jira

PAK features integration tools and capabilities for Atlassian Jira. These tools allow for a direct connection to Jira and the execution of specific actions. Using these integration tools, PAK can automate Jira actions such as adding comments or changing ticket priorities, ensuring seamless handling and coordination of Jira processes.

Git

PAK has connectors and commands for Git. This means it has interfaces to directly communicate with Git and execute actions. Through these connectors, the software can automate Git commands such as retrieving changes or creating branches, enabling efficient integration and management of Git tasks.

Generic Human Tasks

PAK offers you a standard set of commands which require creative input from the user. Enables you to start with automating your workflows, that still need abit of human input.

Generic Commands

PAK offers a standard set of commands giving you the first steps to automate your workflows.

Nexus Maven Command Pool

Nexus is an artifact repository manager for storing binaries, libraries, and artifacts, supporting formats like Maven. Maven, a software project management tool, is based on the Project Object Model (POM) and allows developers to consistently define projects and dependencies. Our Command Pool offers commands for interactions between Maven and Nexus, such as artifact uploads or dependency retrieval.

Artifactory Maven Command Pool

Artifactory allows developers to store, retrieve, and manage binary files and artifacts, providing a
central source for all binaries used in a development process. Apache Maven is a software project
management and comprehension tool that enables developers to consistently describe a project and
its dependencies. Our Command Pool offers a collection of commands used to facilitate interactions
between Maven and Artifactory, such as uploading artifacts or retrieving dependencies.

Open API Command Interpreter

The OpenApi Command Interpreter allows you the automatic parsing of commands from an OpenApi defintion. No additional code needs to be written anymore, just add the address to the definition and our framework does the rest!

Kotlin Command Interpreter

The Kotlin Command Interpreter allows you the parsing and execution of commands within a Kotlin environment to automate various tasks or processes.

Bpmn Interpreter

Workflows come in many shapes and forms. The BPMN (Business Process Model and Notation) Interpreter enables the parsing of worklows defined in the BPMN format into the PAK intern model.

Human Task Interpreter

The Human Task Interpreter allows you the parsing and running of commands within a HTML and Javascript environment. Use this to build commands which need the creative input of a workflow user!

Java Command Interpreter

The Java Command Interpreter allows you the parsing and execution of commands within a Java
environment to automate various tasks or processes.

Core

The heart of the PAK-Framework. Contains the means to run workflows with the PAK engine, but also the possibility to enrich the frameworks interfaces with your own implementations and solutions.

RocksDB Persistence

Data that is generated by a workflow run needs to be saved for short or longer terms. Our solution to the Persistence Interface of the PAK-Framework is to use the high-performance, key-value based RocksDB developed by Facebook.

PAK online

PAK Online is a web based application and provides an Open API based REST API. It enables you to upload workflows and run them periodically or on REST demand.

Command Line App

Run tasks and workflows on the console or as part of a CI/CD Pipeline with our Command Line Interface.

Workflow Editor

With our specially developed editor, a wide variety of workflows can be easily modeled in the wide known BPMN process format.

Workflow Executor

The Workflow Executor is the application to run your workflows. It features a multilingual UI and easy managment of your favorite workflows.

Support

We offer a community website where you can exchange ideas and support each other. For our Pro packages we also offer full support via email.