Interface ShServerActivity


  • public interface ShServerActivity
    Activity used by a Diameter Sh Server. The following request messages can be fired as events:
    • UserDataRequest
    • ProfileUpdateRequest
    • SubscribeNotificationsRequest

    The following answers can be sent:

    • UserDataAnswer
    • ProfileUpdateAnswer
    • SubscribeNotificationsAnswer
    These are stateless requests so the activity ends when the answer is sent.
    Author:
    Open Cloud
    • Method Detail

      • getMessageFactory

        ShMessageFactory getMessageFactory()
        Get a message factory to create answer messages and AVPs (if necessary).
      • 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)}
      • endActivity

        void endActivity()
        End this activity. This does not cause any messages to be sent, it simply ends the activity in the SLEE.