ProxyBranchImpl (Sip Servlets Implementation 3.0.549 API)

java.lang.Object
- org.mobicents.servlet.sip.proxy.ProxyBranchImpl

All Implemented Interfaces:

Externalizable, Serializable, ProxyBranch, ProxyBranchExt, MobicentsProxyBranch
```
public class ProxyBranchImpl
extends Object
implements MobicentsProxyBranch, Externalizable
```
Author:

jean.deruelle@telestax.com, vralev@gmail.com

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProxyBranchImpl.TransactionRequest

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProxyBranchImpl.TransactionRequest`

Field Summary

Fields
Modifier and Type Field and Description

List<ProxyBranchImpl.TransactionRequest> ongoingTransactions

javax.sip.header.ViaHeader viaHeader

Fields
Modifier and Type	Field and Description
`List<ProxyBranchImpl.TransactionRequest>`	`ongoingTransactions`
`javax.sip.header.ViaHeader`	`viaHeader`

Constructor Summary

Constructors
Constructor and Description

ProxyBranchImpl()

ProxyBranchImpl(URI uri, ProxyImpl proxy)

Constructors
Constructor and Description
`ProxyBranchImpl()`
`ProxyBranchImpl(URI uri, ProxyImpl proxy)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRecursedBranch(ProxyBranchImpl branch)`
`void`	`addTransaction(SipServletRequestImpl request)`
`void`	`cancel()`
`void`	`cancel(String[] protocol, int[] reasonCode, String[] reasonText)`
`void`	`cancel1xxTimer()` Stop the Extension Timer for 1xx.
`void`	`cancelTimer()` Stop the C Timer.
`boolean`	`getAddToPath()`
`SipServletRequestImpl`	`getMatchingRequest(SipServletRequestImpl request)` from the given request in param, find the current corresponding matching forwarded orginal request For a given ACK by example, there might be an UPDATE in between which make the outgoing requet not the INVITE one and can mess up the branch id generation for the ACK (200 OK would have had the same branch id as UPDATE)
`SipServletRequestImpl`	`getOriginalRequest()`
`SipURI`	`getPathURI()`
`SipServletRequestImpl`	`getPrackOriginalRequest()`
`Proxy`	`getProxy()`
`int`	`getProxyBranch1xxTimeout()`
`int`	`getProxyBranchTimeout()`
`boolean`	`getRecordRoute()`
`SipURI`	`getRecordRouteURI()`
`boolean`	`getRecurse()`
`List<ProxyBranch>`	`getRecursedProxyBranches()`
`SipServletRequest`	`getRequest()`
`MobicentsSipServletResponse`	`getResponse()`
`URI`	`getTargetURI()`
`boolean`	`isAddToPath()`
`boolean`	`isCanceled()`
`boolean`	`isStarted()`
`boolean`	`isTimedOut()` Has the branch timed out?
`boolean`	`isWaitingForPrack()`
`void`	`onBranchTerminated()`
`void`	`onResponse(MobicentsSipServletResponse response, int status)` A callback.
`void`	`onTimeout(ResponseType responseType)` This callback is called when the remote side has been idle too long while establishing the dialog.
`void`	`proxyDialogStateless(SipServletRequestImpl request)` This method proxies requests without updating JSIP dialog state.
`void`	`proxySubsequentRequest(MobicentsSipServletRequest sipServletRequest)` Call this method when a subsequent request must be proxied through the branch.
`void`	`readExternal(ObjectInput in)`
`void`	`removeTransaction(String branch)`
`void`	`setAddToPath(boolean isAddToPath)`
`void`	`setOriginalRequest(SipServletRequestImpl originalRequest)`
`void`	`setOutboundInterface(InetAddress inetAddress)`
`void`	`setOutboundInterface(InetSocketAddress inetSocketAddress)`
`void`	`setOutboundInterface(SipURI outboundInterface)`
`void`	`setOutgoingRequest(SipServletRequestImpl outgoingRequest)`
`void`	`setPrackOriginalRequest(SipServletRequestImpl prackOriginalRequest)`
`void`	`setProxy(ProxyImpl proxy)`
`void`	`setProxyBranch1xxTimeout(int timeout)`
`void`	`setProxyBranchTimeout(int seconds)`
`void`	`setRecordRoute(boolean isRecordRoute)`
`void`	`setRecurse(boolean isRecurse)`
`void`	`setResponse(MobicentsSipServletResponse response)`
`void`	`setTargetURI(URI targetURI)`
`void`	`setWaitingForPrack(boolean waitingForPrack)`
`void`	`start()` After the branch is initialized, this method proxies the initial request to the specified destination.
`void`	`updateTimer(boolean cancel1xxTimer)` Restart the timer.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - viaHeader
```
public transient javax.sip.header.ViaHeader viaHeader
```
  - ongoingTransactions
```
public transient List<ProxyBranchImpl.TransactionRequest> ongoingTransactions
```
- Constructor Detail
  - ProxyBranchImpl
```
public ProxyBranchImpl()
```
  - ProxyBranchImpl
```
public ProxyBranchImpl(URI uri,
               ProxyImpl proxy)
