org.mobicents.slee.enabler.hssclient

Interface HSSClientChild

All Known Subinterfaces:

HSSClientChildSbbLocalObject

All Known Implementing Classes:

HSSClientChildSbb

public interface HSSClientChild

Author:

Alexandre Mendonca

Method Summary

Methods

Modifier and Type	Method and Description
String	getChargingInformation(String publicIdentity, byte[] msisdn, String destinationRealm, String destinationHost) Sends an User-Data-Request for Charging Information, using the following access key: IMS Public User Identity or Public Service Identity or MSISDN + Data-Reference
String	getIMSPublicIdentity(String publicIdentity, byte[] msisdn, int[] identitySets, String destinationRealm, String destinationHost) Sends an User-Data-Request for IMS Public Identity, using the following access key: IMS Public User Identity or Public Service Identity or MSISDN + Data-Reference + Identity-Set
String	getIMSUserState(String publicIdentity, String destinationRealm, String destinationHost) Sends an User-Data-Request for IMS User State, using the following access key: IMS Public User Identity + Data-Reference
String	getInitialFilterCriteria(String publicIdentity, String serverName, String destinationRealm, String destinationHost) Sends an User-Data-Request for Initial Filter Criteria, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference + Server-Name
String	getLocationInformation(byte[] msisdn, int requestedDomain, String destinationRealm, String destinationHost) Sends an User-Data-Request for Location Information, using the following access key: MSISDN + Data-Reference+ Requested-Domain
String	getMSISDN(String publicIdentity, byte[] msisdn, String destinationRealm, String destinationHost) Sends an User-Data-Request for MSISDN, using the following access key: IMS Public User Identity or MSISDN + Data-Reference
String	getPSIActivation(String publicIdentity, String destinationRealm, String destinationHost) Sends an User-Data-Request for PSI Activation, using the following access key: Public Service Identity + Data-Reference
String	getRepositoryData(String publicIdentity, byte[][] serviceIndications, String destinationRealm, String destinationHost) Sends an User-Data-Request for Repository Data, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference + Service-Indication
String	getSCSCFName(String publicIdentity, String destinationRealm, String destinationHost) Sends an User-Data-Request for S-CSCFName, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference
String	getUserState(byte[] msisdn, int requestedDomain, String destinationRealm, String destinationHost) Sends an User-Data-Request for User State, using the following access key: MSISDN + Data-Reference+ Requested-Domain
String	subscribeIMSUserState(String publicIdentity, int subscriptionRequestType, String destinationRealm, String destinationHost) Sends a Subscribe-Notifications-Request for Repository Data, using the following access key: IMS Public User Identity + Data-Reference
String	subscribeInitialFilterCriteria(String publicIdentity, String serverName, int subscriptionRequestType, String destinationRealm, String destinationHost) Sends a Subscribe-Notifications-Request for Initial Filter Criteria, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference + Server-Name
String	subscribePSIActivation(String publicIdentity, int subscriptionRequestType, String destinationRealm, String destinationHost) Sends a Subscribe-Notifications-Request for PSI Activation, using the following access key: Public Service Identity + Data-Reference
String	subscribeRepositoryData(String publicIdentity, byte[][] serviceIndications, int subscriptionRequestType, String destinationRealm, String destinationHost) Sends a Subscribe-Notifications-Request for Repository Data, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference + Service-Indication
String	subscribeSCSCFName(String publicIdentity, int subscriptionRequestType, String destinationRealm, String destinationHost) Sends a Subscribe-Notifications-Request for S-CSCF Name, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference
String	updatePSIActivation(String publicIdentity, String data, String destinationRealm, String destinationHost) Sends a Profile-Update-Request for PSI Activation, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference
String	updateRepositoryData(String publicIdentity, String data, String destinationRealm, String destinationHost) Sends a Profile-Update-Request for Repository Data, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference

Method Detail

getRepositoryData

String getRepositoryData(String publicIdentity,
                       byte[][] serviceIndications,
                       String destinationRealm,
                       String destinationHost)
                         throws IOException

Sends an User-Data-Request for Repository Data, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference + Service-Indication

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

serviceIndications - the Service-Indication(s) value(s)

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getIMSPublicIdentity

String getIMSPublicIdentity(String publicIdentity,
                          byte[] msisdn,
                          int[] identitySets,
                          String destinationRealm,
                          String destinationHost)
                            throws IOException

Sends an User-Data-Request for IMS Public Identity, using the following access key: IMS Public User Identity or Public Service Identity or MSISDN + Data-Reference + Identity-Set

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value (if any)

msisdn - the MSISDN value (if any)

identitySets - the Identity-Set value identifying which identities to retrieve, from the following values: ALL_IDENTITIES (0), REGISTERED_IDENTITIES (1), IMPLICIT_IDENTITIES (2)

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getIMSUserState

String getIMSUserState(String publicIdentity,
                     String destinationRealm,
                     String destinationHost)
                       throws IOException

