com.ibm.diameter.sh
Interface DiameterShService_SEI

All Superinterfaces:
java.rmi.Remote

public interface DiameterShService_SEI
extends java.rmi.Remote

The Sh subscriber profile Web service is a component of the WebSphere Diameter Enabler base that serves as the interface between an IMS Application Server and the Home Subscriber Server (HSS) where subscriber data is centrally stored. The Sh subscriber profile Web service provides retrieval and update APIs so that IMS Application Servers can upload data to and download data from the HSS. This Web service also supports subscription APIs so that the IMS Application Server application can subscribe to data changes stored in the HSS.


Method Summary
 ChargingInformation getChargingInformation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, java.lang.String msisdn)
          Retrieves the Diameter URIs of the primary and secondary charging functions associated with the specified user from the HSS.
 CSLocationInformation getCSLocationInformation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String msisdn)
          Retrieves the circuit-switched(CS) network LocationInformation associated with the specified MSISDN from the HSS.
 int getCSUserState(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String msisdn)
          Retrieves the state of the specified user (MSISDN) in a circuit-switched (CS) domain from the HSS.
 int getIMSUserState(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicUserIdentity)
          Retrieves the IMS User State from the HSS of the public identifier referenced.
 InitialFilterCriteria[] getInitialFilterCriteria(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, java.net.URI serverName)
          Retrieves the InitialFilterCriteria for the specified publicIdentity and serverName from the HSS.
 java.lang.String[] getMSISDN(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicUserIdentity)
          Deprecated. As of release 6.1.1, replaced by getMSISDNList
 java.lang.String[] getMSISDNList(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicUserIdentity, java.lang.String msisdn)
          Retrieves the MSISDN numbers associated with the specified user from the HSS.
 int getPSIActivation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity)
          Retrieves the PSI Activation associated with the specified user from the HSS.
 PSLocationInformation getPSLocationInformation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String msisdn)
          Retrieves the packet-switched(PS) network LocationInformation associated with the specified MSISDN from the HSS.
 int getPSUserState(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String msisdn)
          Retrieves the state of the specified user (MSISDN) in a packet-switched (PS) domain from the HSS.
 PublicIdentifiers getPublicIdentifiers(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicUserIdentity, java.lang.String msisdn, int identitySet)
          Returns Public Identifiers from the HSS for the publicIdentity or MSISDN specified.
 RepositoryData getRepositoryData(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, java.lang.String serviceIndication)
          Retrieves RepositoryData from the HSS for the specified publicIdentity and serviceIndication.
 java.net.URI getSCSCFName(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity)
          Retrieves the S-CSCFName for the associated public identity from the HSS.
 java.lang.String getUserData(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicUserIdentity, java.lang.String msisdn, int dataReference, java.lang.String serviceIndication, int identitySet, int requestedDomain, java.net.URI serverName)
          Retrieves user profile data in an XML string representation.
 java.lang.String subscribeIMSUserState(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicUserIdentity, int subsReqType, java.net.URI callbackUri, java.lang.String userid, java.lang.String password)
          Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the IMSUserState for the specified publicUserIdentity changes.
 java.lang.String subscribeInitialFilterCriteria(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, int subsReqType, java.net.URI serverName, java.net.URI callbackUri, java.lang.String userid, java.lang.String password)
          Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the InitialFilterCriteria associated with the specified publicIdentity and serverName changes.
 java.lang.String subscribePSIActivation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, int subsReqType, java.net.URI callbackUri, java.lang.String userid, java.lang.String password)
          Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the PSIActivation associated with the specified publicIdentity and serverName changes.
 java.lang.String subscribeRepositoryData(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, java.lang.String serviceIndication, int subsReqType, java.net.URI callbackUri, java.lang.String userid, java.lang.String password)
          Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when respository data for the publicIdentity and serviceIndication change.
 java.lang.String subscribeSCSCFName(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, int subsReqType, java.net.URI callbackUri, java.lang.String userid, java.lang.String password)
          Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the S-CSCFName associated with the publicIdentity specified changes.
 java.lang.String subscribeUserData(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, int dataReference, java.lang.String serviceIndication, int subsReqType, java.net.URI serverName, java.net.URI callbackUri, java.lang.String userid, java.lang.String password)
          Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the data type specified in the dataReference field changes.
 java.lang.String updatePSIActivation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, int activation)
          Updates PSIActivation in the HSS for the specified publicIdentity.
 java.lang.String updateRepositoryData(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, java.lang.String serviceIndication, int sequenceNumber, java.lang.String serviceData)
          Updates RepositoryData in the HSS user profile for the specified publicIdentity and serviceIndication.
 java.lang.String updateRepositoryDataByXML(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity, java.lang.String userData)
          Updates RepositoryData in the HSS user profile for the specified publicIdentity and serviceIndication.
 

