org.mobicents.slee.enabler.hssclient

Class HSSClientChildSbb

java.lang.Object

org.mobicents.slee.enabler.hssclient.HSSClientChildSbb

All Implemented Interfaces:

javax.slee.Sbb, HSSClientChild

public abstract class HSSClientChildSbb
extends Object
implements javax.slee.Sbb, HSSClientChild

IMS User Profile SLEE Enabler.

Author:

Alexandre Mendonca

Field Summary

Fields

Modifier and Type	Field and Description
protected ShClientActivityContextInterfaceFactory	diameterShClientACIF
protected DiameterShAvpFactory	diameterShClientAvpFactory
protected ShClientMessageFactory	diameterShClientMessageFactory
protected ShClientProvider	diameterShClientSbbInterface
protected org.mobicents.slee.SbbContextExt	sbbContext

Constructor Summary

Constructors

Constructor and Description
HSSClientChildSbb()

Method Summary

Methods

Modifier and Type	Method and Description
abstract RequestMappingACI	asSbbActivityContextInterface(javax.slee.ActivityContextInterface aci)
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
protected HSSClientParentSbbLocalObject	getParent()
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
void	onProfileUpdateAnswer(ProfileUpdateAnswer event, RequestMappingACI aci)
void	onPushNotificationRequest(PushNotificationRequest event, RequestMappingACI aci)
void	onSubscriptionNotificationsAnswer(SubscribeNotificationsAnswer event, RequestMappingACI aci)
void	onUserDataAnswer(UserDataAnswer event, RequestMappingACI aci)
void	sbbActivate()
void	sbbCreate()
void	sbbExceptionThrown(Exception exception, Object event, javax.slee.ActivityContextInterface activity)
void	sbbLoad()
void	sbbPassivate()
void	sbbPostCreate()
void	sbbRemove()
void	sbbRolledBack(javax.slee.RolledBackContext arg0)
void	sbbStore()
void	setSbbContext(javax.slee.SbbContext sbbContext)
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
void	unsetSbbContext()
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sbbContext

protected org.mobicents.slee.SbbContextExt sbbContext

diameterShClientSbbInterface

protected ShClientProvider diameterShClientSbbInterface

diameterShClientACIF

protected ShClientActivityContextInterfaceFactory diameterShClientACIF

diameterShClientMessageFactory

protected ShClientMessageFactory diameterShClientMessageFactory

diameterShClientAvpFactory

protected DiameterShAvpFactory diameterShClientAvpFactory

Constructor Detail

HSSClientChildSbb

public HSSClientChildSbb()

Method Detail

asSbbActivityContextInterface

public abstract RequestMappingACI asSbbActivityContextInterface(javax.slee.ActivityContextInterface aci)

getParent

protected HSSClientParentSbbLocalObject getParent()

getRepositoryData

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

Description copied from interface: HSSClientChild

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

Specified by:

getRepositoryData in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getIMSPublicIdentity in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getIMSUserState in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getSCSCFName in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getInitialFilterCriteria in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getLocationInformation in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getUserState in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getChargingInformation in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getMSISDN in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

getPSIActivation in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

updateRepositoryData in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

updatePSIActivation in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

subscribeRepositoryData in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

subscribeIMSUserState in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

subscribeSCSCFName in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

subscribeInitialFilterCriteria in interface HSSClientChild

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

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

Description copied from interface: HSSClientChild

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

Specified by:

subscribePSIActivation in interface HSSClientChild

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

onSubscriptionNotificationsAnswer

public void onSubscriptionNotificationsAnswer(SubscribeNotificationsAnswer event,
                                     RequestMappingACI aci)

onProfileUpdateAnswer

public void onProfileUpdateAnswer(ProfileUpdateAnswer event,
                         RequestMappingACI aci)

onPushNotificationRequest

public void onPushNotificationRequest(PushNotificationRequest event,
                             RequestMappingACI aci)

onUserDataAnswer

public void onUserDataAnswer(UserDataAnswer event,
                    RequestMappingACI aci)

sbbActivate

public void sbbActivate()

Specified by:

sbbActivate in interface javax.slee.Sbb

sbbCreate

public void sbbCreate()
               throws javax.slee.CreateException

Specified by:

sbbCreate in interface javax.slee.Sbb

Throws:

javax.slee.CreateException

sbbExceptionThrown

public void sbbExceptionThrown(Exception exception,
                      Object event,
                      javax.slee.ActivityContextInterface activity)

Specified by:

sbbExceptionThrown in interface javax.slee.Sbb

sbbLoad

public void sbbLoad()

Specified by:

sbbLoad in interface javax.slee.Sbb

sbbPassivate

public void sbbPassivate()

Specified by:

sbbPassivate in interface javax.slee.Sbb

sbbPostCreate

public void sbbPostCreate()
                   throws javax.slee.CreateException

Specified by:

sbbPostCreate in interface javax.slee.Sbb

Throws:

javax.slee.CreateException

sbbRemove

public void sbbRemove()

Specified by:

sbbRemove in interface javax.slee.Sbb

sbbRolledBack

public void sbbRolledBack(javax.slee.RolledBackContext arg0)

Specified by:

sbbRolledBack in interface javax.slee.Sbb

sbbStore

public void sbbStore()

Specified by:

sbbStore in interface javax.slee.Sbb

setSbbContext

public void setSbbContext(javax.slee.SbbContext sbbContext)

Specified by:

setSbbContext in interface javax.slee.Sbb

unsetSbbContext

public void unsetSbbContext()

Specified by:

unsetSbbContext in interface javax.slee.Sbb