The RemoveHeadersFromOutgoingMessages feature performs removal of headers from outgoing messages based on configuration.

Behavior

The RemoveHeadersFromOutgoingMessages works as follows:

  • For any SIP message present on a leg’s SipMessageQueue any header matching an entry in the HeadersToRemoveFromOutgoingMessages configuration will be removed.

  • For any SIP message present on a leg’s SipMessageQueue any Supported header value matching an entry in the SupportedHeaderValuesToToRemoveFromOutgoingMessages configuration will be removed.

Note

In order to capture all outgoing SIP messages this feature should be the last feature to run in all Post System Feature execution points.

If configured this feature will modify the content of any outgoing message with a matching header or Supported header value at the time of execution. Changing the features position within feature scripts may have side affects for subsequent features.

See Sentinel SIP Feature Execution Points for more information.

Details

Feature script name

RemoveHeadersFromOutgoingMessages

Applicable contexts

SIP service

SAS Support

No

Prerequisite features

none

Feature execution points
Pre

none

Post

SipAccess_SubscriberCheck SipAccess_PartyRequest SipAccess_PartyResponse SipAccess_ServiceTimer SipAccess_ChargingReauth SipAccess_ChargingAbort SipAccess_CreditAllocatedPostCC SipAccess_CreditLimitReached SipAccess_CreditControlNotRequiredPostCC SipAccess_OCSFailurePostCC SipMidSession_PartyRequest SipMidSession_PartyResponse SipMidSession_ChargingReauth SipMidSession_ChargingAbort SipMidSession_CreditAllocatedPostCC SipMidSession_CreditLimitReached SipMidSession_CreditControlNotRequiredPostCC SipMidSession_OCSFailurePostCC SubscriptionSubscriberCheck SubscriptionSipRequest SubscriptionSipResponse SipTransaction_SubscriberCheck SipTransaction_Request SipTransaction_Response SipLegEnd SipEndSession

Session state inputs and outputs

Inputs

Name Type Format Description Behaviour if null/invalid

SentinelSelectionKey

com.opencloud.sentinel.common.SentinelSelectionKey

selection key

for example: <platform>::::

For selecting configuration data

Feature responses

Response Reason

featureHasFinished

Feature has finished.

RemoveHeadersFromOutgoingMessages configuration

The configuration for the RemoveHeadersFromOutgoingMessages feature is provisioned in the following table:

Parameter Type Description

HeadersToRemoveFromOutgoingMesssages

String[]

Each entry of the array represents a header e.g Session-Expires that if present will be removed from outbound messages

SupportedHeaderValuesToRemoveFromOutgoingMesssages

String[]

Each entry of the array represents a value e.g timer or preconditions that if present will be removed from the Supported header of outbound messages
Note HeadersToRemoveFromOutgoingMessages can not be configured with the following values Cseq, Via, Rseq, RAck, From and To.

Statistics

Statistic When incremented

RemovedHeaderFromOutboundMessage

A header matching a configured HeadersToRemoveFromOutgongMessages value was removed.

FailedToRemoveHeaderFromOutboundMessage

A header matching a configured HeadersToRemoveFromOutgongMessages value could not be removed.

RemovedSupportedHeaderValueFromOutboundMessage

A Supported header matching a configured SupportedHeaderValuesToRemoveFromOutgongMessages value was removed.

FailedToModifySupportedHeaderOfOutboundMessage

A failure occurred removing a Supported header matching a configured SupportedHeaderValuesToRemoveFromOutgongMessages value.

Started

The feature is invoked.

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 that core.

TimedOut

The feature fails to complete execution within the allowable time frame.

Provisioning interfaces

The feature is provisioned using the Sentinel SIP Service Configuration REST API or web interface.

Previous page Next page
Sentinel Express Version 3.1.0