org.cipango.server

Class SipResponse

java.lang.Object

org.cipango.server.SipMessage

org.cipango.server.SipResponse

All Implemented Interfaces:

java.lang.Cloneable, javax.servlet.ServletResponse, javax.servlet.sip.SipServletMessage, javax.servlet.sip.SipServletResponse

public class SipResponse
extends SipMessage
implements javax.servlet.sip.SipServletResponse

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

Fields inherited from interface javax.servlet.sip.SipServletResponse

SC_ACCEPTED, SC_ADDRESS_INCOMPLETE, SC_ALTERNATIVE_SERVICE, SC_AMBIGUOUS, SC_BAD_EVENT, SC_BAD_EXTENSION, SC_BAD_GATEWAY, SC_BAD_IDENTITY_INFO, SC_BAD_REQUEST, SC_BUSY_EVERYWHERE, SC_BUSY_HERE, SC_CALL_BEING_FORWARDED, SC_CALL_LEG_DONE, SC_CALL_QUEUED, SC_CONDITIONAL_REQUEST_FAILED, SC_DECLINE, SC_DOES_NOT_EXIT_ANYWHERE, SC_EXTENSION_REQUIRED, SC_FORBIDDEN, SC_GONE, SC_INTERVAL_TOO_BRIEF, SC_INVALID_IDENTITY_HEADER, SC_LOOP_DETECTED, SC_MESSAGE_TOO_LARGE, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NOT_ACCEPTABLE, SC_NOT_ACCEPTABLE_ANYWHERE, SC_NOT_ACCEPTABLE_HERE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_OK, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILURE, SC_PROVIDE_REFERER_IDENTITY, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_PENDING, SC_REQUEST_TERMINATED, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_RINGING, SC_SECURITY_AGREEMENT_REQUIRED, SC_SERVER_INTERNAL_ERROR, SC_SERVER_TIMEOUT, SC_SERVICE_UNAVAILABLE, SC_SESSION_INTERVAL_TOO_SMALL, SC_SESSION_PROGRESS, SC_TEMPORARLY_UNAVAILABLE, SC_TOO_MANY_HOPS, SC_TRYING, SC_UNAUTHORIZED, SC_UNDECIPHERABLE, SC_UNSUPPORTED_CERTIFICATE, SC_UNSUPPORTED_MEDIA_TYPE, SC_UNSUPPORTED_URI_SCHEME, SC_USE_IDENTITY_HEADER, SC_USE_PROXY, SC_VERSION_NOT_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
SipResponse()
SipResponse(SipRequest request, int status, java.lang.String reason)
SipResponse(SipRequest request, int status, java.lang.String reason, Session session)
SipResponse(SipResponse other)

Method Summary

Modifier and Type	Method and Description
protected boolean	canSetContact()
javax.servlet.sip.SipServletRequest	createAck()
javax.servlet.sip.SipServletRequest	createPrack()
void	flushBuffer()
int	getBufferSize()
java.util.Iterator<java.lang.String>	getChallengeRealms()
java.util.Locale	getLocale()
java.lang.String	getMethod()
java.lang.String	getNullableReasonPhrase() Returns the reason phrase if it has been set else returns null.
javax.servlet.ServletOutputStream	getOutputStream()
javax.servlet.sip.Proxy	getProxy()
javax.servlet.sip.ProxyBranch	getProxyBranch()
java.lang.String	getReasonPhrase()
javax.servlet.sip.SipServletRequest	getRequest()
long	getRSeq()
SipMethod	getSipMethod()
int	getStatus()
Transaction	getTransaction()
java.io.PrintWriter	getWriter()
boolean	is2xx()
boolean	isBranchResponse()
boolean	isReliable1xx()
boolean	isRequest()
boolean	isSuccess()
boolean	needsContact()
void	reset()
void	resetBuffer()
void	send()
protected void	send(boolean reliable)
void	sendReliably()
void	setBranchResponse(boolean branchResponse)
void	setBufferSize(int size)
void	setCharacterEncoding(java.lang.String encoding)
void	setContentLengthLong(long len)
void	setLocale(java.util.Locale locale)
void	setProxyBranch(javax.servlet.sip.ProxyBranch proxyBranch)
void	setRequest(SipRequest request)
void	setRSeq(long rseq)
void	setStatus(int status)
void	setStatus(int status, java.lang.String reason)
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, 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, 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.ServletResponse

getCharacterEncoding, getContentType, isCommitted, setContentLength, setContentType

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, setContent, setContentLanguage, setContentLength, setContentType, setExpires, setHeader, setHeaderForm, setParameterableHeader

