WebSphere brand IBM WebSphere IP Multimedia Subsystem Connector, Version 6.2

getInitialFilterCriteria Web service method

This Web service method 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 IMS™ Application Server to provide a service.

Usage

Filter criteria are used to determine the services that will be provided to the collection of Public User Identities listed in each user's user_profile. Filter criteria contains a collection of user-related information that helps the S-CSCF decide when to involve a particular IMS Application Server to provide a service. For example: the InitialFilterCriteria object contains a collection of user information that helps the S-CSCF decide when to forward the SIP request to a particular application server.

This Web service method returns an array of InitialFilterCriteria objects that adhere to the InitialFilterCriteria schema defined in the ShDataType.xsd. Multiple filter criteria may be returned from the HSS.

Example

InitialFilterCriteria[] initialFilterCriteria = service.getInitialFilterCriteria( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10.city.company.com", "realmA.mycompany.com", "sips:carol@ws1234.domain2.com", "sip:siphappens.domain.com" );

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.

publicIdentity String
Specifies the public user identity or public service identity. This can be either a SIP URL or a TEL URL. 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
serverName URI

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




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