Method Detail

getRepositoryData

RepositoryData getRepositoryData(java.lang.String sessionId,
                                 java.lang.String destinationHost,
                                 java.lang.String destinationRealm,
                                 java.lang.String publicIdentity,
                                 java.lang.String serviceIndication)
                                 throws java.lang.Exception
Retrieves RepositoryData from the HSS for the specified publicIdentity and serviceIndication.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
serviceIndication - Uniquely identifies the requested service data.
Returns:
RepositoryData Contains the data received from the HSS.
Throws:
java.lang.Exception

getPublicIdentifiers

PublicIdentifiers getPublicIdentifiers(java.lang.String sessionId,
                                       java.lang.String destinationHost,
                                       java.lang.String destinationRealm,
                                       java.lang.String publicUserIdentity,
                                       java.lang.String msisdn,
                                       int identitySet)
                                       throws java.lang.Exception
Returns Public Identifiers from the HSS for the publicIdentity or MSISDN specified. The Public Identifiers may include IMS Public User Identities, Public Service Identities, or MSISDNs.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicUserIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL). If this parameter is null, then the msisdn parameter must be specified.
msisdn - Specifies a valid MSISDN number. If this parameter is null, then publicIdentity must be specified. If both msisdn and publicIdentity are specified, msisdn is ignored.
identitySet - Must be one of the values defined in ShDataType.xsd:
  • 0 for ALL_IDENTITIES
  • 1 for REGISTERED_IDENTITIES
  • 2 for IMPLICIT_IDENTITIES (IMPLICIT_IDENTITIES will not include MSISDNs.)
Returns:
PublicIdentifiers Contains the data received from the HSS.
Throws:
java.lang.Exception

getIMSUserState

int getIMSUserState(java.lang.String sessionId,
                    java.lang.String destinationHost,
                    java.lang.String destinationRealm,
                    java.lang.String publicUserIdentity)
                    throws java.lang.Exception
Retrieves the IMS User State from the HSS of the public identifier referenced.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicUserIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
Returns:
Returns the IMS User State of the public identifier referenced. The possible values are:
  • 0 for NOT_REGISTERED
  • 1 for REGISTERED
  • 2 for REGISTERED_UNREG_SERVICES
  • 3 for AUTHENTICATION_PENDING
Throws:
java.lang.Exception

getSCSCFName

java.net.URI getSCSCFName(java.lang.String sessionId,
                          java.lang.String destinationHost,
                          java.lang.String destinationRealm,
                          java.lang.String publicIdentity)
                          throws java.lang.Exception
Retrieves the S-CSCFName for the associated public identity from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
Returns:
Returns the SIP URI of the S-CSCFName associated with this public identity.
Throws:
java.lang.Exception

getInitialFilterCriteria

InitialFilterCriteria[] getInitialFilterCriteria(java.lang.String sessionId,
                                                 java.lang.String destinationHost,
                                                 java.lang.String destinationRealm,
                                                 java.lang.String publicIdentity,
                                                 java.net.URI serverName)
                                                 throws java.lang.Exception
