Name

Description

Provider Management

getProvider(Class<?> providerClass) /

getProvider(Long applicationID, Package parentPackage)

Retrieve a provider based on either class or Application ID and parent package.

registerCustomProvider(DiameterProvider<?,?,?,?,?> provider, Package parentPackage) / 

registerGlobalApplication(Package providerPackageName, Package packageName)

Register a custom or global provider with the stack, associating it with a package.

Session Management

generateNewSessionID()

Generate a new unique session ID.

newIncomingSession(ApplicationID applicationID) / 

newOutgoingSession(ApplicationID applicationID)

Register a new incoming or outgoing session for the specified application.

sessionEnded(Long resultCode, ApplicationID applicationID)

Handle session-ending events, categorized by result code and application.

isSessionLess()

Check if the stack is operating in a session-less mode.

Timeouts & Duplicates Management

getResponseTimeout()

Get the default response timeout for Diameter messages.

getIdleTimeout() / 

setIdleTimeout(Long value):

Retrieve or set the idle timeout for Diameter sessions.

getDuplicatesTimeout() / 

getDuplicatesCheckPeriod()

Get the duplicates detection timeout or check period for duplicate messages.

Message Handling

sendRequest(DiameterRequest message, AsyncCallback callback)

Send a DiameterRequest with an asynchronous callback.

sendAnswer(DiameterAnswer message, String destinationHost, String destinationRealm, AsyncCallback callback)

Send a DiameterAnswer to a specific host and realm with an asynchronous callback.

messageReceived(DiameterMessage message, String linkID) / 

messageSent(DiameterMessage message, String linkID)

Handle or log received and sent Diameter messages associated with a given link ID.

Link & Network Management

getLinkMessagesSentByTypeAndApplication(String linkID, ApplicationID applicationID) / 

getLinkMessagesReceivedByTypeAndApplication(String linkID, ApplicationID applicationID)

Get messages sent or received by link and application.

ID & Identifier Management

getIDGenerator() / generateID()

Retrieve the ID generator or generate a ClusteredID for distributed environments.

getNextHopByHopIdentifier() 

Retrieve the next available Hop-by-Hop identifier for message tracking.

Task & Queue Management

getQueue() / getPeriodicQueue()

Get the task queue or the periodic task queue for handling tasks.

Message Statistics

getMessagesSentByType() / 

getMessagesReceivedByType()

Retrieve sent or received messages categorized by type.

getErrorsSentByType() /

getErrorsReceivedByType()

Retrieve sent or received errors categorized by type.

getOutgoingSessionByApplication() /

getIncomingSessionsByApplication()

Retrieve outgoing or incoming sessions categorized by application.

getSessionEndedByResultCode()

Retrieve ended sessions categorized by result code.

getMessagesSentByTypeAndApplication(ApplicationID applicationID) /

 getMessagesReceivedByTypeAndApplication(ApplicationID applicationID)

Retrieve sent or received messages categorized by type and application.

getErrorsSentByTypeAndApplication(ApplicationID applicationID) /

 getErrorsReceivedByTypeAndApplication(ApplicationID applicationID)

Retrieve sent or received errors categorized by type and application.

System & Stack Management

stop()

Stop the Diameter stack and gracefully terminate all sessions and network connections.

getSessionStorage() / 

getRequestsStorage()

Retrieve the session storage or the incoming requests storage used by the stack.

Miscellaneous

getClassLoader()

Get the class loader used by the stack.

getProductName() / getVendorID() / getFirmwareRevision()

Retrieve the product name, vendor ID, or firmware revision of the stack.

getGlobalParser()

Retrieve the global DiameterParser responsible for parsing messages across the stack.

Name

Description

Factory Access

getAvpFactory()

Returns the AVP factory (A) responsible for creating AVPs, which represent data elements in Diameter messages.

getMessageFactory()

Returns the message factory (M), responsible for creating new Diameter messages such as requests and responses.

getSessionFactory()

