oneapi.client

Interface HLRClient

All Known Implementing Classes:

HLRClientImpl

public interface HLRClient

Method Summary

Modifier and Type	Method and Description
void	addPushHLRNotificationsListener(HLRNotificationsListener listener) Add OneAPI PUSH 'HLR' Notifications listener and start push server simulator
RoamingNotification	convertJsonToHLRNotificationExample(String json) Convert JSON to HLR Notification
DeliveryReportSubscription[]	getHLRDeliveryNotificationsSubscriptionsById(String subscriptionId) Get HLR delivery notifications subscriptions by subscription id
List<HLRNotificationsListener>	getHLRPushNotificationListeners() Returns HLR Notifications PUSH Listeners list
Roaming	queryHLR(String address) Query the customer’s roaming status for a single network-connected mobile device and get HLR as the response
void	queryHLR(String address, String notifyURL) Query the customer’s roaming status for a single network-connected mobile device and get HLR to the specified notify url
void	queryHLR(String address, String notifyURL, String clientCorrelator, String callbackData) Query the customer’s roaming status for a single network-connected mobile device and get HLR to the specified notify url
void	queryHLRAsync(String address, ResponseListener<Roaming> responseListener) Query asynchronously the customer’s roaming status for a single network-connected mobile device and get HLR as the response
void	removeHLRDeliveryNotificationsSubscription(String subscriptionId) Stop subscribing to HLR delivery notifications over OneAPI
void	removePushHLRNotificationsListeners() Remove PUSH HLR listeners and stop server
String	subscribeToHLRDeliveryNotifications(SubscribeToHLRDeliveryNotificationsRequest subscribeToHLRDeliveryNotificationsRequest) Start subscribing to HLR delivery notifications over OneAPI

Method Detail

queryHLR

void queryHLR(String address,
              String notifyURL,
              String clientCorrelator,
              String callbackData)

Query the customer’s roaming status for a single network-connected mobile device and get HLR to the specified notify url

Parameters:

address - (mandatory) mobile device number being queried

notifyURL - (mandatory) URL to receive the roaming status asynchronously

clientCorrelator - (optional) Active only if notifyURL is specified, otherwise ignored. Uniquely identifies this request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request helps the operator to avoid call the same request twice.

callbackData - (optional) Active only if notifyURL is specified, otherwise ignored. This is custom data to pass back in notification to notifyURL, so you can use it to identify the request or any other useful data, such as a function name.

queryHLR

void queryHLR(String address,
              String notifyURL)

Query the customer’s roaming status for a single network-connected mobile device and get HLR to the specified notify url

Parameters:

address - (mandatory) mobile device number being queried

notifyURL - (mandatory) URL to receive the roaming status asynchronously

queryHLR

Roaming queryHLR(String address)

Query the customer’s roaming status for a single network-connected mobile device and get HLR as the response

Parameters:

address - (mandatory) mobile device number being queried

Returns:

Roaming

queryHLRAsync

void queryHLRAsync(String address,
                   ResponseListener<Roaming> responseListener)

Query asynchronously the customer’s roaming status for a single network-connected mobile device and get HLR as the response

Parameters:

address - (mandatory) mobile device number being queried

responseListener - (mandatory) method to call after receiving HLR response

convertJsonToHLRNotificationExample

RoamingNotification convertJsonToHLRNotificationExample(String json)

Convert JSON to HLR Notification

Returns:

RoamingNotification

subscribeToHLRDeliveryNotifications

String subscribeToHLRDeliveryNotifications(SubscribeToHLRDeliveryNotificationsRequest subscribeToHLRDeliveryNotificationsRequest)

Start subscribing to HLR delivery notifications over OneAPI

Returns:

String subscriptionId

getHLRDeliveryNotificationsSubscriptionsById

DeliveryReportSubscription[] getHLRDeliveryNotificationsSubscriptionsById(String subscriptionId)

Get HLR delivery notifications subscriptions by subscription id

Returns:

DeliveryReportSubscription[]

removeHLRDeliveryNotificationsSubscription

void removeHLRDeliveryNotificationsSubscription(String subscriptionId)

Stop subscribing to HLR delivery notifications over OneAPI

Parameters:

subscriptionId - (mandatory) contains the subscriptionId of a previously created HLR delivery receipt subscription return ResponseCode (integer)

addPushHLRNotificationsListener

void addPushHLRNotificationsListener(HLRNotificationsListener listener)

Add OneAPI PUSH 'HLR' Notifications listener and start push server simulator

getHLRPushNotificationListeners

List<HLRNotificationsListener> getHLRPushNotificationListeners()

Returns HLR Notifications PUSH Listeners list

removePushHLRNotificationsListeners

void removePushHLRNotificationsListeners()

Remove PUSH HLR listeners and stop server