Retrieves the InitialFilterCriteria for the specified publicIdentity and serverName from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
serverName - The SIP URL of the application server that is providing the service of interest.
Returns:
Returns one or more InitialFilterCriteria objects that contain a collection of user-related information that helps a S-CSCF determine when to invoke a particular Application Server to provide a service.
Throws:
java.lang.Exception

getCSLocationInformation

CSLocationInformation getCSLocationInformation(java.lang.String sessionId,
                                               java.lang.String destinationHost,
                                               java.lang.String destinationRealm,
                                               java.lang.String msisdn)
                                               throws java.lang.Exception
Retrieves the circuit-switched(CS) network LocationInformation associated with the specified MSISDN from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
msisdn - Specifies the MSISDN number.
Returns:
Returns a CSLocationInformation object containing the location information for the given user or service.
Throws:
java.lang.Exception

getPSLocationInformation

PSLocationInformation getPSLocationInformation(java.lang.String sessionId,
                                               java.lang.String destinationHost,
                                               java.lang.String destinationRealm,
                                               java.lang.String msisdn)
                                               throws java.lang.Exception
Retrieves the packet-switched(PS) network LocationInformation associated with the specified MSISDN from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
msisdn - Specifies the MSISDN number.
Returns:
Returns a PSLocationInformation object containing the location information for the given user or service.
Throws:
java.lang.Exception

getCSUserState

int getCSUserState(java.lang.String sessionId,
                   java.lang.String destinationHost,
                   java.lang.String destinationRealm,
                   java.lang.String msisdn)
                   throws java.lang.Exception
Retrieves the state of the specified user (MSISDN) in a circuit-switched (CS) domain from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
msisdn - Specifies the MSISDN number.
Returns:
Returns the state of the user in the CS domain. The possible values are:
  • 0 = CAMELBusy
  • 1 = NetworkDeterminedNotReachable
  • 2 = AssumedIdle
  • 3 = NotProvidedfromVLR
Throws:
java.lang.Exception

getPSUserState

int getPSUserState(java.lang.String sessionId,
                   java.lang.String destinationHost,
                   java.lang.String destinationRealm,
                   java.lang.String msisdn)
                   throws java.lang.Exception
Retrieves the state of the specified user (MSISDN) in a packet-switched (PS) domain from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
msisdn - Specifies the MSISDN number.
Returns:
Returns the state of the user in the PS domain. The possible values are:
  • 0 = Detached
  • 1 = AttachedNotReachableForPaging
  • 2 = AttachedReachableForPaging
  • 3 = ConnectedNotReachableForPaging
  • 4 = ConnectedReachableForPaging
  • 5 = NotProvidedFromSGSN
  • 6 = NetworkDeterminedNotReachable
Throws:
java.lang.Exception

getChargingInformation

ChargingInformation getChargingInformation(java.lang.String sessionId,
                                           java.lang.String destinationHost,
                                           java.lang.String destinationRealm,
                                           java.lang.String publicIdentity,
                                           java.lang.String msisdn)
                                           throws java.lang.Exception
Retrieves the Diameter URIs of the primary and secondary charging functions associated with the specified user from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicUserIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL). If this parameter is null, then the msisdn parameter must be specified.
msisdn - Specifies a valid MSISDN number. If this parameter is null, then publicIdentity must be specified. If both msisdn and publicIdentity are specified, msisdn is ignored.
Returns:
Returns a ChargingInformation object containing the addresses of the charging functions. The addresses are Diameter URIs as defined in RFC 3588.
Throws:
java.lang.Exception

getPSIActivation

int getPSIActivation(java.lang.String sessionId,
                     java.lang.String destinationHost,
                     java.lang.String destinationRealm,
                     java.lang.String publicIdentity)
                     throws java.lang.Exception
Retrieves the PSI Activation associated with the specified user from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
Returns:
Returns the state of the PSI Activation. The possible values are:
  • 0 = INACTIVE
  • 1 = ACTIVE
