Package org.jainslee.resources.diameter.sh.va10

Interface ShMessageFactory

  • All Superinterfaces:
    MessageFactory
    public interface ShMessageFactory
extends MessageFactory
    The Sh Message Factory used to create Diameter Sh messages.

    • Method Detail

      • createUserDataRequest

        UserDataRequest createUserDataRequest​(UserIdentity userIdentity,
                                      DataReference reference)
        Create a UserDataRequest using the given parameters to populate the User-Identity and Data-Reference AVPs.
        Returns:
        a UserDataRequest object that can be sent using {@link ShClientActivity\#sendUserDataRequest(org.jainslee.resources.diameter.sh.types.va10.UserDataRequest)}

      • createUserDataRequest

        UserDataRequest createUserDataRequest()
        Create an empty UserDataRequest that will need to have AVPs set on it before being sent.
        Returns:
        a UserDataRequest object that can be sent using {@link ShClientActivity\#sendUserDataRequest(org.jainslee.resources.diameter.sh.types.va10.UserDataRequest)}

      • createProfileUpdateRequest

        ProfileUpdateRequest createProfileUpdateRequest​(UserIdentity userIdentity,
                                                DataReference reference,
                                                UserData userData)
        Create a ProfileUpdateRequest using the given parameters to populate the User-Identity, Data-Reference and User-Data AVPs.
        Returns:
        a ProfileUpdateRequest object that can be sent using {@link ShClientActivity\#sendProfileUpdateRequest(org.jainslee.resources.diameter.sh.types.va10.ProfileUpdateRequest)}

      • createProfileUpdateRequest

        ProfileUpdateRequest createProfileUpdateRequest()
        Create an empty ProfileUpdateRequest that will need to have AVPs set on it before being sent.
        Returns:
        a ProfileUpdateRequest object that can be sent using {@link ShClientActivity\#sendProfileUpdateRequest(org.jainslee.resources.diameter.sh.types.va10.ProfileUpdateRequest)}

      • createSubscribeNotificationsRequest

        SubscribeNotificationsRequest createSubscribeNotificationsRequest​(UserIdentity userIdentity,
                                                                  DataReference reference,
                                                                  SubsReqType subscriptionType)
        Create a SubscribeNotificationsRequest using the given parameters to populate the User-Identity, Data-Reference and Subs-Req-Type AVPs.
        Returns:
        a SubscribeNotificationsRequest object that can be sent using {@link ShClientActivity\#sendSubscribeNotificationsRequest(org.jainslee.resources.diameter.sh.types.va10.SubscribeNotificationsRequest)} or {@link ShClientSubscriptionActivity\#sendSubscribeNotificationsRequest(org.jainslee.resources.diameter.sh.types.va10.SubscribeNotificationsRequest)}

      • createSubscribeNotificationsRequest

        SubscribeNotificationsRequest createSubscribeNotificationsRequest()
        Create an empty SubscribeNotificationsRequest that will need to have AVPs set on it before being sent.
        Returns:
        a SubscribeNotificationsRequest object that can be sent using {@link ShClientActivity\#sendSubscribeNotificationsRequest(org.jainslee.resources.diameter.sh.types.va10.SubscribeNotificationsRequest)} or {@link ShClientSubscriptionActivity\#sendSubscribeNotificationsRequest(org.jainslee.resources.diameter.sh.types.va10.SubscribeNotificationsRequest)}

      • createPushNotificationAnswer

        PushNotificationAnswer createPushNotificationAnswer​(long resultCode,
                                                    boolean isExperimentalResultCode)
        Create a PushNotificationAnswer containing a Result-Code or Experimental-Result AVP populated with the given value. If isExperimentalResultCode is true, the resultCode parameter will be set in a ExperimentalResult AVP, if it is false it will be sent as a standard Result-Code AVP.
        Returns:
        a PushNotificationAnswer object that can be sent using {@link ShClientNotificationActivity\#sendPushNotificationAnswer(org.jainslee.resources.diameter.sh.types.va10.PushNotificationAnswer)}

      • createPushNotificationAnswer

        PushNotificationAnswer createPushNotificationAnswer()
        Create an empty PushNotificationAnswer that will need to have AVPs set on it before being sent.
        Returns:
        a PushNotificationAnswer object that can be sent using {@link ShClientNotificationActivity\#sendPushNotificationAnswer(org.jainslee.resources.diameter.sh.types.va10.PushNotificationAnswer)}

      • createUserDataAnswer

        UserDataAnswer createUserDataAnswer​(UserData userData)
        Create a UserDataAnswer using the given parameter to populate the User-Data AVP. The Result-Code AVP is automatically set to DiameterResultCode.DIAMETER_SUCCESS.
        Returns:
        a UserDataAnswer object that can be sent using {@link ShServerActivity\#sendUserDataAnswer(org.jainslee.resources.diameter.sh.types.va10.UserDataAnswer)}

      • createUserDataAnswer

        UserDataAnswer createUserDataAnswer​(long resultCode,
                                    boolean isExperimentalResult)
        Create a UserDataAnswer containing a Result-Code or Experimental-Result AVP populated with the given value. If isExperimentalResultCode is true, the resultCode parameter will be set in a ExperimentalResult AVP, if it is false the result code will be set in a Result-Code AVP.
        Returns:
        a UserDataAnswer object that can be sent using {@link ShServerActivity\#sendUserDataAnswer(org.jainslee.resources.diameter.sh.types.va10.UserDataAnswer)}

      • createUserDataAnswer

        UserDataAnswer createUserDataAnswer()
        Create an empty UserDataAnswer that will need to have AVPs set on it before being sent.
        Returns:
        a UserDataAnswer object that can be sent using {@link ShServerActivity\#sendUserDataAnswer(org.jainslee.resources.diameter.sh.types.va10.UserDataAnswer)}

      • createProfileUpdateAnswer

        ProfileUpdateAnswer createProfileUpdateAnswer​(long resultCode,
                                              boolean isExperimentalResult)
        Create a ProfileUpdateAnswer containing a Result-Code or Experimental-Result AVP populated with the given value. If isExperimentalResultCode is true, the resultCode parameter will be set in a ExperimentalResult AVP, if it is false the result code will be set in a Result-Code AVP.
        Returns:
        a ProfileUpdateAnswer object that can be sent using {@link ShServerActivity\#sendProfileUpdateAnswer(org.jainslee.resources.diameter.sh.types.va10.ProfileUpdateAnswer)}

      • createProfileUpdateAnswer

        ProfileUpdateAnswer createProfileUpdateAnswer()
        Create an empty ProfileUpdateAnswer that will need to have AVPs set on it before being sent.
        Returns:
        a ProfileUpdateAnswer object that can be sent using {@link ShServerActivity\#sendProfileUpdateAnswer(org.jainslee.resources.diameter.sh.types.va10.ProfileUpdateAnswer)}

      • createSubscribeNotificationsAnswer

        SubscribeNotificationsAnswer createSubscribeNotificationsAnswer​(long resultCode,
                                                                boolean isExperimentalResult)
        Create a SubscribeNotificationsAnswer containing a Result-Code or Experimental-Result AVP populated with the given value. If isExperimentalResultCode is true, the resultCode parameter will be set in a ExperimentalResult AVP, if it is false the result code will be set in a Result-Code AVP.
        Returns:
        a SubscribeNotificationsAnswer object that can be sent using {@link ShServerActivity\#sendSubscribeNotificationsAnswer(org.jainslee.resources.diameter.sh.types.va10.SubscribeNotificationsAnswer)}

      • createSubscribeNotificationsAnswer

        SubscribeNotificationsAnswer createSubscribeNotificationsAnswer()
        Create an empty SubscribeNotificationsAnswer that will need to have AVPs set on it before being sent.
        Returns:
        a SubscribeNotificationsAnswer object that can be sent using {@link ShServerActivity\#sendSubscribeNotificationsAnswer(org.jainslee.resources.diameter.sh.types.va10.SubscribeNotificationsAnswer)}

      • createPushNotificationRequest

        PushNotificationRequest createPushNotificationRequest​(UserIdentity userIdentity,
                                                      UserData userData)
        Create a UserDataAnswer using the given parameters to populate the User-Identity and User-Data AVPs.
        Returns:
        a PushNotificationRequest object that can be sent using {@link ShServerNotificationActivity\#sendPushNotificationRequest(org.jainslee.resources.diameter.sh.types.va10.PushNotificationRequest)}

      • createPushNotificationRequest

        PushNotificationRequest createPushNotificationRequest()
        Create an empty PushNotificationRequest.
        Returns:
        a PushNotificationRequest object that can be sent using {@link ShServerNotificationActivity\#sendPushNotificationRequest(org.jainslee.resources.diameter.sh.types.va10.PushNotificationRequest)}