Returns the session factory (F) that manages the lifecycle of Diameter sessions, including creating and managing sessions.

Listener Management

setClientListener(ClusteredID<?> listenerID, L1 listener) / 

removeClientListener(ClusteredID<?> listenerID)

Registers or removes a client-side listener (L1) for a given ClusteredID, handling client-side session events.

setServerListener(ClusteredID<?> listenerID, L2 listener) / 

removeServerListener(ClusteredID<?> listenerID)

Registers or removes a server-side listener (L2) for a given ClusteredID, handling server-side session events.

getClientListeners() /

getServerListeners()

Returns a map of all registered client-side or server-side listeners, keyed by their ClusteredID. Each entry represents a listener that handles session events on either the client or server side.

Session Management

getNewSession(DiameterRequest message)

Creates and returns a new DiameterSession based on an incoming DiameterRequest. This method is used to initialize a session when a new request is received.

Stack and Package Management

getStack()

Returns the associated DiameterStack, which manages network connections and session handling for the Diameter protocol.

getPackageName()

Returns the name of the package associated with the provider, used for identifying and organizing providers within the Mobius Diameter Stack.

Name

Description

Session Management

removeSession(String sessionId) / storeSession(DiameterSession session)

Removes or stores a DiameterSession in the session storage. Use removeSession() when a session ends, and storeSession() when a new session needs to be tracked.

getSession(String sessionId, DiameterProvider<?, ?, ?, ?, ?> provider)

Retrieves a DiameterSession based on the session ID and provider. Returns the session if found, or null if not.

Idle Timer Management

startIdleTimer(DiameterSession session, Long idleTime) / restartIdleTimer(DiameterSession session, Long newTime)

Starts or restarts the idle timer for a session with a specified timeout, ensuring the session is monitored for inactivity.

stopIdleTimer(ClusteredID<?> timerID)

Stops the idle timer for the session associated with the provided ClusteredID, typically used when a session is ending or no longer needs idle tracking.

Send Timer Management

startSendTimer(DiameterSession session) /  restartSendTimer(DiameterSession session)

Starts or restarts the send timer for a session, tracking message transmission deadlines.

stopSendTimer(ClusteredID<?> timerID)

Stops the send timer for the session associated with the provided ClusteredID, useful when no further messages are expected to be sent in the session.

Session Monitoring

getSessionsCount()

Returns the number of active sessions currently stored in the DiameterSessionStorage, useful for monitoring session load.

Name

Description

Basic Information & Status

getID()

Returns the unique identifier for the Diameter link.

isStarted() / isConnected() / isUp()

These methods return true or false based on the link’s status—whether it has started, is connected to a peer, and is fully operational.

isServer() / isSctp()

Returns true if the link is configured as a server or uses SCTP for communication, otherwise false.

Address and Host Information

getRemoteAddress() /  getRemotePort()

Returns the remote address (IP) and port of the peer connected to this link.

getLocalAddress() / getLocalPort()

Returns the local address (IP) and port used by this link for communication.

getLocalHost() / getLocalRealm()

Returns the local Diameter hostname and realm used by this link.

getDestinationHost() / getDestinationRealm()

Returns the destination Diameter hostname and realm for this link.

Application Registration & IDs

registerApplication(List<VendorSpecificApplicationId>, List<Long>, List<Long>, Package, Package)

Registers Diameter applications for the link, using vendor-specific, authentication, and accounting application IDs.

getAuthApplicationIds() / getAcctApplicationIds() / getVendorSpecificApplicationIds()

Returns lists of supported authentication, accounting, and vendor-specific application IDs.

getPackage(Long applicationID, Boolean isAuth)

Retrieves the package associated with a specific application ID, used for authentication or other purposes.

Message Handling

canSendMessage(DiameterMessage) / sendMessage(DiameterMessage, AsyncCallback)

Determines if the link can send a specific message, and sends the message if possible with an asynchronous callback for the response.

