sempv2-interface

Description

Project sempv2-interface is Java library project for handling SEMP V2 operations and management of the PubSub+ cloud services, as well as managing some of the Solace Cloud tasks.

The project uses packages with generated code via https://editor.swagger.io/

The currently generated code is based on schema version 9.6 (2.16).

The code is grouped into four main packages:

• action - Mostly coming from generated OpenAPI schemas and handling SEMP v2 Actions operations.
• admin - Created manually to handle Solace Cloud administrative operations, which are specific for Solace PubSub+ Cloud. This package was manually created, as these tasks weren't part of provided OpenAPI schemas.
• config - Mostly coming from generated OpenAPI schemas and handling SEMP v2 Config operations.
• monitor - Mostly coming from generated OpenAPI schemas and handling SEMP v2 Monitor operations.

The packages are based on the structure exposed via the SEMP v2 API. More information is available on the SEMP web page: https://docs.solace.com/SEMP/Using-SEMP.htm

Code generation

Go to https://editor.swagger.io/ and import the YAML files for Action, Config and Monitor one by one and generate Java client.

To build with a tool the code can be obtained from: https://github.com/swagger-api/swagger-codegen and then build the code: mvn clean package

Create a config file named action.json:

{
	"modelPackage" : "com.solace.psg.sempv2.action.model",
	"apiPackage" : "com.solace.psg.sempv2.action.api"
}

To build action packages with the code generator cli, copy the JSON schemas on the path /modules/swagger-codegen-cli/target and run: java -jar swagger-codegen-cli.jar generate -i semp-v2-swagger-action.json -l java -o sempv2.action -c action.json

Merging with existing code when building a newer version

1. From the package com.solace.psg.sempv2.action move all classes from the current folder to a package named: com.solace.psg.sempv2.action.model.
2. Import all generated classes from .action.api and .action.model packages. In the .api package classes, the unresolved imports need to be changed manually to com.solace.psg.sempv2.apiclient.
3. Import the test classes in the corresponding test package.

Repeat the same steps for config and monitor schemas.

Building the library:

To build solution use the folowing command:

mvn clean compile package 

To skip tests add the follwoing parameter to the build command:

mvn clean compile package -DskipTests