|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DiameterShService_SEI
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 |
---|
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
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.
java.lang.Exception
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
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:
java.lang.Exception
int getIMSUserState(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicUserIdentity) throws java.lang.Exception
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).
java.lang.Exception
java.net.URI getSCSCFName(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity) throws java.lang.Exception
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).
java.lang.Exception
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
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.
java.lang.Exception
CSLocationInformation getCSLocationInformation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String msisdn) throws java.lang.Exception
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.
java.lang.Exception
PSLocationInformation getPSLocationInformation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String msisdn) throws java.lang.Exception
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.
java.lang.Exception
int getCSUserState(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String msisdn) throws java.lang.Exception
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.
java.lang.Exception
int getPSUserState(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String msisdn) throws java.lang.Exception
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.
java.lang.Exception
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
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.
java.lang.Exception
int getPSIActivation(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicIdentity) throws java.lang.Exception
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).
java.lang.Exception
java.lang.String[] getMSISDN(java.lang.String sessionId, java.lang.String destinationHost, java.lang.String destinationRealm, java.lang.String publicUserIdentity) throws java.lang.Exception
getMSISDNList
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).
java.lang.Exception
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
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.
java.lang.Exception
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
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:
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.
requestedDomain
- Indicates either a CS or PS domain.
This parameter is required only if dataReference value is 14 or 15.
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.
java.lang.Exception
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
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.
java.lang.Exception
ResultCodes
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
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
java.lang.Exception
ResultCodes
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
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 identityactivation
- Specifies if the Public service identity is to be activated or
inactivated.
java.lang.Exception
ResultCodes
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
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:
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 ignoredpassword
- Password used to access the Sh Applications Client's
Web service. If this is null, this and the userid are ignored.
java.lang.Exception
ResultCodes
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
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:
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 ignoredpassword
- Password used to access the Sh Applications Client's
Web service. If this is null, this and the userid are ignored.
java.lang.Exception
ResultCodes
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
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:
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 ignoredpassword
- Password used to access the Sh Applications Client's
Web service. If this is null, this and the userid are ignored.
java.lang.Exception
ResultCodes
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
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:
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 ignoredpassword
- Password used to access the Sh Applications Client's
Web service. If this is null, this and the userid are ignored.
java.lang.Exception
ResultCodes
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
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:
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 ignoredpassword
- Password used to access the Sh Applications Client's
Web service. If this is null, this and the userid are ignored.
java.lang.Exception
ResultCodes
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
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:
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:
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 ignoredpassword
- Password used to access the Sh Applications Client's
Web service. If this is null, this and the userid are ignored.
java.lang.Exception
ResultCodes
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |