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

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
- About Subscriber Management API
  MATRIXX Subscriber Management API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
- Subscriber Management
  The following information is an overview of the SubMan APIs and architecture.
- Object Management
  The following sections introduce how the various in-memory objects are managed.
- SubMan API Reference
  The SubMan API reference includes SubMan API and MDC descriptions.
- REST API Management
  RS Gateway supports the REST API bindings for accessing subscriber data in MATRIXX Engine. RS Gateway consists of an rsgateway application and a set of REST APIs.
- REST API Reference
  This part describes how to use the REST API bindings to interface with MATRIXX Engine.
- Java API
  This part 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.
  - Java API Bindings
  - 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 delivered in the MATRIXX Misc image. 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
    When you upgrade MATRIXX Engine to a new version of MATRIXX , MATRIXX Data Container (MDC) properties may have changed.
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

Java API

This part 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 delivered with the RS Gateway. 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 RS Gateway 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/XML Templates — View all JSON and XML templates and their contents.
Filters — View all known filters.
REST Call Swagger — View the OpenAPI version of the RS Gateway. Includes 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.