Skip navigation links

Oracle Communications Service Broker
Module MBean Java API Reference
Release 6.0

E26174-01


com.convergin.module.imssf.ain02.config
Interface CallHandlingMBean


public interface CallHandlingMBean

Inteface for CallHandlingMBean

Author:
osnat CallHandlingMBean enables you to configure how a call is handled. NOTE: this code is autogenerated by createConfigMbeans.pl. Do not change it.

Method Summary
 java.lang.String getBearerCapability()
          Specifies the value that IM-SSF sets in the bearerCapability field when invoking trigger message towards the SCP.
 java.lang.String getBodyEncodingFormat()
          Specifies the method that the IM-SSF uses to encode IN parameters in the body of a SAL message.
 java.lang.String getDeploymentName()
          return the Module instance name that this MBean configures
 int getDisconnectStatusCode()
          SAL error response for call denied by SCP
 java.lang.String getImssfMediaCapability()
          Specifies whether or not the underlying network supports IP, SRF or MRF.
 java.lang.String getImssfModeOfOperation()
          Specifies the IM-SSF mode of operation.
 java.lang.String getNatureOfNumberOfCalledPartyID()
          Specifies the NatureOfNumber value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP.
 java.lang.String getNatureOfNumberOfCallingPartyID()
          Specifies the NatureOfNumber value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP.
 java.lang.String getNumberingPlanOfCalledPartyID()
          Specifies the 'NumberingPlan value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP.
 java.lang.String getNumberingPlanOfCallingPartyID()
          Specifies the NumberingPlan value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP.
 java.lang.String getScreeningIndicatorOfCallingPartyID()
          Specifies the ScreeningIndicator value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP.
 java.lang.String getSessionCase()
          Specifies how IM-SSF treats sessions that arrive on the southbound interface, from the OE.
 int getTssfDurationInSeconds()
          Specifies the value, in seconds, of the IM-SSF Tssf timer.
 int getTssfUserInteractionDurationInSeconds()
          Specifies the value, in seconds, of the IM-SSF Tssf timer.
 int getUserId()
          Specifies the value that IM-SSF sets in the userID field when invoking trigger message towards the SCP.
 void setBearerCapability(java.lang.String param)
          Specifies the value that IM-SSF sets in the bearerCapability field when invoking trigger message towards the SCP.
 void setBodyEncodingFormat(java.lang.String param)
          Specifies the method that the IM-SSF uses to encode IN parameters in the body of a SAL message.
 void setDisconnectStatusCode(int param)
          SAL error response for call denied by SCP
 void setImssfMediaCapability(java.lang.String param)
          Specifies whether or not the underlying network supports IP, SRF or MRF.
 void setImssfModeOfOperation(java.lang.String param)
          Specifies the IM-SSF mode of operation.
 void setNatureOfNumberOfCalledPartyID(java.lang.String param)
          Specifies the NatureOfNumber value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP.
 void setNatureOfNumberOfCallingPartyID(java.lang.String param)
          Specifies the NatureOfNumber value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP.
 void setNumberingPlanOfCalledPartyID(java.lang.String param)
          Specifies the 'NumberingPlan value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP.
 void setNumberingPlanOfCallingPartyID(java.lang.String param)
          Specifies the NumberingPlan value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP.
 void setScreeningIndicatorOfCallingPartyID(java.lang.String param)
          Specifies the ScreeningIndicator value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP.
 void setSessionCase(java.lang.String param)
          Specifies how IM-SSF treats sessions that arrive on the southbound interface, from the OE.
 void setTssfDurationInSeconds(int param)
          Specifies the value, in seconds, of the IM-SSF Tssf timer.
 void setTssfUserInteractionDurationInSeconds(int param)
          Specifies the value, in seconds, of the IM-SSF Tssf timer.
 void setUserId(int param)
          Specifies the value that IM-SSF sets in the userID field when invoking trigger message towards the SCP.

 

Method Detail

getImssfModeOfOperation

java.lang.String getImssfModeOfOperation()
                                         throws java.io.IOException
Specifies the IM-SSF mode of operation. Possible values: DYNAMIC, BACK_TO_BACK, REDIRECT
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setImssfModeOfOperation

void setImssfModeOfOperation(java.lang.String param)
                             throws java.io.IOException
Specifies the IM-SSF mode of operation. Possible values: DYNAMIC, BACK_TO_BACK, REDIRECT
Parameters:
param -
Throws:
java.io.IOException

getSessionCase

java.lang.String getSessionCase()
                                throws java.io.IOException
Specifies how IM-SSF treats sessions that arrive on the southbound interface, from the OE. Possible values: ORIG, TERM, DYNAMIC
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setSessionCase

void setSessionCase(java.lang.String param)
                    throws java.io.IOException
Specifies how IM-SSF treats sessions that arrive on the southbound interface, from the OE. Possible values: ORIG, TERM, DYNAMIC
Parameters:
param -
Throws:
java.io.IOException

getTssfDurationInSeconds

int getTssfDurationInSeconds()
                             throws java.io.IOException
Specifies the value, in seconds, of the IM-SSF Tssf timer.
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setTssfDurationInSeconds

void setTssfDurationInSeconds(int param)
                              throws java.io.IOException
Specifies the value, in seconds, of the IM-SSF Tssf timer.
Parameters:
param -
Throws:
java.io.IOException

