Package org.jainslee.resources.diameter.sh.v940

Interface ShProvider

All Superinterfaces:

ShProviderFactory

public interface ShProvider
extends ShProviderFactory

The ShProvider is used by a Diameter Sh Client (e.g., an AS) in an IMS network to create and send requests to a Diameter Sh Server (e.g., an HSS). The ShProvider can be used by a SLEE service to provide HSS functions on an IMS network.

Author:

Open Cloud

Method Summary

Modifier and Type	Method	Description
ShClientActivity	createShClientActivity()	Create a new Sh client activity to send and receive Diameter Sh messages.
ShClientSubscriptionActivity	createShClientSubscriptionActivity()	Create a new Sh client activity to send and receive Diameter Sh messages related to subscriptions.
ShServerNotificationActivity	createShServerNotificationActivity()	Create a new Sh server activity to send and receive Diameter Sh messages.
ShMessageFactory	getMessageFactory()	Get access to the Sh Diameter message factory.
ProfileUpdateAnswer	profileUpdateRequest(ProfileUpdateRequest message)	Sends a synchronous ProfileUpdateRequest which will block until an answer is received from the peer.
PushNotificationAnswer	pushNotificationRequest(PushNotificationRequest message)	Sends a synchronous PushNotificationRequest which will block until an answer is received from the peer.
SubscribeNotificationsAnswer	subscribeNotificationsRequest(SubscribeNotificationsRequest message)	Sends a synchronous SubscribeNotificationsRequest which will block until an answer is received from the peer.
UserDataAnswer	userDataRequest(UserDataRequest message)	Sends a synchronous UserDataRequest which will block until an answer is received from the peer.

Methods inherited from interface org.jainslee.resources.diameter.sh.ShProviderFactory

getConfiguredTGPPVersion, getShProviderV780, getShProviderV880, getShProviderV940, getShProviderVa10, getShProviderVb60, getShProviderVc60

Method Detail

getMessageFactory

ShMessageFactory getMessageFactory()

Get access to the Sh Diameter message factory.

Returns:

message factory for Sh Diameter

createShClientActivity

ShClientActivity createShClientActivity()
                                 throws CreateActivityException

Create a new Sh client activity to send and receive Diameter Sh messages.

Returns:

an ShClientActivity

Throws:

CreateActivityException - if the RA could not create the activity for any reason

createShClientSubscriptionActivity

ShClientSubscriptionActivity createShClientSubscriptionActivity()
                                                         throws CreateActivityException

Create a new Sh client activity to send and receive Diameter Sh messages related to subscriptions.

Returns:

an ShClientSubscriptionActivity

Throws:

CreateActivityException - if the RA could not create the activity for any reason

userDataRequest

UserDataAnswer userDataRequest(UserDataRequest message)
                        throws SendException

Sends a synchronous UserDataRequest which will block until an answer is received from the peer.

See the note regarding synchronous requests in the org.jainslee.resources.diameter.sh package docs.

Parameters:

message - created using the MessageFactory

Returns:

answer received from HSS

Throws:

SendException - if there was a problem sending the request

profileUpdateRequest

ProfileUpdateAnswer profileUpdateRequest(ProfileUpdateRequest message)
                                  throws SendException

Sends a synchronous ProfileUpdateRequest which will block until an answer is received from the peer.

See the note regarding synchronous requests in the org.jainslee.resources.diameter.sh package docs.

Parameters:

message - created using the MessageFactory

Returns:

answer received from HSS

Throws:

SendException - if there was a problem sending the request

subscribeNotificationsRequest

SubscribeNotificationsAnswer subscribeNotificationsRequest(SubscribeNotificationsRequest message)
                                                    throws SendException

Sends a synchronous SubscribeNotificationsRequest which will block until an answer is received from the peer.

See the note regarding synchronous requests in the org.jainslee.resources.diameter.sh package docs.

Parameters:

message - created using the MessageFactory

Returns:

answer received from HSS

Throws:

SendException - if there was a problem sending the request

createShServerNotificationActivity

ShServerNotificationActivity createShServerNotificationActivity()
                                                         throws CreateActivityException

Create a new Sh server activity to send and receive Diameter Sh messages.

Returns:

an ShServerNotificationActivity

Throws:

CreateActivityException - if the RA could not create the activity for any reason

pushNotificationRequest

PushNotificationAnswer pushNotificationRequest(PushNotificationRequest message)
                                        throws SendException

Sends a synchronous PushNotificationRequest which will block until an answer is received from the peer.

See the note regarding synchronous requests in the org.jainslee.resources.diameter.sh package docs.

Parameters:

message - a PushNotificationRequest created by the ServerMessageFactory

Returns:

Push-Notification-Answer message from AS

Throws:

SendException - if there is an error sending the message