Package com.opencloud.sentinel.common

Class EtcAriCorrelationHelper

  • public class EtcAriCorrelationHelper
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      EtcAriCorrelationHelper​(com.opencloud.slee.resources.correlation.CorrelationProvider provider, com.opencloud.rhino.facilities.ExtendedTracer tracer)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getConvergenceNameForCorrelationID​(java.lang.String correlationId)
      Get the Convergence Name associated with the SBB entity that sent the ETC that corresponds to the received ARI.
      javax.slee.InitialEventSelector initialEventSelector​(javax.slee.InitialEventSelector ies, com.opencloud.slee.resources.cgin.DialogOpenRequestEvent openRequest)
      A IES helper method for dialogs with one of an CCInitialDPRequestEvent or CCAssistRequestInstructionsRequestEvent component.
      javax.slee.InitialEventSelector initialEventSelectorForARI​(javax.slee.InitialEventSelector ies, com.opencloud.slee.resources.cgin.DialogOpenRequestEvent openRequest)
      A IES helper method for correlating CCAssistRequestInstructionsRequestEvent dialogs with the service which sent the CCEstablishTemporaryConnectionRequestEvent If there is no CCAssistRequestInstructionsRequestEvent component event, the IES will not be changed.
      javax.slee.InitialEventSelector initialEventSelectorForIDP​(javax.slee.InitialEventSelector ies, com.opencloud.slee.resources.cgin.DialogOpenRequestEvent openRequest)
      A IES helper method for dialogs with CCInitialDPRequestEvent events used to set a custom convergence which is used for correlation with subsequent CCAssistRequestInstructionsRequestEvent requests on assisting dialogs.
      java.lang.String newCorrelationID​(com.opencloud.slee.resources.cgin.callcontrol.CCDialog dialog)
      It ask for a new CorrelationId value to be used in a ETC operation that won't be used in another session until the corresponding ARI will be received.
      void releaseCorrelationId​(java.lang.String correlationID)
      It frees the previously reserved correlationId in order it could be used in another call.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • EtcAriCorrelationHelper

        public EtcAriCorrelationHelper​(com.opencloud.slee.resources.correlation.CorrelationProvider provider,
                               com.opencloud.rhino.facilities.ExtendedTracer tracer)

    • Method Detail

      • newCorrelationID

        public java.lang.String newCorrelationID​(com.opencloud.slee.resources.cgin.callcontrol.CCDialog dialog)
                                  throws com.opencloud.slee.resources.correlation.exceptions.NoAvailableEntriesException,
                                         java.lang.IllegalArgumentException
        It ask for a new CorrelationId value to be used in a ETC operation that won't be used in another session until the corresponding ARI will be received.
        Parameters:
        dialog - CCDialog
        Returns:
        a new correlationID that is not being used in any other session
        Throws:
        NoAvailableEntries - all possible CorrelationIds are being used so no more ETC messages could be managed at this moment
        java.lang.IllegalArgumentException - if dialog is null
        com.opencloud.slee.resources.correlation.exceptions.NoAvailableEntriesException

      • getConvergenceNameForCorrelationID

        public java.lang.String getConvergenceNameForCorrelationID​(java.lang.String correlationId)
                                                    throws com.opencloud.slee.resources.correlation.exceptions.NoAvailableEntriesException,
                                                           com.opencloud.slee.resources.correlation.exceptions.CorrelationRequestException
        Get the Convergence Name associated with the SBB entity that sent the ETC that corresponds to the received ARI. The convergence name is used by in an IES method so the ARI will be processed by the same SB entity that sent the ETC.
        Parameters:
        correlationId - the correlationID received in the ARI
        Returns:
        the custom convergence name used in the corresponding ETC
        Throws:
        com.opencloud.slee.resources.correlation.exceptions.CorrelationRequestException
        NoAvailableEntries - the requested Correlation Id wasn't used by any registered ETC message.
        com.opencloud.slee.resources.correlation.exceptions.NoAvailableEntriesException

      • releaseCorrelationId

        public void releaseCorrelationId​(java.lang.String correlationID)
        It frees the previously reserved correlationId in order it could be used in another call.
        Parameters:
        correlationID - the correlationID received in the ARI

      • initialEventSelector

        public javax.slee.InitialEventSelector initialEventSelector​(javax.slee.InitialEventSelector ies,
                                                            com.opencloud.slee.resources.cgin.DialogOpenRequestEvent openRequest)
        A IES helper method for dialogs with one of an CCInitialDPRequestEvent or CCAssistRequestInstructionsRequestEvent component. event in the DialogOpenRequestEvent.
        Parameters:
        ies - InitialEventSelector
        openRequest - DialogOpenRequestEvent
        Returns:
        InitialEventSelector

      • initialEventSelectorForIDP

        public javax.slee.InitialEventSelector initialEventSelectorForIDP​(javax.slee.InitialEventSelector ies,
                                                                  com.opencloud.slee.resources.cgin.DialogOpenRequestEvent openRequest)
        A IES helper method for dialogs with CCInitialDPRequestEvent events used to set a custom convergence which is used for correlation with subsequent CCAssistRequestInstructionsRequestEvent requests on assisting dialogs. If there is no CCInitialDPRequestEvent component event, the IES will not be changed.
        Parameters:
        ies - InitialEventSelector
        openRequest - DialogOpenRequestEvent
        Returns:
        InitialEventSelector

      • initialEventSelectorForARI

        public javax.slee.InitialEventSelector initialEventSelectorForARI​(javax.slee.InitialEventSelector ies,
                                                                  com.opencloud.slee.resources.cgin.DialogOpenRequestEvent openRequest)
        A IES helper method for correlating CCAssistRequestInstructionsRequestEvent dialogs with the service which sent the CCEstablishTemporaryConnectionRequestEvent If there is no CCAssistRequestInstructionsRequestEvent component event, the IES will not be changed.
        Parameters:
        ies - InitialEventSelector
        openRequest - DialogOpenRequestEvent
        Returns:
        InitialEventSelector