getTssfUserInteractionDurationInSeconds

int getTssfUserInteractionDurationInSeconds()
                                            throws java.io.IOException
Specifies the value, in seconds, of the IM-SSF Tssf timer.
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setTssfUserInteractionDurationInSeconds

void setTssfUserInteractionDurationInSeconds(int param)
                                             throws java.io.IOException
Specifies the value, in seconds, of the IM-SSF Tssf timer.
Parameters:
param -
Throws:
java.io.IOException

getImssfMediaCapability

java.lang.String getImssfMediaCapability()
                                         throws java.io.IOException
Specifies whether or not the underlying network supports IP, SRF or MRF. Possible values: TRUE, FALSE
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setImssfMediaCapability

void setImssfMediaCapability(java.lang.String param)
                             throws java.io.IOException
Specifies whether or not the underlying network supports IP, SRF or MRF. Possible values: TRUE, FALSE
Parameters:
param -
Throws:
java.io.IOException

getBodyEncodingFormat

java.lang.String getBodyEncodingFormat()
                                       throws java.io.IOException
Specifies the method that the IM-SSF uses to encode IN parameters in the body of a SAL message. Possible options: BER; XER; NONE
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setBodyEncodingFormat

void setBodyEncodingFormat(java.lang.String param)
                           throws java.io.IOException
Specifies the method that the IM-SSF uses to encode IN parameters in the body of a SAL message. Possible options: BER; XER; NONE
Parameters:
param -
Throws:
java.io.IOException

getNatureOfNumberOfCalledPartyID

java.lang.String getNatureOfNumberOfCalledPartyID()
                                                  throws java.io.IOException
Specifies the NatureOfNumber value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP. Trigger messages: Origination_Attempt; Info_ Collected; Info_Analyze; Termination_Attempt
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setNatureOfNumberOfCalledPartyID

void setNatureOfNumberOfCalledPartyID(java.lang.String param)
                                      throws java.io.IOException
Specifies the NatureOfNumber value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP. Trigger messages: Origination_Attempt; Info_ Collected; Info_Analyze; Termination_Attempt
Parameters:
param -
Throws:
java.io.IOException

getNumberingPlanOfCalledPartyID

java.lang.String getNumberingPlanOfCalledPartyID()
                                                 throws java.io.IOException
Specifies the 'NumberingPlan value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP. Trigger messages: Origination_Attempt; Info_ Collected; Info_Analyze; Termination_Attempt
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setNumberingPlanOfCalledPartyID

void setNumberingPlanOfCalledPartyID(java.lang.String param)
                                     throws java.io.IOException
Specifies the 'NumberingPlan value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP. Trigger messages: Origination_Attempt; Info_ Collected; Info_Analyze; Termination_Attempt
Parameters:
param -
Throws:
java.io.IOException

getNatureOfNumberOfCallingPartyID

java.lang.String getNatureOfNumberOfCallingPartyID()
                                                   throws java.io.IOException
Specifies the NatureOfNumber value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setNatureOfNumberOfCallingPartyID

void setNatureOfNumberOfCallingPartyID(java.lang.String param)
                                       throws java.io.IOException
Specifies the NatureOfNumber value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
param -
Throws:
java.io.IOException

getNumberingPlanOfCallingPartyID

java.lang.String getNumberingPlanOfCallingPartyID()
                                                  throws java.io.IOException
Specifies the NumberingPlan value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setNumberingPlanOfCallingPartyID

void setNumberingPlanOfCallingPartyID(java.lang.String param)
                                      throws java.io.IOException
Specifies the NumberingPlan value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
param -
Throws:
java.io.IOException

getScreeningIndicatorOfCallingPartyID

java.lang.String getScreeningIndicatorOfCallingPartyID()
                                                       throws java.io.IOException
Specifies the ScreeningIndicator value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setScreeningIndicatorOfCallingPartyID

void setScreeningIndicatorOfCallingPartyID(java.lang.String param)
                                           throws java.io.IOException
Specifies the ScreeningIndicator value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
param -
Throws:
java.io.IOException

getUserId

int getUserId()
              throws java.io.IOException
Specifies the value that IM-SSF sets in the userID field when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setUserId

void setUserId(int param)
               throws java.io.IOException
Specifies the value that IM-SSF sets in the userID field when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
param -
Throws:
java.io.IOException

getDisconnectStatusCode

int getDisconnectStatusCode()
                            throws java.io.IOException
SAL error response for call denied by SCP
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setDisconnectStatusCode

void setDisconnectStatusCode(int param)
                             throws java.io.IOException
SAL error response for call denied by SCP
Parameters:
param -
Throws:
java.io.IOException

getBearerCapability

java.lang.String getBearerCapability()
                                     throws java.io.IOException
Specifies the value that IM-SSF sets in the bearerCapability field when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setBearerCapability

void setBearerCapability(java.lang.String param)
                         throws java.io.IOException
Specifies the value that IM-SSF sets in the bearerCapability field when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt, Info_Collected, Info_Analyze and Termination_Attempt
Parameters:
param -
Throws:
java.io.IOException

getDeploymentName

java.lang.String getDeploymentName()
return the Module instance name that this MBean configures
Returns:
String

Skip navigation links

Oracle Communications Service Broker
Module MBean Java API Reference
Release 6.0

E26174-01


Copyright © 2011, Oracle and/or its affiliates. All rights reserved.