Home
Subscriber Management (SubMan) API
Using the MATRIXX Java API
This section provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.

Welcome
Release Notes
Architecture Overview
MATRIXX Cloud Native Installation and Configuration
MATRIXX Cloud Native Integration
Implementing MATRIXX in a Cloud
Installation and Configuration
MATRIXX Digital Commerce Upgrade
MATRIXX Security
MATRIXX Engine Administration
MATRIXX Web App Administration
MATRIXX Engine Integration
Call Control Framework Integration
MATRIXX Diameter Integration
MATRIXX 5G Integration
MATRIXX Monitoring and Logging
Pricing and Rating
MATRIXX Pay Now
MATRIXX Policy
MATRIXX Event Streaming
Subscriber Management
Subscriber Management (SubMan) API
- About Subscriber Management (SubMan) API
  Subscriber Management (SubMan) API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
- SubMan API Overview
  The Subscriber Management (SubMan) API defines a set of programming interfaces to the MATRIXX in-memory database. In addition, the Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and event database for subscriptions and groups. The SubMan API can be used to manage the various in-memory objects in a defined manner, allowing an exchange of subscriber and group data between external applications and MATRIXX Engine.
- Subscriber Data
  MATRIXX Engine maintains transactional subscriber data that enables you to act in real-time to subscriber needs and service usage. The MATRIXX subscriber model is flexible and supports any type of subscriber base, such as retail, wholesale, and mobile virtual network operator (MVNO).
- Object Management Overview
  The following sections introduce how the various in-memory objects are managed.
- Connecting RS Gateway to the Event Repository
  The Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and Event database for subscribers and groups. The RS Gateway must be configured to connect to the Event Repository.
- Using the MATRIXX REST API
  This section explains how to use the REST API bindings to interface with MATRIXX Engine.
- REST API Reference
  This chapter describes the SubMan REST APIs.
- SubMan API Reference
  The SubMan API reference includes SubMan API and MDC descriptions.
- Using the MATRIXX Java API
  This section provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.
  - Java Packages
    The SubMan API Java packages include com.matrixx.datacontainer, com.matrixx.datacontainer.mdc, and com.matrixx.datacontainer.upgrade.
  - Generate the Java Classes for MATRIXX Data Containers
    Follow this procedure to generate the Java classes that are used by any custom Java applications that will connect to MATRIXX Engine.
  - Display the Version of a MATRIXX JAR or War File
    Follow this procedure to print the manifest information from a MATRIXX .jar or .war file.
  - Creating a Java Client Application
    MATRIXX provides sample Java client applications that are installed in the /opt/mtx/bin/ directory with the MATRIXX Proxy Server RPM. These samples, sample_java_client-5000.jar, sample_java_client-4500.jar, sample_java_client-4300.jar, and sample_java_client-4200.jar contain sample Java code that developers can use as a reference for creating custom Java applications.
  - Updating Java MDC Definitions in a Running System
    The Java MDC definitions must be updated after any MDC extensions are made so java applications can access the new fields.
  - Understanding Java and REST API Compatibility
    Clients that communicate with RS Gateway and other Proxy Server services and Web apps can process different versions of MDCs. This is necessary when the MATRIXX Engine is upgraded to a newer version.
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
Third-Party Licenses
Glossary

Using the MATRIXX Java API

This section provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.

Java API documentation is available in HTML format and is located on the MATRIXX Proxy Server. The Java API documentation is a specific reference document for information about the operations a programmer can call and does not completely describe the MATRIXX Engine data model.

When the rsgateway.war file is installed, the following resources are available from RS Gateway administrative UI.

Documentation — View documentation for all classes and methods.
XML Messages — View all XML messages and their descriptions.
JSON Templates — View all JSON templates and their contents.
Filters — View all known filters.
REST Call Swagger — View a list of all REST calls with their URL parameters and REST parameters.
Web App Status — View system properties, application properties, and JVM arguments.
Note: You must have the role RSG_DEBUG to access Web App Status.

For more information about the RS Gateway administrative UI, see the discussion about logging in to the administrative UI. For details about creating a Java client application, contact your MATRIXX support representative.