sendEncodedMessage(ByteBuf, AsyncCallback)

Sends a pre-encoded Diameter message using a ByteBuf and an AsyncCallback to handle the response.

messageReceived(DiameterMessage, String linkID) / messageSent(DiameterMessage, String linkID)

Handles received or sent Diameter messages, associating them with the given link ID.

Capabilities and Watchdog

sendCER() / sendCEA(CapabilitiesExchangeRequest)

Sends a Capabilities Exchange Request (CER) or Answer (CEA) to negotiate supported capabilities.

sendDWR() / sendDWA(DeviceWatchdogRequest, long resultCode)

Sends a Device Watchdog Request (DWR) to check if the connection is operational, or a Device Watchdog Answer (DWA) in response to a DWR.

Disconnect Operations

sendDPR(DisconnectCauseEnum, AsyncCallback) / sendDPA(DisconnectPeerRequest, long resultCode)

Sends a Disconnect Peer Request (DPR) or Answer (DPA) in response to a disconnect operation.

disconnectOperationCompleted()

Notifies the link that a disconnect operation has been successfully completed.

Peer State Management

getPeerState() / setPeerState(PeerStateEnum)

Gets or sets the current state of the peer associated with this link (e.g., OPEN, IDLE).

Timers

resetInactivityTimer() / resetReconnectTimer()

Resets the inactivity or reconnect timers for the link, ensuring that the connection is active or that reconnections are attempted.

Error Handling

sendError(DiameterException)

Sends an error message to the peer, handling any DiameterExceptions, such as missing or unsupported AVPs.

Lifecycle Management

start() / stop(Boolean remove)

Starts or stops the Diameter link, with the option to remove it from storage on stop. Throws DiameterException in case of failure.

Name

Description

logger:

A Logger instance from Apache Log4j used to log parser-related events and errors.

avpDefsMap:

A ConcurrentHashMap that stores AVP definitions (annotations) mapped by class type.

commandDefsMap:

A ConcurrentHashMap that stores command definitions (annotations) mapped by class type.

folderFilter:

An instance of FolderFilter, used for filtering file system objects.

globalInterfacesMapping:

A ConcurrentHashMap that stores globally registered Diameter commands by package name.

interfacesMapping:

A ConcurrentHashMap that stores Diameter commands mapped to specific application IDs.

avpImplementationsMap:

A ConcurrentHashMap that stores AVP class implementations mapped by the interface type.

avpsMap:

A ConcurrentHashMap that stores AvpData instances, which contain information about AVP structure and handling.

commandsMap:

A ConcurrentHashMap that stores command data (metadata about Diameter commands) mapped by class type.

Name

Description

Encoding Methods

ByteBuf encode(DiameterMessage message) / void encode(ByteBuf result, DiameterAvp avp, Boolean isError)

Encodes a DiameterMessage or an individual DiameterAvp into a ByteBuf. Validates the message or AVP, adds necessary headers, and handles encoding errors.

Decoding Methods

DiameterMessage decode(ByteBuf message, Boolean rejectUnmandatoryAvps) / DiameterMessage decode(ByteBuf message, Boolean rejectUnmandatoryAvps, Boolean isGlobal, String packageName)

Decodes a DiameterMessage from a ByteBuf, validating headers and AVPs. The second method supports globally registered applications and package-specific command mappings.

void decode(ByteBuf message, DiameterAvp parent, Boolean isError, ConcurrentHashMap<DiameterAvpKey, AvpData> childAvps, Integer length, Boolean rejectUnmandatoryAvps)

Decodes individual AVPs within a Diameter message, handling mandatory, optional, and grouped AVPs.

Length Calculation

Integer getLength(DiameterAvp parent, List<AvpData> childAvps) / Integer getLength(DiameterAvp parent)

Calculates the length of an AVP, either with child AVPs or the inner length excluding headers.

Application and AVP Registration

