powered by ASAP

Suche

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

1. Basics

The @Pattern annotation restricts the allowed values of a variable to those that match the specified regex pattern.
This annotation is evaluated at runtime and raises an exception at the latest.

This annotation is only applicable for variables that are annotated with @Persistent and of type String.

2. Properties

There are four properties defined for the @Pattern annotation that will be explained in the following.
The only mandatory property is value, the remaining ones (example, emptyOrBlankAllowed, errorMessage) are optional.

  • value:
    The regex has to be assigned to this property. It defines which variable values are allowed to be set.

  • example:
    This property is used for the user documentation.
    You can define examples to show the user which values will be accepted by the regex.

  • emptyOrBlankAllowed:
    For Patterns, that are matched by an empty or blank string (as is the case when using .*), this flag lets you decide if empty or blank inputs should be accepted.
    Setting the property to false will result in the rejection of empty inputs as if they do not match the pattern.
    The default is true (the pattern is matched, even if the input string is empty).

  • errorMessage:
    This property is used to set an individual error message, which will be displayed if the specified pattern is not matched.

3. Usage

Listing 1 shows how to use the @Pattern annotation with different regex values and the example property usage.

Listing 1. Usage of the @Pattern annotation
/**
 * @workflowDocu This command shows how to use the @Persistent annotation.
 */
@JavaCommand
@CommandGroup("Element")
public class GetElement {

	/**
	 * @workflowDocu List of labels to be added, separated by ","
	 */
	@Pattern(value = "\\w*(,\\w+)*", (1)
                 example = "elem1,elem2",
                 emptyOrBlankAllowed = false,
                 errorMessage = "The given list elements need to be separated by commas!")
	@Persistent
	private String commaSep;

	/**
	 * @workflowDocu Only allow numbers
	 */
	@Persistent
	@Pattern("\\d+") (2)
	private String numbers;

	[...]
}
1 Allow comma-separated Strings for variable commaSep, the string cannot be empty and an individual error message is displayed, if the input does not match
2 Only numbers are allowed for the values of variable number

Figure 1 shows the result of the @Pattern usage of Listing 1.
As you can see, the regex as well as the example are provided in the documentation information popup.

GetElement Pattern UserInfo
Figure 1. Result in the Single Command Runner of the Workflow Executor

The frame of the variable remains red as long as no valid value is entered into the text variable, as can be seen in Figure 2.
After the entered value matches the regex the red border disappears like in Figure 3.

GetElement Pattern Wrong
Figure 2. Wrong value
GetElement Pattern Correct
Figure 3. Correct value

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.