```
- Method Detail
  - cancel
```
public void cancel()
```
    Specified by:
    
    cancel in interface ProxyBranch
  - cancel
```
public void cancel(String[] protocol,
          int[] reasonCode,
          String[] reasonText)
```
    Specified by:
    
    cancel in interface ProxyBranch
  - onBranchTerminated
```
public void onBranchTerminated()
```
  - getProxy
```
public Proxy getProxy()
```
    Specified by:
    
    getProxy in interface ProxyBranch
  - getProxyBranchTimeout
```
public int getProxyBranchTimeout()
```
    Specified by:
    
    getProxyBranchTimeout in interface ProxyBranch
  - getRecordRouteURI
```
public SipURI getRecordRouteURI()
```
    Specified by:
    
    getRecordRouteURI in interface ProxyBranch
  - getRecursedProxyBranches
```
public List<ProxyBranch> getRecursedProxyBranches()
```
    Specified by:
    
    getRecursedProxyBranches in interface ProxyBranch
  - addRecursedBranch
```
public void addRecursedBranch(ProxyBranchImpl branch)
```
  - getMatchingRequest
```
public SipServletRequestImpl getMatchingRequest(SipServletRequestImpl request)
```
    from the given request in param, find the current corresponding matching forwarded orginal request For a given ACK by example, there might be an UPDATE in between which make the outgoing requet not the INVITE one and can mess up the branch id generation for the ACK (200 OK would have had the same branch id as UPDATE)
  - getRequest
```
public SipServletRequest getRequest()
```
    Specified by:
    
    getRequest in interface ProxyBranch
  - getResponse
```
public MobicentsSipServletResponse getResponse()
```
    Specified by:
    
    getResponse in interface ProxyBranch
  - setResponse
```
public void setResponse(MobicentsSipServletResponse response)
```
    Specified by:
    
    setResponse in interface MobicentsProxyBranch
  - isStarted
```
public boolean isStarted()
```
    Specified by:
    
    isStarted in interface ProxyBranch
  - setProxyBranchTimeout
```
public void setProxyBranchTimeout(int seconds)
```
    Specified by:
    
    setProxyBranchTimeout in interface ProxyBranch
  - start
```
public void start()
```
    After the branch is initialized, this method proxies the initial request to the specified destination. Subsequent requests are proxied through proxySubsequentRequest
    
    Specified by:
    
    start in interface MobicentsProxyBranch
  - onResponse
```
public void onResponse(MobicentsSipServletResponse response,
              int status)
                throws DispatcherException
```
    A callback. Here we receive all responses from the proxied requests we have sent.
    
    Specified by:
    
    onResponse in interface MobicentsProxyBranch
    
    Parameters:
    response -
    
    Throws:
    
    DispatcherException
  - isTimedOut
```
public boolean isTimedOut()
```
    Has the branch timed out?
    
    Specified by:
    
    isTimedOut in interface MobicentsProxyBranch
    
    Returns:
  - addTransaction
```
public void addTransaction(SipServletRequestImpl request)
```
  - removeTransaction
```
public void removeTransaction(String branch)
```
  - proxySubsequentRequest
```
public void proxySubsequentRequest(MobicentsSipServletRequest sipServletRequest)
```
    Call this method when a subsequent request must be proxied through the branch.
    
    Specified by:
    
    proxySubsequentRequest in interface MobicentsProxyBranch
    
    Parameters:
    request -
  - proxyDialogStateless
```
public void proxyDialogStateless(SipServletRequestImpl request)
```
    This method proxies requests without updating JSIP dialog state. PRACK and re-INVITE requests require this kind of handling because: 1. PRACK occurs before a dialog has been established (and also produces OKs before the final response) 2. re-INVITE when sent with the dialog method resets the internal JSIP CSeq counter to 1 every time you need it, which causes issues like http://groups.google.com/group/mobicents-public/browse_thread/thread/1a22ccdc4c481f47
    
    Parameters:
    request -
  - onTimeout
```
public void onTimeout(ResponseType responseType)
               throws DispatcherException