void registerGlobalApplication(ClassLoader classLoader, Package mappingName, Package packageName) / void registerApplication(ClassLoader classLoader, Package packageName)

Registers global or specific Diameter applications, loading necessary classes and setting up parsing logic for the commands and AVPs.

void registerAvps(ClassLoader classLoader, Package parentPackageName)

Registers AVPs found in the specified package, mapping AVP definitions to implementations.

AVP List Building

void buildAvpList(ChildData parentStorage, Long applicationID, Boolean isRequest, Integer commandCode, Class<?> parentType)

Builds the list of AVPs for a message using reflection to gather AVP field information.

Class Loading

List<Class<?>> loadClasses(ClassLoader classLoader, Package packageName) / List<Class<?>> loadAllClasses(ClassLoader classLoader, Package rootPackage)

Loads classes from a specified package, with the second method recursively loading all classes from the package and its sub-packages.

AVP and Command Definitions

DiameterAvpDefinition getAvpDefinition(Class<?> clazz) / Class<?> getAvpDefinitionClass(Class<?> clazz)

Retrieves the DiameterAvpDefinition annotation or the class that contains the annotation for a given class.

DiameterCommandDefinition getCommandDefinition(Class<?> clazz)

Retrieves the DiameterCommandDefinition annotation for a class.

Class and Interface Retrieval

List<Class<?>> getAllInterfaces(Class<?> clazz) / List<Class<?>> getAllClasses(Class<?> clazz)

Returns lists of all interfaces or classes in the hierarchy of the specified class, including superclasses.

Name

Description

void onMessage(DiameterMessage message, String linkID, AsyncCallback callback):

This method is invoked whenever a new DiameterMessage is received from the network. The parameters provide the details needed to handle the message:

message:

The DiameterMessage object representing the incoming Diameter message that needs to be processed.

linkID:

A String representing the ID of the link over which the message was received. This helps identify the source of the message in multi-link scenarios.

callback:

An AsyncCallback object, which is used to handle the asynchronous response or result of processing the incoming message.

Name

Description

void onTimeout(DiameterRequest lastRequest, DiameterSession session):

Triggered when a session times out after the last request was sent. This method provides details about the session and the last DiameterRequest message sent before the timeout occurred.

lastRequest:

The DiameterRequest object representing the last message that was sent before the timeout.

session:

The DiameterSession object representing the Diameter session that has timed out.

void onIdleTimeout(DiameterSession session):

Triggered when a session becomes idle for a specified period of time without activity. This method provides the session details, allowing for appropriate actions to be taken (such as closing the session or keeping it alive).

Name

Description

Parameters

void addLink(String linkId, InetAddress remoteAddress, Integer remotePort, InetAddress localAddress, Integer localPort, Boolean isServer, Boolean isSctp, String localHost, String localRealm, String destinationHost, String destinationRealm, Boolean rejectUnmandatoryAvps) throws DiameterException:

Adds a new link between the local node and a remote Diameter node. The method specifies the remote and local addresses, ports, hostnames, realms, and whether the connection should reject non mandatory AVPs.

linkId: Unique identifier for the link.

remoteAddress: IP address of the remote peer.

remotePort: Port number of the remote peer.

localAddress: Local IP address of the link.

localPort: Local port number of the link.

isServer: Whether this link is a server-side link.

isSctp: Whether this link uses SCTP (Stream Control Transmission Protocol).

localHost: Local Diameter host name.

localRealm: Local Diameter realm.

destinationHost: Destination Diameter host name.

destinationRealm: Destination Diameter realm.

rejectUnmandatoryAvps: If true, the link will reject messages with unmandatory AVPs.

Name

Description

Link Management

void removeLink(String linkId) throws DiameterException /  void startLink(String linkId) throws DiameterException /  void stopLink(String linkId, AsyncCallback callback) throws DiameterException:

Manages the lifecycle of a link—removing, starting, or stopping it based on the linkId. An AsyncCallback is used for stopLink to handle asynchronous tasks.