Constructor Detail

SipResponse

public SipResponse()

SipResponse

public SipResponse(SipRequest request,
                   int status,
                   java.lang.String reason)

SipResponse

public SipResponse(SipRequest request,
                   int status,
                   java.lang.String reason,
                   Session session)

SipResponse

public SipResponse(SipResponse other)

Method Detail

is2xx

public boolean is2xx()

needsContact

public boolean needsContact()

Specified by:

needsContact in class SipMessage

getTransaction

public Transaction getTransaction()

Specified by:

getTransaction 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.SipServletResponse

Throws:

java.io.IOException

See Also:

SipServletResponse.send()

send

protected void send(boolean reliable)
             throws java.io.IOException

Throws:

java.io.IOException

isSuccess

public boolean isSuccess()

isRequest

public boolean isRequest()

Specified by:

isRequest in class SipMessage

setCharacterEncoding

public void setCharacterEncoding(java.lang.String encoding)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

Specified by:

setCharacterEncoding in interface javax.servlet.sip.SipServletMessage

Overrides:

setCharacterEncoding in class SipMessage

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Throws:

java.io.IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

setLocale

public void setLocale(java.util.Locale locale)

Specified by:

setLocale in interface javax.servlet.ServletResponse

createAck

public javax.servlet.sip.SipServletRequest createAck()

Specified by:

createAck in interface javax.servlet.sip.SipServletResponse

createPrack

public javax.servlet.sip.SipServletRequest createPrack()
                                                throws javax.servlet.sip.Rel100Exception

Specified by:

createPrack in interface javax.servlet.sip.SipServletResponse

Throws:

javax.servlet.sip.Rel100Exception

isReliable1xx

public boolean isReliable1xx()

setRSeq

public void setRSeq(long rseq)

getRSeq

public long getRSeq()

getChallengeRealms

public java.util.Iterator<java.lang.String> getChallengeRealms()

Specified by:

getChallengeRealms in interface javax.servlet.sip.SipServletResponse

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Specified by:

getOutputStream in interface javax.servlet.sip.SipServletResponse

Throws:

java.io.IOException

getProxy

public javax.servlet.sip.Proxy getProxy()

Specified by:

getProxy in interface javax.servlet.sip.SipServletResponse

getProxyBranch

public javax.servlet.sip.ProxyBranch getProxyBranch()

Specified by:

getProxyBranch in interface javax.servlet.sip.SipServletResponse

getReasonPhrase

public java.lang.String getReasonPhrase()

Specified by:

getReasonPhrase in interface javax.servlet.sip.SipServletResponse

See Also:

SipServletResponse.getReasonPhrase()

getNullableReasonPhrase

public java.lang.String getNullableReasonPhrase()

Returns the reason phrase if it has been set else returns null.

getRequest

public javax.servlet.sip.SipServletRequest getRequest()

Specified by:

getRequest in interface javax.servlet.sip.SipServletResponse

See Also:

SipServletResponse.getRequest()

getStatus

public int getStatus()

Specified by:

getStatus in interface javax.servlet.sip.SipServletResponse

See Also:

SipServletResponse.getStatus()

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

getSipMethod

public SipMethod getSipMethod()

Overrides:

getSipMethod in class SipMessage

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getMethod()

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Specified by:

getWriter in interface javax.servlet.sip.SipServletResponse

Throws:

java.io.IOException

isBranchResponse

public boolean isBranchResponse()

Specified by:

isBranchResponse in interface javax.servlet.sip.SipServletResponse

sendReliably

public void sendReliably()
                  throws javax.servlet.sip.Rel100Exception

Specified by:

sendReliably in interface javax.servlet.sip.SipServletResponse

Throws:

javax.servlet.sip.Rel100Exception

setStatus

public void setStatus(int status)

Specified by:

setStatus in interface javax.servlet.sip.SipServletResponse

setStatus

public void setStatus(int status,
                      java.lang.String reason)

Specified by:

setStatus in interface javax.servlet.sip.SipServletResponse

See Also:

SipServletResponse.setStatus(int, String)

canSetContact

protected boolean canSetContact()

Specified by:

canSetContact in class SipMessage

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

setRequest

public void setRequest(SipRequest request)

setBranchResponse

public void setBranchResponse(boolean branchResponse)

setProxyBranch

public void setProxyBranch(javax.servlet.sip.ProxyBranch proxyBranch)

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface javax.servlet.ServletResponse