Throws:
java.lang.Exception

getMSISDN

java.lang.String[] getMSISDN(java.lang.String sessionId,
                             java.lang.String destinationHost,
                             java.lang.String destinationRealm,
                             java.lang.String publicUserIdentity)
                             throws java.lang.Exception
Deprecated. As of release 6.1.1, replaced by getMSISDNList

Retrieves the MSISDN numbers associated with the specified publicUserIdentity from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicUserIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
Returns:
Returns a String array containing MSISDN numbers the HSS associates with the specified publicUserIdentity.
Throws:
java.lang.Exception

getMSISDNList

java.lang.String[] getMSISDNList(java.lang.String sessionId,
                                 java.lang.String destinationHost,
                                 java.lang.String destinationRealm,
                                 java.lang.String publicUserIdentity,
                                 java.lang.String msisdn)
                                 throws java.lang.Exception
Retrieves the MSISDN numbers associated with the specified user from the HSS.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicUserIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL). If this parameter is null, then the msisdn parameter must be specified.
msisdn - Specifies a valid MSISDN number. If this parameter is null, then publicIdentity must be specified. If both msisdn and publicIdentity are specified, msisdn is ignored.
Returns:
Returns a String array containing MSISDN numbers from the HSS associated with the specified user.
Throws:
java.lang.Exception

getUserData

java.lang.String getUserData(java.lang.String sessionId,
                             java.lang.String destinationHost,
                             java.lang.String destinationRealm,
                             java.lang.String publicUserIdentity,
                             java.lang.String msisdn,
                             int dataReference,
                             java.lang.String serviceIndication,
                             int identitySet,
                             int requestedDomain,
                             java.net.URI serverName)
                             throws java.lang.Exception
Retrieves user profile data in an XML string representation. The XML file adheres to the format defined in the ShDataType.xsd schema file. The parameters that are required will depend on the type of data being requested.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicUserIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL). When requesting IMSPublicIdentity or ChargingInformation either the publicUserIdentity or msisdn parameter may be specified.
msisdn - Specifies a valid MSISDN number.
dataReference - indicates the type of user data being requested. It must be one of the following values:
  • 0 = RepositoryData
  • 10 = IMSPublicIdentity
  • 11 = IMSUserState
  • 12 = S_CSCFName
  • 13 = InitialFilterCriteria
  • 14 = LocationInformation
  • 15 = UserState
  • 16 = ChargingInformation
  • 17 = MSISDN
  • 18 = PSIActivation
serviceIndication - Uniquely identifies the requested service data. This parameter is required only if the dataReference value is 0.
identitySet - Must be one of the values defined in ShDataType.xsd: This parameter is required only if the dataReference value is 10.
  • 0 for ALL_IDENTITIES
  • 1 for REGISTERED_IDENTITIES
  • 2 for IMPLICIT_IDENTITIES (IMPLICIT_IDENTITIES will not include MSISDNs.)
requestedDomain - Indicates either a CS or PS domain. This parameter is required only if dataReference value is 14 or 15.
  • 0 for CS Domain
  • 1 for PS Domain
serverName - The SIP URL of the application server that is providing the service of interest. This parameter is required only if dataReference value is 13.
Returns:
Returns an XML String representation of user profile data complying with ShDataType.xsd defined in ETSI TS 129.328
Throws:
java.lang.Exception

updateRepositoryData

java.lang.String updateRepositoryData(java.lang.String sessionId,
                                      java.lang.String destinationHost,
                                      java.lang.String destinationRealm,
                                      java.lang.String publicIdentity,
                                      java.lang.String serviceIndication,
                                      int sequenceNumber,
                                      java.lang.String serviceData)
                                      throws java.lang.Exception
Updates RepositoryData in the HSS user profile for the specified publicIdentity and serviceIndication.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
sequenceNumber - Unique sequence number of the data being updated.
serviceIndication - Uniquely identifies the requested service data.
serviceData - String representation of the user profile data to be updated.
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes

