org.mobicents.servlet.sip.proxy

Class ProxyImpl

java.lang.Object

org.mobicents.servlet.sip.proxy.ProxyImpl

All Implemented Interfaces:

Externalizable, Serializable, Proxy, ProxyExt, MobicentsProxy

public class ProxyImpl
extends Object
implements MobicentsProxy, Externalizable

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SipURIImpl	pathURI
protected SipURI	recordRouteURI
protected String	recordRouteURIString

Constructor Summary

Constructors

Constructor and Description
ProxyImpl()
ProxyImpl(SipServletRequestImpl request, SipFactoryImpl sipFactoryImpl)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allResponsesHaveArrived()
void	cancel()
void	cancel(String[] protocol, int[] reasonCode, String[] reasonText)
void	cancelAllExcept(ProxyBranch except, String[] protocol, int[] reasonCode, String[] reasonText, boolean throwExceptionIfCannotCancel)
void	checkAndCleanProxy()
List<ProxyBranch>	createProxyBranches(List<? extends URI> targets)
boolean	getAckReceived()
boolean	getAddToPath()
SipServletResponseImpl	getBestResponse()
int	getBestResponseSent()
String	getCallerFromTag()
MobicentsProxyBranch	getFinalBranchForSubsequentRequests()
boolean	getNoCancel()
SipServletRequest	getOriginalRequest()
SipURI	getOutboundInterface()
boolean	getParallel()
SipURI	getPathURI()
String	getPreviousNode()
int	getProxy1xxTimeout()
ProxyBranch	getProxyBranch(URI uri)
List<ProxyBranch>	getProxyBranches()
Map<URI,ProxyBranchImpl>	getProxyBranchesMap()
int	getProxyTimeout()
ProxyTimerService	getProxyTimerService()
boolean	getRecordRoute()
SipURI	getRecordRouteURI()
boolean	getRecurse()
int	getSequentialSearchTimeout()
SipFactoryImpl	getSipFactoryImpl()
boolean	getSipOutboundSupport()
boolean	getStateful()
boolean	getSupervised()
Map<String,TransactionApplicationData>	getTransactionMap()
boolean	isAppSpecifiedRecordRoutingEnabled()
boolean	isTerminationSent()
void	onBranchTimeOut(ProxyBranchImpl branch)
void	onFinalResponse(ProxyBranchImpl branch)
void	proxyTo(List<? extends URI> uris)
void	proxyTo(URI uri)
void	putTransaction(SipServletRequestImpl request)
void	readExternal(ObjectInput in)
void	removeTransaction(String txId)
void	sendFinalResponse(MobicentsSipServletResponse response, ProxyBranchImpl proxyBranch)
void	setAckReceived(boolean received)
void	setAddToPath(boolean p)
void	setCallerFromTag(String initiatorFromTag)
void	setMobicentsSipFactory(MobicentsSipFactory sipFactoryImpl)
void	setNoCancel(boolean isNoCancel)
void	setOriginalRequest(MobicentsSipServletRequest originalRequest)
void	setOutboundInterface(InetAddress inetAddress)
void	setOutboundInterface(InetSocketAddress inetSocketAddress)
void	setOutboundInterface(SipURI outboundInterface)
void	setParallel(boolean parallel)
void	setProxy1xxTimeout(int timeout)
void	setProxyTimeout(int seconds)
void	setRecordRoute(boolean rr)
void	setRecordRouteURI(SipURI uri)
void	setRecurse(boolean recurse)
void	setSequentialSearchTimeout(int seconds)
void	setSipOutboundSupport(boolean sipOutboundSupport)
void	setStateful(boolean stateful)
void	setSupervised(boolean supervised)
void	startNextUntriedBranch()
void	startProxy()
void	storeTerminationInformation(boolean store)
void	terminateSession(SipSession session, int calleeResponseCode, String calleeResponseText, int callerResponseCode, String callerResponseText)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pathURI

protected transient SipURIImpl pathURI

recordRouteURIString

protected transient String recordRouteURIString

recordRouteURI

protected transient SipURI recordRouteURI

