The ExtractEncapsulatedRegisterRequestAndResponse feature parses the body of the triggering third party REGISTER request and extracts the 1st party REGISTER and response. These messages are stored as Java objects in session state fields.

Note

This feature is a critical system feature. The Registrar cannot function without this feature executing successfully.

See Sentinel SIP Feature Execution Points for more about running critical features.

Details

Feature script name

ExtractEncapsulatedRegisterRequestAndResponse

Applicable contexts

SIP service

Prerequisite features

RegistrarDetermineNetworkOperator or PlatformOperatorIsNetworkOperator

Feature execution points
Pre

SipRegistration_NetworkCheck

Session state inputs and outputs

Inputs

Name Format Description

SentinelSelectionKey com.opencloud.sentinel.common.SentinelSelectionKey

selection key
for example, <platform_operator>::::

For selecting a mapper that maps third party REGISTER request to session state fields

Outputs

Name Format Description

RouteHeaderMode com.opencloud.sentinel.state.RouteHeaderMode

One of: not_present (no mode parameter in the route header), mmtel (mmtel scenario), scc (scc scenario) or mmtel_scc (mixed, mmtel and scc scenario)

EncapsulatedRegisterRequest javax.sip.message.Request

A Request Java object

The 1st party REGISTER request

EncapsulatedRegisterResponse javax.sip.message.Response

A Response Java object

The 1st party REGISTER response

RejectRegisterRequest boolean

Set to true if the third party REGISTER request should be rejected.

Feature responses

Response Reason

featureHasFinished

Feature has finished.

featureFailedToExecute

Feature encountered a fatal error and was unable to continue.

Statistics

Statistic When incremented

MappingFailureExtractingRegisterRequestAndResponse

There was a failure whilst parsing the 1st party REGISTER and response from the body of the third party REGISTER

FailedToStart

The feature fails to start.

IssuedWarning

The feature encounters a non-fatal error and alerts the core.

FailedDuringExecution

The feature encounters any fatal error and alerts the core.

TimedOut

The feature fails to complete execution within the allowable time frame.
Previous page Next page
Sentinel Express Version 2.7.0