Package com.opencloud.sentinel.common

Enum InviteReplicationTrigger

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<InviteReplicationTrigger>
    public enum InviteReplicationTrigger
extends java.lang.Enum<InviteReplicationTrigger>
    Indicates the point at which a call leg should trigger the start of session replication. Values have a sequential order and triggers that occur earlier in the call will also be triggered by events that have associated triggers later in the call (e.g. is a leg is configured to trigger on PROVISIONAL_RESPONSE, but the first response is a 200 success response, the PROVISIONAL_RESPONSE value will still trigger replication to be enabled).

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACK
      Indicates that session replication should be initiated when an ACK request for a success (2xx) response for the original INVITE request is seen on the leg.
      DISABLED
      Indicates that session replication should never be initiated by the leg.
      INITIAL_REQUEST
      Indicates that session replication should be initiated as soon as an initial INVITE request is seen on the leg.
      NOOP
      Indicates that session replication decision shall not be made by this leg.
      PROVISIONAL_RESPONSE
      Indicates that session replication should be initiated when a dialog creating provisional (18x) response for the original INVITE request is seen on the leg.
      RINGING_RESPONSE
      Indicates that session replication should be initiated when a ringing (180) response for the original INVITE request is seen on the leg.
      SUCCESS_RESPONSE
      Indicates that session replication should be initiated when a success (2xx) response for the original INVITE request is seen on the leg.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean occursBefore​(InviteReplicationTrigger otherTrigger)
      Indicates whether this trigger occurs earlier in the call sequence than the given trigger.
      static InviteReplicationTrigger valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static InviteReplicationTrigger[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DISABLED

        public static final InviteReplicationTrigger DISABLED
        Indicates that session replication should never be initiated by the leg.

      • NOOP

        public static final InviteReplicationTrigger NOOP
        Indicates that session replication decision shall not be made by this leg.

      • INITIAL_REQUEST

        public static final InviteReplicationTrigger INITIAL_REQUEST
        Indicates that session replication should be initiated as soon as an initial INVITE request is seen on the leg.

      • PROVISIONAL_RESPONSE

        public static final InviteReplicationTrigger PROVISIONAL_RESPONSE
        Indicates that session replication should be initiated when a dialog creating provisional (18x) response for the original INVITE request is seen on the leg.

      • RINGING_RESPONSE

        public static final InviteReplicationTrigger RINGING_RESPONSE
        Indicates that session replication should be initiated when a ringing (180) response for the original INVITE request is seen on the leg.

      • SUCCESS_RESPONSE

        public static final InviteReplicationTrigger SUCCESS_RESPONSE
        Indicates that session replication should be initiated when a success (2xx) response for the original INVITE request is seen on the leg.

      • ACK

        public static final InviteReplicationTrigger ACK
        Indicates that session replication should be initiated when an ACK request for a success (2xx) response for the original INVITE request is seen on the leg.

    • Method Detail

      • values

        public static InviteReplicationTrigger[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (InviteReplicationTrigger c : InviteReplicationTrigger.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static InviteReplicationTrigger valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • occursBefore

        public boolean occursBefore​(InviteReplicationTrigger otherTrigger)
        Indicates whether this trigger occurs earlier in the call sequence than the given trigger. The sequence is: INITIAL_REQUEST, PROVISIONAL_RESPONSE, RINGING_RESPONSE, SUCCESS_RESPONSE, ACK Note that a 180 Ringing response will set off both PROVISIONAL_RESPONSE and RINGING_RESPONSE triggers.
        Parameters:
        otherTrigger - the trigger value to compare this value to
        Returns:
        true if this trigger occurs before the given trigger in the call sequence.