requestFilter Element

Article
01/20/2015

requestFilter Element

Specifies which requests the server passes to the application.

Syntax

<lc:requestFilter
   methodNames="ALL" | "NONE" | "METHOD_NAME [, METHOD_NAME, ...]"
   registrarGenerated="true" | "false"
   strictRoute="true" | "false"
   domainSupported="true" | "false"
   phoneUri="URI"
/>

Attributes

methodNames

Specifies the type(s) of SIP request methods that are passed to the application. The value can be ALL, NONE, or a comma-separated list of method names as indicated in the following table. The default value is ALL.

Value	Description
ALL	Specifies that all SIP request methods (including custom request methods defined for the SIP application) are passed to the application.
NONE	Specifies that no SIP request methods are passed to the application.
(comma-separated list of method names)	The method name list can include one or more of the following: ACK, BENOTIFY, BYE, INFO, INVITE, MESSAGE, NOTIFY, OPTIONS, OTHER, REFER, REGISTER, SERVICE, SUBSCRIBE. OTHER indicates that custom request methods defined for the SIP application infrastructure should be filtered.

ALL

Specifies that all SIP request methods (including custom request methods defined for the SIP application) are passed to the application.

NONE

Specifies that no SIP request methods are passed to the application.

(comma-separated list of method names)

The method name list can include one or more of the following: ACK, BENOTIFY, BYE, INFO, INVITE, MESSAGE, NOTIFY, OPTIONS, OTHER, REFER, REGISTER, SERVICE, SUBSCRIBE.

OTHER indicates that custom request methods defined for the SIP application infrastructure should be filtered.

Note

NONE and ALL are mutually exclusive with each other, and with the specific method types. They must not be present in any comma-separated list of methods.

registrarGenerated

Specifies whether requests that are generated by the endpoint service are passed to the application. Valid values are true and false. The default value is false.

strictRoute

Specifies whether requests that have a strict (fixed) route are passed to the application (in addition to other requests). Valid values are true and false. The default value is false.

A request is treated as a strict route if one or more of the following conditions is true:

The request URI has the maddr parameter.
The request had a Route header that pointed to the local server when it arrived, meaning that the request already has destination set in the request-uri in compliance with RFC 3261.
The request has one or more Route headers at the time of processing.
A previous application supplied route information by setting the request-uri.

Set strictRoute to true if you want the application to receive all messages. Setting the strictRoute filter to false guarantees that only requests that need routing will be delivered.

Route headers can be deleted by the managed application before proxying.

domainSupported

Specifies whether requests from domains that are supported by the local register are passed to the application. Valid values are true and false. The default value is true.

phoneUri

Indicates that the request is for a phone URI. If present, the server passes the value of the phoneUri attribute to the application.

Child Elements

None.

Parent Element

applicationManifest Element

Remarks

If a request is filtered by the server, then any responses to that request will likewise be filtered. The namespace prefix "lc" in the preceding usage example is the default namespace prefix, but can be replaced with any string value that you assign to your namespace using the xmlns attribute of the applicationManifest element.

Share via

requestFilter Element