```
    This callback is called when the remote side has been idle too long while establishing the dialog.
    
    Throws:
    
    DispatcherException
  - updateTimer
```
public void updateTimer(boolean cancel1xxTimer)
```
    Restart the timer. Call this method when some activity shows the remote party is still online.
    
    Specified by:
    
    updateTimer in interface MobicentsProxyBranch
  - cancelTimer
```
public void cancelTimer()
```
    Stop the C Timer.
    
    Specified by:
    
    cancelTimer in interface MobicentsProxyBranch
  - cancel1xxTimer
```
public void cancel1xxTimer()
```
    Stop the Extension Timer for 1xx.
    
    Specified by:
    
    cancel1xxTimer in interface MobicentsProxyBranch
  - isCanceled
```
public boolean isCanceled()
```
    Specified by:
    
    isCanceled in interface MobicentsProxyBranch
  - getAddToPath
```
public boolean getAddToPath()
```
    Specified by:
    
    getAddToPath in interface ProxyBranch
  - getPathURI
```
public SipURI getPathURI()
```
    Specified by:
    
    getPathURI in interface ProxyBranch
  - getRecordRoute
```
public boolean getRecordRoute()
```
    Specified by:
    
    getRecordRoute in interface ProxyBranch
  - getRecurse
```
public boolean getRecurse()
```
    Specified by:
    
    getRecurse in interface ProxyBranch
  - setAddToPath
```
public void setAddToPath(boolean isAddToPath)
```
    Specified by:
    
    setAddToPath in interface ProxyBranch
  - isAddToPath
```
public boolean isAddToPath()
```
  - setOutboundInterface
```
public void setOutboundInterface(InetAddress inetAddress)
```
    Specified by:
    
    setOutboundInterface in interface ProxyBranch
  - setOutboundInterface
```
public void setOutboundInterface(InetSocketAddress inetSocketAddress)
```
    Specified by:
    
    setOutboundInterface in interface ProxyBranch
  - setOutboundInterface
```
public void setOutboundInterface(SipURI outboundInterface)
```
    Specified by:
    
    setOutboundInterface in interface ProxyBranchExt
  - setRecordRoute
```
public void setRecordRoute(boolean isRecordRoute)
```
    Specified by:
    
    setRecordRoute in interface ProxyBranch
  - setRecurse
```
public void setRecurse(boolean isRecurse)
```
    Specified by:
    
    setRecurse in interface ProxyBranch
  - setPrackOriginalRequest
```
public void setPrackOriginalRequest(SipServletRequestImpl prackOriginalRequest)
```
    Parameters:
    prackOriginalRequest - the prackOriginalRequest to set
  - getPrackOriginalRequest
```
public SipServletRequestImpl getPrackOriginalRequest()
```
    Specified by:
    
    getPrackOriginalRequest in interface MobicentsProxyBranch
    
    Returns:
    the prackOriginalRequest
  - isWaitingForPrack
```
public boolean isWaitingForPrack()
```
  - setWaitingForPrack
```
public void setWaitingForPrack(boolean waitingForPrack)
```
  - setProxy
```
public void setProxy(ProxyImpl proxy)
```
    Parameters:
    proxy - the proxy to set
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - getProxyBranch1xxTimeout
```
public int getProxyBranch1xxTimeout()
```
    Specified by:
    
    getProxyBranch1xxTimeout in interface ProxyBranchExt
  - setProxyBranch1xxTimeout
```
public void setProxyBranch1xxTimeout(int timeout)
```
    Specified by:
    
    setProxyBranch1xxTimeout in interface ProxyBranchExt
  - setOutgoingRequest
```
public void setOutgoingRequest(SipServletRequestImpl outgoingRequest)
```
    Parameters:
    outgoingRequest - the outgoingRequest to set
  - setOriginalRequest
```
public void setOriginalRequest(SipServletRequestImpl originalRequest)
```
    Parameters:
    originalRequest - the originalRequest to set
  - getOriginalRequest
```
public SipServletRequestImpl getOriginalRequest()
```
    Returns:
    the originalRequest
  - setTargetURI
```
public void setTargetURI(URI targetURI)
```
    Parameters:
    targetURI - the targetURI to set
  - getTargetURI
```
public URI getTargetURI()
```
    Specified by:
    
    getTargetURI in interface MobicentsProxyBranch
    
    Returns:
    the targetURI

Class ProxyBranchImpl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

viaHeader

ongoingTransactions

Constructor Detail

ProxyBranchImpl

ProxyBranchImpl

Method Detail

cancel

cancel

onBranchTerminated

getProxy

getProxyBranchTimeout

getRecordRouteURI

getRecursedProxyBranches

addRecursedBranch

getMatchingRequest

getRequest

getResponse

setResponse

isStarted

setProxyBranchTimeout

start

onResponse

isTimedOut

addTransaction

removeTransaction

proxySubsequentRequest

proxyDialogStateless

onTimeout

updateTimer

cancelTimer

cancel1xxTimer

isCanceled

getAddToPath

getPathURI

getRecordRoute

getRecurse

setAddToPath

isAddToPath

setOutboundInterface

setOutboundInterface

setOutboundInterface

setRecordRoute

setRecurse

setPrackOriginalRequest

getPrackOriginalRequest

isWaitingForPrack

setWaitingForPrack

setProxy

readExternal

writeExternal

getProxyBranch1xxTimeout

setProxyBranch1xxTimeout

setOutgoingRequest

setOriginalRequest

getOriginalRequest

setTargetURI

getTargetURI