Link Retrieval

DiameterLink getLink(String linkId) /  List<DiameterLink> getAllLinks()

Retrieves a specific DiameterLink by linkId or returns a list of all active links managed by the NetworkManager.

Application Registration

void registerApplication(String linkId, List<VendorSpecificApplicationId> vendorApplicationIds, List<Long> authApplicationIds, List<Long> acctApplicationIds, Package providerPackageName, Package packageName) throws DiameterException

Registers vendor-specific applications, authentication, and accounting services for a specific link.

Network Control

void stop()

Stops all active links and gracefully shuts down the NetworkManager.

Network Listener Management

void addNetworkListener(String listenerId, NetworkListener listener) / void removeNetworkListener(String listenerId)

Adds or removes a NetworkListener to monitor network events or incoming messages for the specified listenerId.

Message Sending

void sendMessage(String linkId, DiameterMessage message, AsyncCallback callback) /  void sendRequest(DiameterRequest message, AsyncCallback callback) /  void sendAnswer(DiameterAnswer message, String destinationHost, String destinationRealm, AsyncCallback callback)

Sends a DiameterMessage, DiameterRequest, or DiameterAnswer over a specified link or to a destination. AsyncCallback is used to handle the result of sending the message asynchronously.

Name

Description

Parameters

createClientSession(Request request):

This method creates a new client-side session based on the specified request type. The request can vary depending on the Diameter application (e.g., CreditControlRequest, LocationInfoRequest, etc.). A ClientSession object is returned, representing the client-side session that can send requests and process responses.

request: The specific request that initiates the session, which could be different for each Diameter application.

Throws:

DiameterException or AvpNotSupportedException (depending on the session type and protocol).

Returns:

ClientSession: A session instance for managing client-side communication.

createServerSession(Request request):

This method creates a new server-side session based on the specified request type. Similar to the client session creation, the request type varies depending on the application, and the returned ServerSession is used to handle incoming requests and send responses.

request: The specific request that initiates the session.

Throws:

DiameterException or AvpNotSupportedException.

Returns:

ServerSession: A session instance for managing server-side communication.

Name

Description

getProxyInfo(String proxyHost, ByteBuf proxyState):

Creates a ProxyInfo AVP, containing proxy host information and proxy state.

Applicable for Diameter scenarios where intermediaries (proxies) handle communication.

getVendorSpecificApplicationId(Long vendorId, Long authApplicationId, Long acctApplicationId):

Generates a VendorSpecificApplicationId AVP that identifies a vendor-specific Diameter application.

Throws AvpOccursTooManyTimesException or MissingAvpException if validation fails.

getUserEquipmentInfo(UserEquipmentInfoTypeEnum userEquipmentInfoType, ByteBuf userEquipmentInfoValue):

Creates an AVP for user equipment information in applications like Credit Control or Gi.

Example of user equipment data includes IMEI, MAC addresses, etc.

getRestrictionFilterRule(String rule):

Generates a RestrictionFilterRule AVP for defining filters that restrict network traffic.

Useful for applications like Gi, where network access policies are enforced.

getFlows(Long mediaComponentNumber):

Creates a Flows AVP, which represents media flow information used in applications like Gq or Rx.

Required in scenarios dealing with multimedia streaming or real-time communication.

getSMDeliveryOutcome():

Generates an AVP for SMS delivery outcome, which is critical in S6c-based applications related to SMS messaging delivery status.

Name

Description

Request Creation

Each MessageFactory offers methods for creating various request messages such as CreditControlRequest, AARequest, SessionTerminationRequest, or MIP6Request. Developers provide the necessary parameters (e.g., originHost, destinationRealm, sessionID), and the factory constructs the message with all required AVPs.

Answer Creation

The factory also provides methods for creating answer messages such as CreditControlAnswer, AAAnswer, or ReAuthAnswer. These methods take in the corresponding request, identifiers, and result codes to construct a proper Diameter answer.