The ExtractPublicAndPrivateIdentities
feature analyses the 1st party REGISTER request and response and stores public and private indentities in session state.
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 |
ExtractPublicAndPrivateIdentities |
---|---|
Applicable contexts |
SIP service |
SAS Support |
No |
Prerequisite features |
ExtractEncapsulatedRegisterRequestAndResponse |
Feature execution points |
|
Session state inputs and outputs
Inputs
Name | Format | Description |
---|---|---|
SentinelSelectionKey
|
selection key |
For selecting a mapper that maps 1st party REGISTER and response to public and private ids in session state fields. |
EncapsulatedRegisterRequest
|
The 1st party REGISTER request |
|
EncapsulatedRegisterResponse
|
The 1st party REGISTER response |
Outputs
Name | Format | Description |
---|---|---|
CallId |
The value of the |
The call id of the 1st party REGISTER request |
PrivateId
|
The username parameter of the |
The private id of the subscriber, taken from the 1st party REGISTER request |
PublicIds
|
The value of a |
Public ids of the subscriber, taken from |
RegisteredContact
|
Array of Strings, where each element is value of one |
All the |
RegisteredContactUris
|
Array of Strings, where each element is |
The |
PubGruu
|
A SIP URI, as a String |
The public GRUU (Globally Routable User Agent) from the first |
TempGruu
|
A SIP URI, as a String |
The temporary GRUU (Globally Routable User Agent) from the first |
RejectRegisterRequest
|
Set to true if the third party REGISTER request should be rejected. |
|
RegistrationDeviceId
|
The ID that uniquely identifies the device associated with the activation session.
The value is derived based on the Registrar Configuration Table property |
Feature responses
Response | Reason |
---|---|
featureHasFinished |
Feature has finished. |
featureFailedToExecute |
Feature encountered a fatal error and was unable to continue. |
Statistics
Statistic | When incremented |
---|---|
MappingFailureExtractingSubscriberIds |
There was a failure whilst extracting ids from the 1st party register request and response. |
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. |