updateRepositoryDataByXML

java.lang.String updateRepositoryDataByXML(java.lang.String sessionId,
                                           java.lang.String destinationHost,
                                           java.lang.String destinationRealm,
                                           java.lang.String publicIdentity,
                                           java.lang.String userData)
                                           throws java.lang.Exception
Updates RepositoryData in the HSS user profile for the specified publicIdentity and serviceIndication. The user profile data is provided as an XML string that adheres to the schema defined in ShDataType.xsd.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
userData - An XML string representation of the user profile data which must comply with ShDataType.xsd defined in ETSI TS 129.328
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes

updatePSIActivation

java.lang.String updatePSIActivation(java.lang.String sessionId,
                                     java.lang.String destinationHost,
                                     java.lang.String destinationRealm,
                                     java.lang.String publicIdentity,
                                     int activation)
                                     throws java.lang.Exception
Updates PSIActivation in the HSS for the specified publicIdentity.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public service identity
activation - Specifies if the Public service identity is to be activated or inactivated.
  • 0=INACTIVE
  • 1=ACTIVE
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes

subscribeRepositoryData

java.lang.String subscribeRepositoryData(java.lang.String sessionId,
                                         java.lang.String destinationHost,
                                         java.lang.String destinationRealm,
                                         java.lang.String publicIdentity,
                                         java.lang.String serviceIndication,
                                         int subsReqType,
                                         java.net.URI callbackUri,
                                         java.lang.String userid,
                                         java.lang.String password)
                                         throws java.lang.Exception
Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when respository data for the publicIdentity and serviceIndication change. Any subsequent notification data will contain a RepositoryData object with the updates.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
serviceIndication - Uniquely identifies the requested service data.
subsReqType - An integer identifying the type of request:
  • 0 for Subscribe
  • 1 for Unsubscribe
callbackUri - Specifies the URI of the notification Web service used to deliver notification back to the Sh application client.
userid - Userid used to access the Sh Application Client's Notify Web service. If this is null, this and the password are ignored
password - Password used to access the Sh Applications Client's Web service. If this is null, this and the userid are ignored.
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes

subscribeIMSUserState

java.lang.String subscribeIMSUserState(java.lang.String sessionId,
                                       java.lang.String destinationHost,
                                       java.lang.String destinationRealm,
                                       java.lang.String publicUserIdentity,
                                       int subsReqType,
                                       java.net.URI callbackUri,
                                       java.lang.String userid,
                                       java.lang.String password)
                                       throws java.lang.Exception
Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the IMSUserState for the specified publicUserIdentity changes.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicUserIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
subsReqType - An integer identifying the type of request:
  • 0 for Subscribe
  • 1 for Unsubscribe
callbackUri - Specifies the URI of the notification Web service used to deliver notification back to the Sh application client.
userid - Userid used to access the Sh Application Client's Notify Web service. If this is null, this and the password are ignored
password - Password used to access the Sh Applications Client's Web service. If this is null, this and the userid are ignored.
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes

subscribeSCSCFName

java.lang.String subscribeSCSCFName(java.lang.String sessionId,
                                    java.lang.String destinationHost,
                                    java.lang.String destinationRealm,
                                    java.lang.String publicIdentity,
                                    int subsReqType,
                                    java.net.URI callbackUri,
                                    java.lang.String userid,
                                    java.lang.String password)
                                    throws java.lang.Exception
Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the S-CSCFName associated with the publicIdentity specified changes.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
subsReqType - An integer identifying the type of request:
  • 0 for Subscribe
  • 1 for Unsubscribe
callbackUri - Specifies the URI of the notification Web service used to deliver notification back to the Sh application client.
userid - Userid used to access the Sh Application Client's Notify Web service. If this is null, this and the password are ignored
password - Password used to access the Sh Applications Client's Web service. If this is null, this and the userid are ignored.
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes

subscribeInitialFilterCriteria