Constructor Detail

ProxyImpl

public ProxyImpl()

ProxyImpl

public ProxyImpl(SipServletRequestImpl request,
         SipFactoryImpl sipFactoryImpl)

Method Detail

putTransaction

public void putTransaction(SipServletRequestImpl request)

removeTransaction

public void removeTransaction(String txId)

checkAndCleanProxy

public void checkAndCleanProxy()

cancel

public void cancel()

Specified by:

cancel in interface Proxy

cancel

public void cancel(String[] protocol,
          int[] reasonCode,
          String[] reasonText)

Specified by:

cancel in interface Proxy

cancelAllExcept

public void cancelAllExcept(ProxyBranch except,
                   String[] protocol,
                   int[] reasonCode,
                   String[] reasonText,
                   boolean throwExceptionIfCannotCancel)

Specified by:

cancelAllExcept in interface MobicentsProxy

createProxyBranches

public List<ProxyBranch> createProxyBranches(List<? extends URI> targets)

Specified by:

createProxyBranches in interface Proxy

getAddToPath

public boolean getAddToPath()

Specified by:

getAddToPath in interface Proxy

getOriginalRequest

public SipServletRequest getOriginalRequest()

Specified by:

getOriginalRequest in interface Proxy

getParallel

public boolean getParallel()

Specified by:

getParallel in interface Proxy

getPathURI

public SipURI getPathURI()

Specified by:

getPathURI in interface Proxy

getProxyBranch

public ProxyBranch getProxyBranch(URI uri)

Specified by:

getProxyBranch in interface Proxy

getProxyBranches

public List<ProxyBranch> getProxyBranches()

Specified by:

getProxyBranches in interface Proxy

getProxyBranchesMap

public Map<URI,ProxyBranchImpl> getProxyBranchesMap()

getFinalBranchForSubsequentRequests

public MobicentsProxyBranch getFinalBranchForSubsequentRequests()

Specified by:

getFinalBranchForSubsequentRequests in interface MobicentsProxy

Returns:

the finalBranchForSubsequentRequest

getProxyTimeout

public int getProxyTimeout()

Specified by:

getProxyTimeout in interface Proxy

getRecordRoute

public boolean getRecordRoute()

Specified by:

getRecordRoute in interface Proxy

getRecordRouteURI

public SipURI getRecordRouteURI()

Specified by:

getRecordRouteURI in interface Proxy

getRecurse

public boolean getRecurse()

Specified by:

getRecurse in interface Proxy

getSequentialSearchTimeout

public int getSequentialSearchTimeout()

Specified by:

getSequentialSearchTimeout in interface Proxy

getStateful

public boolean getStateful()

Specified by:

getStateful in interface Proxy

getSupervised

public boolean getSupervised()

Specified by:

getSupervised in interface Proxy

proxyTo

public void proxyTo(List<? extends URI> uris)

Specified by:

proxyTo in interface Proxy

proxyTo

public void proxyTo(URI uri)

Specified by:

proxyTo in interface Proxy

setAddToPath

public void setAddToPath(boolean p)

Specified by:

setAddToPath in interface Proxy

setParallel

public void setParallel(boolean parallel)

Specified by:

setParallel in interface Proxy

setProxyTimeout

public void setProxyTimeout(int seconds)

Specified by:

setProxyTimeout in interface Proxy

setRecordRoute

public void setRecordRoute(boolean rr)

Specified by:

setRecordRoute in interface Proxy

setRecurse

public void setRecurse(boolean recurse)

Specified by:

setRecurse in interface Proxy

setSequentialSearchTimeout

public void setSequentialSearchTimeout(int seconds)

Specified by:

setSequentialSearchTimeout in interface Proxy

setStateful

public void setStateful(boolean stateful)

Specified by:

setStateful in interface Proxy

setSupervised

public void setSupervised(boolean supervised)

Specified by:

setSupervised in interface Proxy

startProxy

public void startProxy()

Specified by:

startProxy in interface Proxy

getOutboundInterface

public SipURI getOutboundInterface()

onFinalResponse

