Home
MATRIXX Business API SDK
Upgrading the Business API SDK
When you upgrade the MATRIXX software, you must upgrade the Business API SDK as it is possible that files have changed or have been deprecated. Use the manage_integration_project.py script to remove the current release from your project directory structure and upgrade to the latest release. You should do this even if your files are not checked into Subversion.
Upgrade JAR File Extensions
Follow these steps to remove the current release from your project directory structure and upgrade to the latest release of the Business API SDK.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
MATRIXX Business API SDK
- About MATRIXX Business API SDK
  MATRIXX Business API SDK provides the APIs, libraries, and other files needed to create a customized version of the RS Gateway.
- Business API SDK Overview
  The Business API SDK is a flexible framework that includes a set of tools to manage, customize and extend Rest Services Gateway (RS Gateway) for customer-specific business needs. Using the SDK, you can extend existing projects or create entirely new projects to add, replace, or modify services that leverage existing functionality.
- Business API Gateway
  The Business API Gateway is a development framework that includes the Business API SDK, Rest Services Gateway (RS Gateway), Gateway Proxy, and application tier. It allows custom mobile applications, web clients, and other custom implementations to integrate with MATRIXX.
- Creating Extensions
  You create extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.
- Creating Custom Filters
  You can create a custom filter by creating a named filter or a filter class. A named filter is useful for simple filters while a filter class should be used for complex filters (for example, when the returned results must be modified).
- Upgrading the Business API SDK
  When you upgrade the MATRIXX software, you must upgrade the Business API SDK as it is possible that files have changed or have been deprecated. Use the manage_integration_project.py script to remove the current release from your project directory structure and upgrade to the latest release. You should do this even if your files are not checked into Subversion.
  - Upgrade JAR File Extensions
    Follow these steps to remove the current release from your project directory structure and upgrade to the latest release of the Business API SDK.
- Appendixes
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

Upgrade JAR File Extensions

Follow these steps to remove the current release from your project directory structure and upgrade to the latest release of the Business API SDK.

Before you begin

To simplify the project commands, create an alias. For example, at the command line, enter the following.

alias mip="manage_integration_project.py"

In the procedures in this example, the mip command runs the python module manage_integration_project.py.

About this task

Important: If you modified the /opt/mtx/bin/projects/project/pom.xml, the /opt/mtx/bin/projects/project/extensions/pom.xml file or the /opt/mtx/bin/projects/project/rsgwextension/pom.xml file, you must merge your changes with the latest version of the pom.xml file included in the SDK.

Procedure

Log into the server as a user with sudo permissions and change to user mtx.
For example:
ssh server_ip_address
sudo su - mtx
Create a new project.
mip -init-mvn:<project>
When answering the script questions, you must use the same values that you used in the original project (for example, for the groupId and version).
In the existing project directory, backup the ./pom.xml, ./extensions/pom.xml, and ./rsgwextension/pom.xml files.

Copy the newly generated pom.xml files to existing project.

cp -p ../clean_bapi/extensions/pom.xml ./extensions/pom.xml
cp -p ../clean_bapi/pom.xml ./pom.xml
cp -p ../clean_bapi/./rsgwextension/pom.xml ./rsgwextension/pom.xml

Re-merge any previous localizations (such as third-party dependencies) to one of the ./pom.xml, ./extensions/pom.xml, and ./rsgwextension/pom.xml files.
Copy all source files from the new project to the existing project (to add any missing classes); TAR all Java files in the extensions and rsgatewayextension subdirectories.
In the existing project directory, unpack the Java files from 6 to the rsgwextension/src/main/java directory (or the extensions/src/main/java directory).
Delete the stub Java file that was created when generating the new project.
rm ./rsgwextension/src/main/java/com/matrixx/rsgateway/configuration/DemoQuerySubscriberConfig.java
Build the project.
At the command prompt, type:
```
mvn clean install
```
Copy the rsgwextension.jar file to the /opt/mtx/ext/rsgateway directory.
Enter the following command to restart RS Gateway:
sudo systemctl restart mtx_rsgateway