README.adoc

TPAE MAXREST REST Client

Table of Contents

• Introduction
• Configure dependency
  • Gradle
  • Maven
• Build
• Run
• Test
• Usage
  • Basic Authentication
• Release
  • Gradle Release
  • Publish package to GitHub
  • Maven Local

Introduction

This project is our reactive rest client implementation for the Tivoli Process Automation Engine (TPAE) maxrest API. It’s a common engine for IBM Maximo Asset Management and IBM Control Desk.

Configure dependency

The project is published at the GitHub Maven Repository.

Gradle

maven("https://raw.githubusercontent.com/trikorasolns/quarkus-tpae-maxrest/BRANCH/releases")

Maven

Add a profile with the github Maven repository.

And then add the dependency.

<dependency>
  <groupId>com.trikorasolutions.quarkus.tpae.rest</groupId>
  <artifactId>quarkus-tpae-maxrest</artifactId>
  <version>0.0.3.Final</version>
</dependency>

Note	More information at the project package page.

Build

./gradlew clean  quarkusBuild

Note	The jandex plugin is used to help in the CDI process of this library.

Run

To run the application in development mode launch.

./gradlew quarkusDev

Test

The test target is the rest client target itself. It’s defined in the application.properties file.

./gradlew check

Usage

Basic Authentication

Rest methods include Basic authentication functionality by passing the Authorization in the TPAE REST call.

To use the basic authentication functionality filling in the tpae.user and tpae.password properties is required. Moreover, it is required that null is passed into the uid and pwd (_lid and _lpwd) parameters.

Release

Gradle Release

./gradlew release

Publish package to GitHub

./gradlew publish -PGitHubUsername=<github_user> -PGitHubPassword=<github_token>

Maven Local

TBD

./gradlew quarkusBuild jar publishToMavenLocal