java.lang.String subscribeInitialFilterCriteria(java.lang.String sessionId,
                                                java.lang.String destinationHost,
                                                java.lang.String destinationRealm,
                                                java.lang.String publicIdentity,
                                                int subsReqType,
                                                java.net.URI serverName,
                                                java.net.URI callbackUri,
                                                java.lang.String userid,
                                                java.lang.String password)
                                                throws java.lang.Exception
Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the InitialFilterCriteria associated with the specified publicIdentity and serverName changes. Any subsequent notification data will contain one or more InitialFilterCriteria objects.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
subsReqType - An integer identifying the type of request:
  • 0 for Subscribe
  • 1 for Unsubscribe
serverName - The SIP URL of the application server that is providing the service of interest.
callbackUri - Specifies the URI of the notification Web service used to deliver notification back to the Sh application client.
userid - Userid used to access the Sh Application Client's Notify Web service. If this is null, this and the password are ignored
password - Password used to access the Sh Applications Client's Web service. If this is null, this and the userid are ignored.
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes

subscribePSIActivation

java.lang.String subscribePSIActivation(java.lang.String sessionId,
                                        java.lang.String destinationHost,
                                        java.lang.String destinationRealm,
                                        java.lang.String publicIdentity,
                                        int subsReqType,
                                        java.net.URI callbackUri,
                                        java.lang.String userid,
                                        java.lang.String password)
                                        throws java.lang.Exception
Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the PSIActivation associated with the specified publicIdentity and serverName changes.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
subsReqType - An integer identifying the type of request:
  • 0 for Subscribe
  • 1 for Unsubscribe
serverName - The SIP URL of the application server that is providing the service of interest.
callbackUri - Specifies the URI of the notification Web service used to deliver notification back to the Sh application client.
userid - Userid used to access the Sh Application Client's Notify Web service. If this is null, this and the password are ignored
password - Password used to access the Sh Applications Client's Web service. If this is null, this and the userid are ignored.
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes

subscribeUserData

java.lang.String subscribeUserData(java.lang.String sessionId,
                                   java.lang.String destinationHost,
                                   java.lang.String destinationRealm,
                                   java.lang.String publicIdentity,
                                   int dataReference,
                                   java.lang.String serviceIndication,
                                   int subsReqType,
                                   java.net.URI serverName,
                                   java.net.URI callbackUri,
                                   java.lang.String userid,
                                   java.lang.String password)
                                   throws java.lang.Exception
Used by IMS Application Server to subscribe or unsubscribe to notifications from the HSS when the data type specified in the dataReference field changes. The notification data will be sent as an XML string representation that adheres to the format defined in the ShDataType.xsd schema file.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
destinationHost - An optional parameter. If specified, it must be the FQDN of destination Diameter node which handles the request.
destinationRealm - The realm of the destination Diameter node which handles the request. It must be a FQDN.
publicUserIdentity - Specifies a public user identity or a public service identity (either a SIP URL or a TEL URL).
dataReference - Indicates the type of user data for the subscription request. It must be one of the following values:
  • 0 = RepositoryData
  • 11 = IMSUserState
  • 12 = S_CSCFName
  • 13 = InitialFilterCriteria
  • 18 = PSIActivation
serviceIndication - Uniquely identifies the requested service data. This parameter is required only if the dataReference value is 0.
subsReqType - An integer identifying the type of request:
  • 0 for Subscribe
  • 1 for Unsubscribe
serverName - The SIP URL of the application server that is providing the service of interest. This parameter is required only if dataReference value is 13.
callbackUri - Specifies the URI of the notification Web service used to deliver notification back to the Sh application client.
userid - Userid used to access the Sh Application Client's Notify Web service. If this is null, this and the password are ignored
password - Password used to access the Sh Applications Client's Web service. If this is null, this and the userid are ignored.
Returns:
Result string containing the result code from the HSS.
Throws:
java.lang.Exception
See Also:
ResultCodes


Copyright © 2006 IBM Corp. All Rights Reserved.