ProxyBranch

The ProxyBranch interface represents a single branch created by a Proxy for sending a SIP request to a specific target. It models the concept of a branch as described in RFC 3261, specifically within the context of stateful proxying. Each ProxyBranch is responsible for handling the unique transaction state associated with the request sent to its target, allowing applications to manage branch-specific behavior such as timeouts or retries. For example, in an application handling an INVITE request, a Proxy can generate multiple ProxyBranch objects, each targeting a different destination. You can customize each branch, such as setting a specific timeout for one branch while assigning a different timeout for another, before starting the proxying operation using the startProxy() method. The ProxyBranch interface is a key component in the SIP Servlet API for managing the branching behavior of SIP proxies.

Methods:

getRequest
SipServletRequest getRequest()
The method retrieves the SIP request associated with a specific ProxyBranch. This method allows access to the original request that is being proxied or will be proxied through this branch. It provides the application with details about the SIP message for inspection, modification, or logging purposes.
Returns:
An object representing the SIP request associated with the branch.