WebSphere brand IBM WebSphere IP Multimedia Subsystem Connector, Version 6.2

subscribeUserData Web service method

This Web service method is used to subscribe to notifications for the following data_reference types: RepositoryData, InitialFilterCriteria, S-CSCFName, and IMSUserState. The notification data is returned in an XML string representation, that adheres to the schema defined in ShDataType.xsd.

Usage

The result code for the subscribe operation is returned.

Example

An example is provided for each type of data because the parameter requirements are different

URI callbackUri = new URI("http://hostname.example.com:1234/DHADiameterShNotifyTestClient/services/DiameterShNotifyService");
Example for Subscribe to RepositoryData notifications:
String subscribeResult = service.subscribeUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", "sips:carol@ws1234.example.com", 0, "IBM-Diameter-SH-1234567", 0, null, callbackUri, null, null);
Example for Subscribe to InitialFilterCriteria notifications:
URI serverUri = new URI("sip:siphappens.example.com");
String subscribeResult = service.subscribeUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", "sips:carol@ws1234.example.com", 13, null, 0, serverUri, callbackUri, null, null ); 
Example for Subscribe to S-CSCFName notifications:
String subscribeResult = service.subscribeUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", "sips:carol@ws1234.example.com", 12, null, 0, null, callbackUri, null, null ); 
Example for Subscribe to IMSUserState notifications:
String subscribeResult = service.subscribeUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", "sips:carol@ws1234.example.com", 11, null, 0, null, callbackUri, null, null );
Example for Subscribe to PSIActivation notifications:
String subscribeResult = service.subscribeUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", "sips:carol@ws1234.example.com", 18, null, 0, null, callbackUri, null, null );

Parameters

Parameter Name Type Description
sessionId String

Identifies a specific session. All messages pertaining to a specific session must include only one Session-Id AVP and the same value must be used throughout the life of a session. The Session ID must be globally and eternally unique, as it is meant to uniquely identify a user session without reference to any other information. This may be needed to correlate historical authentication information with accounting information. Example: aaa://host.example.com;protocol=diameter;-117302099;1

destinationHost String

The fully qualified domain name of the HSS that the Sh subscriber profile Web service will send this request to. This input parameter is optional. Examples include: sipintel15.city.example.com or diameter.example.com

destinationRealm String

The realm that this subscriber belongs to. The destination realm is a required parameter and must be a fully qualified domain name. The value specified must match the specific realmName property that is defined in one of the routex properties in the Diameter_Sh.properties file. If the value does not match any of the specific routes, and a DEFAULT route entry is defined, the DEFAULT route will be used.

publicUserIdentity String
A subscriber is allocated one or more public user identities, which are created by the home operator. A public user identity is either a SIP URL (as defined in RFC 3261) or a TEL URI (as defined in RFC 3966) and helps route a SIP request. Example:
  • sip:Alice.Smith@example.com;transport=tcp
  • sips:carol@ws1234.example.com
  • sip:+358-555-1234567;postd=pp22@example.com;user=phone
  • sip:alice;day=tuesday@example.com
  • tel:+919-123-4567
  • tel:+358-555-1234567;postd=pp22
dataReference int

Data reference values indicate the type of user data being requested:

  • 0 = Repository Data
  • 11 = IMSUserState
  • 12 = S_CSCFName
  • 13 = InitialFilterCriteria
  • 18 = PSI Activation
serviceIndication String

A unique identifier for the requested service data. Example: IBM-Diameter-SH-1234567.

This parameter is only required if the dataReference value is set to 0 for the repository data.

subsReqType int
Available subscription status values:
  • 0 = SUBSCRIBE
  • 1 = UNSUBSCRIBE
serverName URI

The SIP URL of the application server that is providing the service of interest.

This parameter is only required if the dataReference value is set to 13 for the initialFilterCriteria.

callbackUri URI

The Web service URI used to deliver notification back to the subscriber; for example: http://example.com:7676/DHADiameterShNotifyService/services/DiameterShNotifyService

userID String

If the IMS™ Application Server Notify Web service is protected, specify the user ID for that Web service.

password String

If the IMS Application Server Notify Web service is protected, specify the password for that Web service.




Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.