org.cipango.server

Class SipRequest

java.lang.Object

org.cipango.server.SipMessage

org.cipango.server.SipRequest

All Implemented Interfaces:

java.lang.Cloneable, javax.servlet.ServletRequest, javax.servlet.sip.SipServletMessage, javax.servlet.sip.SipServletRequest

public class SipRequest
extends SipMessage
implements javax.servlet.sip.SipServletRequest

Nested Class Summary

Nested classes/interfaces inherited from interface javax.servlet.sip.SipServletMessage

javax.servlet.sip.SipServletMessage.HeaderForm

Field Summary

Fields inherited from class org.cipango.server.SipMessage

_characterEncoding, _fields, _method, _session, _sipMethod

Constructor Summary

Constructors

Constructor and Description
SipRequest()
SipRequest(SipRequest other)

Method Summary

Modifier and Type	Method and Description
void	addAuthHeader(javax.servlet.sip.SipServletResponse response, javax.servlet.sip.AuthInfo authInfo)
void	addAuthHeader(javax.servlet.sip.SipServletResponse response, java.lang.String username, java.lang.String password)
void	addRecordRoute(javax.servlet.sip.Address route)
protected boolean	canSetContact()
javax.servlet.sip.SipServletRequest	createCancel()
SipRequest	createRequest(SipMethod method)
javax.servlet.sip.SipServletResponse	createResponse(int status)
javax.servlet.sip.SipServletResponse	createResponse(int status, java.lang.String reason)
javax.servlet.AsyncContext	getAsyncContext()
javax.servlet.sip.B2buaHelper	getB2buaHelper()
javax.servlet.DispatcherType	getDispatcherType()
java.util.ListIterator<Hop>	getHops()
javax.servlet.sip.Address	getInitialPoppedRoute()
javax.servlet.ServletInputStream	getInputStream()
SipRequest	getLinkedRequest()
java.util.Locale	getLocale()
java.util.Enumeration<java.util.Locale>	getLocales()
java.lang.String	getLocalName()
int	getMaxForwards()
java.lang.String	getMethod()
java.lang.String	getParameter(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap()
java.util.Enumeration<java.lang.String>	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
javax.servlet.sip.SipURI	getParamUri()
javax.servlet.sip.Address	getPoppedRoute()
javax.servlet.sip.Proxy	getProxy()
javax.servlet.sip.Proxy	getProxy(boolean create)
RAck	getRAck()
java.io.BufferedReader	getReader()
java.lang.String	getRealPath(java.lang.String path)
javax.servlet.sip.ar.SipApplicationRoutingRegion	getRegion()
java.lang.String	getRemoteHost()
javax.servlet.RequestDispatcher	getRequestDispatcher(java.lang.String path)
javax.servlet.sip.URI	getRequestURI()
javax.servlet.sip.ar.SipApplicationRoutingDirective	getRoutingDirective()
java.lang.String	getScheme()
java.lang.String	getServerName()
int	getServerPort()
javax.servlet.ServletContext	getServletContext()
java.io.Serializable	getStateInfo()
javax.servlet.sip.URI	getSubscriberURI()
javax.servlet.sip.Address	getTopRoute()
Transaction	getTransaction()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isHandled()
boolean	isInitial()
boolean	isNextHopStrictRouting()
boolean	isRequest()
static boolean	isStrictRoutingEnabled()
boolean	needsContact()
void	pushPath(javax.servlet.sip.Address arg0)
void	pushRoute(javax.servlet.sip.Address route)
void	pushRoute(javax.servlet.sip.SipURI route)
javax.servlet.sip.Address	removeLastRoute()
javax.servlet.sip.Address	removeTopRoute()
void	send()
void	setHandled(boolean handled)
void	setHops(java.util.ListIterator<Hop> hops)
void	setInitialPoppedRoute(javax.servlet.sip.Address route)
void	setLinkedRequest(SipRequest request)
void	setMaxForwards(int maxForwards)
void	setMethod(SipMethod sipMethod, java.lang.String method)
void	setNextHopStrinctRouting(boolean nextHopStrictRouting)
void	setPoppedRoute(javax.servlet.sip.Address route)
void	setProxy(javax.servlet.sip.Proxy proxy)
void	setRegion(javax.servlet.sip.ar.SipApplicationRoutingRegion region)
void	setRequestURI(javax.servlet.sip.URI uri)
void	setRoutingDirective(javax.servlet.sip.ar.SipApplicationRoutingDirective directive, javax.servlet.sip.SipServletRequest origRequest)
void	setStateInfo(java.io.Serializable stateInfo)
static void	setStrictRoutingEnabled(boolean strictRoutingEnabled)
void	setSubscriberURI(javax.servlet.sip.URI uri)
void	setTransaction(Transaction transaction)
javax.servlet.AsyncContext	startAsync()
javax.servlet.AsyncContext	startAsync(javax.servlet.ServletRequest arg0, javax.servlet.ServletResponse arg1)
java.lang.String	toString()
java.lang.String	toStringCompact()

Methods inherited from class org.cipango.server.SipMessage

addAcceptLanguage, addAddressHeader, addHeader, addParameterableHeader, appSession, from, getAcceptLanguage, getAcceptLanguages, getAddressHeader, getAddressHeaders, getApplicationSession, getApplicationSession, getAttribute, getAttributeNames, getCallId, getCharacterEncoding, getConnection, getContent, getContentLanguage, getContentLength, getContentLengthLong, getContentType, getCSeq, getExpires, getFields, getFrom, getHandler, getHeader, getHeaderForm, getHeaderNames, getHeaders, getInitialRemoteAddr, getInitialRemotePort, getInitialTransport, getLocalAddr, getLocalPort, getParameterableHeader, getParameterableHeaders, getProtocol, getRawContent, getRemoteAddr, getRemotePort, getRemoteUser, getSession, getSession, getSipMethod, getTimeStamp, getTo, getTopVia, getToTag, getTransport, getUserIdentity, getUserPrincipal, isAck, isBye, isCancel, isCommitted, isInvite, isMethod, isNotify, isPrack, isRegister, isSecure, isSubscribe, isSystemHeader, isUpdate, isUserInRole, removeAttribute, removeHeader, removeTopVia, session, setAcceptLanguage, setAddressHeader, setAttribute, setCharacterEncoding, setCommitted, setConnection, setContent, setContentLanguage, setContentLength, setContentType, setExpires, setHandler, setHeader, setHeaderForm, setInitialRemoteAddr, setInitialRemotePort, setInitialTransport, setParameterableHeader, setSession, setTimeStamp, setUserIdentity, to

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getLocalAddr, getLocalPort, getProtocol, getRemoteAddr, getRemotePort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

Methods inherited from interface javax.servlet.sip.SipServletMessage

addAcceptLanguage, addAddressHeader, addHeader, addParameterableHeader, getAcceptLanguage, getAcceptLanguages, getAddressHeader, getAddressHeaders, getApplicationSession, getApplicationSession, getAttribute, getAttributeNames, getCallId, getCharacterEncoding, getContent, getContentLanguage, getContentLength, getContentType, getExpires, getFrom, getHeader, getHeaderForm, getHeaderNames, getHeaders, getInitialRemoteAddr, getInitialRemotePort, getInitialTransport, getLocalAddr, getLocalPort, getParameterableHeader, getParameterableHeaders, getProtocol, getRawContent, getRemoteAddr, getRemotePort, getRemoteUser, getSession, getSession, getTo, getTransport, getUserPrincipal, isCommitted, isSecure, isUserInRole, removeAttribute, removeHeader, setAcceptLanguage, setAddressHeader, setAttribute, setCharacterEncoding, setContent, setContentLanguage, setContentLength, setContentType, setExpires, setHeader, setHeaderForm, setParameterableHeader

Constructor Detail

SipRequest

public SipRequest()

SipRequest

public SipRequest(SipRequest other)

Method Detail

isRequest

public boolean isRequest()

Specified by:

isRequest in class SipMessage

setMethod

public void setMethod(SipMethod sipMethod,
                      java.lang.String method)

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getMethod()

setTransaction

public void setTransaction(Transaction transaction)

getTransaction

public Transaction getTransaction()

Specified by:

getTransaction in class SipMessage

canSetContact

protected boolean canSetContact()

Specified by:

canSetContact in class SipMessage

send

public void send()
          throws java.io.IOException

Specified by:

send in interface javax.servlet.sip.SipServletMessage

Specified by:

send in interface javax.servlet.sip.SipServletRequest

Throws:

java.io.IOException

See Also:

SipServletRequest.send()

getTopRoute

public javax.servlet.sip.Address getTopRoute()
                                      throws javax.servlet.sip.ServletParseException

Throws:

javax.servlet.sip.ServletParseException

removeTopRoute

public javax.servlet.sip.Address removeTopRoute()

setPoppedRoute

public void setPoppedRoute(javax.servlet.sip.Address route)

addRecordRoute

public void addRecordRoute(javax.servlet.sip.Address route)

createCancel

public javax.servlet.sip.SipServletRequest createCancel()

Specified by:

createCancel in interface javax.servlet.sip.SipServletRequest

createRequest

public SipRequest createRequest(SipMethod method)

createResponse

public javax.servlet.sip.SipServletResponse createResponse(int status)

Specified by:

createResponse in interface javax.servlet.sip.SipServletRequest

See Also:

SipServletRequest.createResponse(int)

createResponse

public javax.servlet.sip.SipServletResponse createResponse(int status,
                                                           java.lang.String reason)

Specified by:

createResponse in interface javax.servlet.sip.SipServletRequest

See Also:

SipServletRequest.createResponse(int, String)

needsContact

public boolean needsContact()

Specified by:

needsContact in class SipMessage

getParamUri

public javax.servlet.sip.SipURI getParamUri()

getParameter

public java.lang.String getParameter(java.lang.String name)

Specified by:

getParameter in interface javax.servlet.ServletRequest

getParameterNames

public java.util.Enumeration<java.lang.String> getParameterNames()

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

getScheme

public java.lang.String getScheme()

Specified by:

getScheme in interface javax.servlet.ServletRequest

getServerName

public java.lang.String getServerName()

Specified by:

getServerName in interface javax.servlet.ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface javax.servlet.ServletRequest

See Also:

ServletRequest.getServerPort()

getRemoteHost

public java.lang.String getRemoteHost()

Specified by:

getRemoteHost in interface javax.servlet.ServletRequest

See Also:

ServletRequest.getRemoteHost()

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletRequest

getLocales

public java.util.Enumeration<java.util.Locale> getLocales()

Specified by:

getLocales in interface javax.servlet.ServletRequest

getRAck

public RAck getRAck()
             throws javax.servlet.sip.ServletParseException

Throws:

javax.servlet.sip.ServletParseException

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

getRealPath

public java.lang.String getRealPath(java.lang.String path)

Specified by:

getRealPath in interface javax.servlet.ServletRequest

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface javax.servlet.ServletRequest

addAuthHeader

public void addAuthHeader(javax.servlet.sip.SipServletResponse response,
                          javax.servlet.sip.AuthInfo authInfo)

Specified by:

addAuthHeader in interface javax.servlet.sip.SipServletRequest

addAuthHeader

public void addAuthHeader(javax.servlet.sip.SipServletResponse response,
                          java.lang.String username,
                          java.lang.String password)

Specified by:

addAuthHeader in interface javax.servlet.sip.SipServletRequest

getB2buaHelper

public javax.servlet.sip.B2buaHelper getB2buaHelper()

Specified by:

getB2buaHelper in interface javax.servlet.sip.SipServletRequest

getInitialPoppedRoute

public javax.servlet.sip.Address getInitialPoppedRoute()

Specified by:

getInitialPoppedRoute in interface javax.servlet.sip.SipServletRequest

setInitialPoppedRoute

public void setInitialPoppedRoute(javax.servlet.sip.Address route)

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Specified by:

getInputStream in interface javax.servlet.sip.SipServletRequest

Throws:

java.io.IOException

getMaxForwards

public int getMaxForwards()

Specified by:

getMaxForwards in interface javax.servlet.sip.SipServletRequest

getPoppedRoute

public javax.servlet.sip.Address getPoppedRoute()

Specified by:

getPoppedRoute in interface javax.servlet.sip.SipServletRequest

getProxy

public javax.servlet.sip.Proxy getProxy()
                                 throws javax.servlet.sip.TooManyHopsException

Specified by:

getProxy in interface javax.servlet.sip.SipServletRequest

Throws:

javax.servlet.sip.TooManyHopsException

getProxy

public javax.servlet.sip.Proxy getProxy(boolean create)
                                 throws javax.servlet.sip.TooManyHopsException

Specified by:

getProxy in interface javax.servlet.sip.SipServletRequest

Throws:

javax.servlet.sip.TooManyHopsException

setProxy

public void setProxy(javax.servlet.sip.Proxy proxy)

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Specified by:

getReader in interface javax.servlet.ServletRequest

Specified by:

getReader in interface javax.servlet.sip.SipServletRequest

Throws:

java.io.IOException

getRegion

public javax.servlet.sip.ar.SipApplicationRoutingRegion getRegion()

Specified by:

getRegion in interface javax.servlet.sip.SipServletRequest

getRequestURI

public javax.servlet.sip.URI getRequestURI()

Specified by:

getRequestURI in interface javax.servlet.sip.SipServletRequest

getRoutingDirective

public javax.servlet.sip.ar.SipApplicationRoutingDirective getRoutingDirective()
                                                                        throws java.lang.IllegalStateException

Specified by:

getRoutingDirective in interface javax.servlet.sip.SipServletRequest

Throws:

java.lang.IllegalStateException

setRoutingDirective

public void setRoutingDirective(javax.servlet.sip.ar.SipApplicationRoutingDirective directive,
                                javax.servlet.sip.SipServletRequest origRequest)
                         throws java.lang.IllegalStateException

Specified by:

setRoutingDirective in interface javax.servlet.sip.SipServletRequest

Throws:

java.lang.IllegalStateException

getSubscriberURI

public javax.servlet.sip.URI getSubscriberURI()

Specified by:

getSubscriberURI in interface javax.servlet.sip.SipServletRequest

isInitial

public boolean isInitial()

Specified by:

isInitial in interface javax.servlet.sip.SipServletRequest

pushPath

public void pushPath(javax.servlet.sip.Address arg0)

Specified by:

pushPath in interface javax.servlet.sip.SipServletRequest

pushRoute

public void pushRoute(javax.servlet.sip.SipURI route)

Specified by:

pushRoute in interface javax.servlet.sip.SipServletRequest

pushRoute

public void pushRoute(javax.servlet.sip.Address route)

Specified by:

pushRoute in interface javax.servlet.sip.SipServletRequest

removeLastRoute

public javax.servlet.sip.Address removeLastRoute()

setNextHopStrinctRouting

public void setNextHopStrinctRouting(boolean nextHopStrictRouting)

isNextHopStrictRouting

public boolean isNextHopStrictRouting()

setMaxForwards

public void setMaxForwards(int maxForwards)

Specified by:

setMaxForwards in interface javax.servlet.sip.SipServletRequest

setRequestURI

public void setRequestURI(javax.servlet.sip.URI uri)

Specified by:

setRequestURI in interface javax.servlet.sip.SipServletRequest

getAsyncContext

public javax.servlet.AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface javax.servlet.ServletRequest

getDispatcherType

public javax.servlet.DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface javax.servlet.ServletRequest

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.ServletRequest

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface javax.servlet.ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface javax.servlet.ServletRequest

startAsync

public javax.servlet.AsyncContext startAsync()
                                      throws java.lang.IllegalStateException

Specified by:

startAsync in interface javax.servlet.ServletRequest

Throws:

java.lang.IllegalStateException

startAsync

public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest arg0,
                                             javax.servlet.ServletResponse arg1)
                                      throws java.lang.IllegalStateException

Specified by:

startAsync in interface javax.servlet.ServletRequest

Throws:

java.lang.IllegalStateException

getLinkedRequest

public SipRequest getLinkedRequest()

setLinkedRequest

public void setLinkedRequest(SipRequest request)

getStateInfo

public java.io.Serializable getStateInfo()

setStateInfo

public void setStateInfo(java.io.Serializable stateInfo)

setRegion

public void setRegion(javax.servlet.sip.ar.SipApplicationRoutingRegion region)

setSubscriberURI

public void setSubscriberURI(javax.servlet.sip.URI uri)

isHandled

public boolean isHandled()

setHandled

public void setHandled(boolean handled)

getHops

public java.util.ListIterator<Hop> getHops()

setHops

public void setHops(java.util.ListIterator<Hop> hops)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringCompact

public java.lang.String toStringCompact()

Specified by:

toStringCompact in class SipMessage

isStrictRoutingEnabled

public static boolean isStrictRoutingEnabled()

setStrictRoutingEnabled

public static void setStrictRoutingEnabled(boolean strictRoutingEnabled)