public void onFinalResponse(ProxyBranchImpl branch)
                     throws DispatcherException

Throws:

DispatcherException

onBranchTimeOut

public void onBranchTimeOut(ProxyBranchImpl branch)
                     throws DispatcherException

Throws:

DispatcherException

startNextUntriedBranch

public void startNextUntriedBranch()

allResponsesHaveArrived

public boolean allResponsesHaveArrived()

sendFinalResponse

public void sendFinalResponse(MobicentsSipServletResponse response,
                     ProxyBranchImpl proxyBranch)
                       throws DispatcherException

Throws:

DispatcherException

getBestResponse

public SipServletResponseImpl getBestResponse()

Returns:

the bestResponse

setOriginalRequest

public void setOriginalRequest(MobicentsSipServletRequest originalRequest)

Specified by:

setOriginalRequest in interface MobicentsProxy

getNoCancel

public boolean getNoCancel()

Specified by:

getNoCancel in interface Proxy

setNoCancel

public void setNoCancel(boolean isNoCancel)

Specified by:

setNoCancel in interface Proxy

getSipFactoryImpl

public SipFactoryImpl getSipFactoryImpl()

Returns:

the sipFactoryImpl

setMobicentsSipFactory

public void setMobicentsSipFactory(MobicentsSipFactory sipFactoryImpl)

Parameters:

sipFactoryImpl - the sipFactoryImpl to set

setOutboundInterface

public void setOutboundInterface(InetAddress inetAddress)

Specified by:

setOutboundInterface in interface Proxy

setOutboundInterface

public void setOutboundInterface(InetSocketAddress inetSocketAddress)

Specified by:

setOutboundInterface in interface Proxy

setOutboundInterface

public void setOutboundInterface(SipURI outboundInterface)

Specified by:

setOutboundInterface in interface ProxyExt

setAckReceived

public void setAckReceived(boolean received)

Specified by:

setAckReceived in interface MobicentsProxy

getAckReceived

public boolean getAckReceived()

getPreviousNode

public String getPreviousNode()

getCallerFromTag

public String getCallerFromTag()

setCallerFromTag

public void setCallerFromTag(String initiatorFromTag)

getTransactionMap

public Map<String,TransactionApplicationData> getTransactionMap()

Specified by:

getTransactionMap in interface MobicentsProxy

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

getProxy1xxTimeout

public int getProxy1xxTimeout()

Specified by:

getProxy1xxTimeout in interface ProxyExt

setProxy1xxTimeout

public void setProxy1xxTimeout(int timeout)

Specified by:

setProxy1xxTimeout in interface ProxyExt

getProxyTimerService

public ProxyTimerService getProxyTimerService()

Returns:

the proxyTimerService

storeTerminationInformation

public void storeTerminationInformation(boolean store)
                                 throws IllegalStateException

Specified by:

storeTerminationInformation in interface ProxyExt

Throws:

IllegalStateException

terminateSession

public void terminateSession(SipSession session,
                    int calleeResponseCode,
                    String calleeResponseText,
                    int callerResponseCode,
                    String callerResponseText)
                      throws IllegalStateException,
                             IOException

Specified by:

terminateSession in interface ProxyExt

Throws:

IllegalStateException

IOException

isTerminationSent

public boolean isTerminationSent()

Specified by:

isTerminationSent in interface MobicentsProxy

Returns:

the terminationInfo

getBestResponseSent

public int getBestResponseSent()

Returns:

the bestResponseSent

getSipOutboundSupport

public boolean getSipOutboundSupport()

Specified by:

getSipOutboundSupport in interface ProxyExt

setSipOutboundSupport

public void setSipOutboundSupport(boolean sipOutboundSupport)

Specified by:

setSipOutboundSupport in interface ProxyExt

setRecordRouteURI

public void setRecordRouteURI(SipURI uri)

Specified by:

setRecordRouteURI in interface ProxyExt

isAppSpecifiedRecordRoutingEnabled

public boolean isAppSpecifiedRecordRoutingEnabled()

Returns:

the userSpecifiedRecordRoutingEnabled