Sends an User-Data-Request for IMS User State, using the following access key: IMS Public User Identity + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getSCSCFName

String getSCSCFName(String publicIdentity,
                  String destinationRealm,
                  String destinationHost)
                    throws IOException

Sends an User-Data-Request for S-CSCFName, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getInitialFilterCriteria

String getInitialFilterCriteria(String publicIdentity,
                              String serverName,
                              String destinationRealm,
                              String destinationHost)
                                throws IOException

Sends an User-Data-Request for Initial Filter Criteria, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference + Server-Name

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

serverName - the Server-Name value, a SIP URI identifying the AS

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getLocationInformation

String getLocationInformation(byte[] msisdn,
                            int requestedDomain,
                            String destinationRealm,
                            String destinationHost)
                              throws IOException

Sends an User-Data-Request for Location Information, using the following access key: MSISDN + Data-Reference+ Requested-Domain

Parameters:

msisdn - the MSISDN value

requestedDomain - the Requested-Domain value indicating the access domain for which the data is requested: CS-Domain (0), PS-Domain (1)

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getUserState

String getUserState(byte[] msisdn,
                  int requestedDomain,
                  String destinationRealm,
                  String destinationHost)
                    throws IOException

Sends an User-Data-Request for User State, using the following access key: MSISDN + Data-Reference+ Requested-Domain

Parameters:

msisdn - the MSISDN value

requestedDomain - the Requested-Domain value indicating the access domain for which the data is requested: CS-Domain (0), PS-Domain (1)

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getChargingInformation

String getChargingInformation(String publicIdentity,
                            byte[] msisdn,
                            String destinationRealm,
                            String destinationHost)
                              throws IOException

Sends an User-Data-Request for Charging Information, using the following access key: IMS Public User Identity or Public Service Identity or MSISDN + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value (if any)

msisdn - the MSISDN value (if any)

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getMSISDN

String getMSISDN(String publicIdentity,
               byte[] msisdn,
               String destinationRealm,
               String destinationHost)
                 throws IOException

Sends an User-Data-Request for MSISDN, using the following access key: IMS Public User Identity or MSISDN + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value (if any)

msisdn - the MSISDN value (if any)

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

getPSIActivation

String getPSIActivation(String publicIdentity,
                      String destinationRealm,
                      String destinationHost)
                        throws IOException

Sends an User-Data-Request for PSI Activation, using the following access key: Public Service Identity + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

updateRepositoryData

String updateRepositoryData(String publicIdentity,
                          String data,
                          String destinationRealm,
                          String destinationHost)
                            throws IOException

Sends a Profile-Update-Request for Repository Data, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

data - a String with the XML for the data to be updated

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

updatePSIActivation

String updatePSIActivation(String publicIdentity,
                         String data,
                         String destinationRealm,
                         String destinationHost)
                           throws IOException

Sends a Profile-Update-Request for PSI Activation, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

data - a String with the XML for the data to be updated

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

subscribeRepositoryData

String subscribeRepositoryData(String publicIdentity,
                             byte[][] serviceIndications,
                             int subscriptionRequestType,
                             String destinationRealm,
                             String destinationHost)
                               throws IOException

Sends a Subscribe-Notifications-Request for Repository Data, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference + Service-Indication

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

serviceIndications - the Service-Indication(s) value(s)

subscriptionRequestType - the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

subscribeIMSUserState

String subscribeIMSUserState(String publicIdentity,
                           int subscriptionRequestType,
                           String destinationRealm,
                           String destinationHost)
                             throws IOException

Sends a Subscribe-Notifications-Request for Repository Data, using the following access key: IMS Public User Identity + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

subscriptionRequestType - the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

subscribeSCSCFName

String subscribeSCSCFName(String publicIdentity,
                        int subscriptionRequestType,
                        String destinationRealm,
                        String destinationHost)
                          throws IOException

Sends a Subscribe-Notifications-Request for S-CSCF Name, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

subscriptionRequestType - the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

subscribeInitialFilterCriteria

String subscribeInitialFilterCriteria(String publicIdentity,
                                    String serverName,
                                    int subscriptionRequestType,
                                    String destinationRealm,
                                    String destinationHost)
                                      throws IOException

Sends a Subscribe-Notifications-Request for Initial Filter Criteria, using the following access key: IMS Public User Identity or Public Service Identity + Data-Reference + Server-Name

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

serverName - the Server-Name value, a SIP URI identifying the AS

subscriptionRequestType - the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException

subscribePSIActivation

String subscribePSIActivation(String publicIdentity,
                            int subscriptionRequestType,
                            String destinationRealm,
                            String destinationHost)
                              throws IOException

Sends a Subscribe-Notifications-Request for PSI Activation, using the following access key: Public Service Identity + Data-Reference

Parameters:

publicIdentity - the IMS Public User Identity or Public Service Identity value

subscriptionRequestType - the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile

destinationRealm - the Diameter realm to which the request is to be sent to

destinationHost - (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to

Returns:

a String representing the sent request Session-Id for possible matching

Throws:

IOException