org.mobicents.servlet.sip.message

Class SipServletResponseImpl

java.lang.Object

org.mobicents.servlet.sip.message.SipServletMessageImpl

org.mobicents.servlet.sip.message.SipServletResponseImpl

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, javax.servlet.ServletResponse, SipServletMessage, SipServletResponse, SipServletResponseExt, MobicentsSipServletMessage, MobicentsSipServletResponse

public abstract class SipServletResponseImpl
extends SipServletMessageImpl
implements MobicentsSipServletResponse

Implementation of the sip servlet response interface

See Also:

Serialized Form

Nested Class Summary

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

SipServletMessage.HeaderForm

Field Summary

Fields inherited from class org.mobicents.servlet.sip.message.SipServletMessageImpl

attributes, currentApplicationName, dialog, headerForm, isMessageSent, message, method, REL100_OPTION_TAG, sessionKey, sipFactoryImpl, sipSession, transactionApplicationData, transport, userPrincipal

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_EXIST_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_TEMPORARILY_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

Modifier	Constructor and Description
	SipServletResponseImpl()
protected	SipServletResponseImpl(javax.sip.message.Response response, SipFactoryImpl sipFactoryImpl, javax.sip.Transaction transaction, MobicentsSipSession session, javax.sip.Dialog dialog, boolean hasBeenReceived, boolean isRetransmission) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkMessageState()
void	cleanUp()
SipServletRequest	createAck()
SipServletRequest	createPrack()
void	flushBuffer()
int	getBufferSize()
Iterator<String>	getChallengeRealms()
Locale	getLocale()
AddressImpl.ModifiableRule	getModifiableRule(String headerName) Applications must not add, delete, or modify so-called "system" headers.
javax.servlet.ServletOutputStream	getOutputStream()
Proxy	getProxy()
ProxyBranch	getProxyBranch()
String	getReasonPhrase()
String	getRemoteAddr()
int	getRemotePort()
SipServletRequest	getRequest()
javax.sip.message.Response	getResponse()
int	getStatus()
PrintWriter	getWriter()
boolean	isBranchResponse()
boolean	isCommitted()
boolean	isProxiedResponse()
boolean	isRetransmission()
void	readExternal(ObjectInput in)
void	reset()
void	resetBuffer()
void	send()
void	send(boolean sendReliably)
void	sendReliably()
void	setBranchResponse(boolean branchResponse)
void	setBufferSize(int arg0)
void	setCharacterEncoding(String enc)
void	setLocale(Locale arg0)
void	setOriginalRequest(SipServletRequestImpl originalRequest)
void	setProxiedResponse(boolean isProxiedResponse)
void	setProxyBranch(MobicentsProxyBranch proxyBranch)
void	setStatus(int statusCode)
void	setStatus(int statusCode, String reasonPhrase)
void	writeExternal(ObjectOutput out)

Methods inherited from class org.mobicents.servlet.sip.message.SipServletMessageImpl

addAcceptLanguage, addAddressHeader, addHeader, addHeaderInternal, addParameterableHeader, containsRel100, countChars, createParameterable, equals, getAcceptLanguage, getAcceptLanguages, getAddressHeader, getAddressHeaders, getApplicationSession, getApplicationSession, getAppSessionId, getAttribute, getAttributeMap, getAttributeNames, getCallId, getCharacterEncoding, getCompactName, getContent, getContentLanguage, getContentLength, getContentType, getCorrectHeaderName, getCorrectHeaderName, getCurrentApplicationName, getDialog, getExpires, getFrom, getFullHeaderName, getHeader, getHeaderForm, getHeaderNames, getHeaders, getInitialRemoteAddr, getInitialRemotePort, getInitialTransport, getLocalAddr, getLocalPort, getMessage, getMethod, getParameterableHeader, getParameterableHeaders, getProtocol, getRawContent, getRemoteUser, getSession, getSession, getSipApplicationSession, getSipSession, getSipSessionKey, getTo, getTransaction, getTransactionApplicationData, getTransport, getUserPrincipal, hashCode, isAddressTypeHeader, isMessageSent, isOrphan, isParameterable, isSecure, isSystemHeader, isSystemHeaderAndNotGruu, isSystemHeaderAndNotGruu, isUserInRole, removeAttribute, removeHeader, removeHeaderInternal, setAcceptLanguage, setAddressHeader, setAppSessionId, setAttribute, setAttributeMap, setContent, setContentLanguage, setContentLength, setContentType, setCurrentApplicationName, setExpires, setHeader, setHeaderForm, setHeaderInternal, setOrphan, setParameterableHeader, setSipSession, setSipSessionKey, setTransaction, setTransport, setUserPrincipal, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mobicents.servlet.sip.core.message.MobicentsSipServletResponse

getDialog

Methods inherited from interface org.mobicents.servlet.sip.core.message.MobicentsSipServletMessage

getMessage, getSipApplicationSession, getSipSession, getTransaction, getTransactionApplicationData, isMessageSent, setSipSession, setTransaction

Methods inherited from interface org.mobicents.javax.servlet.sip.SipServletResponseExt

isOrphan, setOrphan

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, getMethod, getParameterableHeader, getParameterableHeaders, getProtocol, getRawContent, getRemoteUser, getSession, getSession, getTo, getTransport, getUserPrincipal, isSecure, isUserInRole, removeAttribute, removeHeader, setAcceptLanguage, setAddressHeader, setAttribute, setContent, setContentLanguage, setContentLength, setContentType, setExpires, setHeader, setHeaderForm, setParameterableHeader

Methods inherited from interface javax.servlet.ServletResponse

getCharacterEncoding, getContentType, setContentLength, setContentType

Constructor Detail

SipServletResponseImpl

public SipServletResponseImpl()

SipServletResponseImpl

protected SipServletResponseImpl(javax.sip.message.Response response,
                      SipFactoryImpl sipFactoryImpl,
                      javax.sip.Transaction transaction,
                      MobicentsSipSession session,
                      javax.sip.Dialog dialog,
                      boolean hasBeenReceived,
                      boolean isRetransmission)

Constructor

Parameters:

response -

sipFactoryImpl -

transaction -

session -

dialog -

originalRequest -

Method Detail

getResponse

public javax.sip.message.Response getResponse()

Returns:

the response

getModifiableRule

public AddressImpl.ModifiableRule getModifiableRule(String headerName)

Description copied from class: SipServletMessageImpl

Applications must not add, delete, or modify so-called "system" headers. These are header fields that the servlet container manages: From, To, Call-ID, CSeq, Via, Route (except through pushRoute), Record-Route. Contact is a system header field in messages other than REGISTER requests and responses, 3xx and 485 responses, and 200/OPTIONS responses. Additionally, for containers implementing the reliable provisional responses extension, RAck and RSeq are considered system headers also. This method should return true if passed name - full or compact is name of system header in context of this message. Each subclass has to implement it in the manner that it conforms to semantics of wrapping class

Specified by:

getModifiableRule in class SipServletMessageImpl

Parameters:

headerName - - either long or compact header name

Returns:

createAck

public SipServletRequest createAck()

Specified by:

createAck in interface SipServletResponse

createPrack

public SipServletRequest createPrack()
                              throws Rel100Exception

Specified by:

createPrack in interface SipServletResponse

Throws:

Rel100Exception

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Specified by:

getOutputStream in interface SipServletResponse

Throws:

IOException

getProxy

public Proxy getProxy()

Specified by:

getProxy in interface SipServletResponse

getReasonPhrase

public String getReasonPhrase()

Specified by:

getReasonPhrase in interface SipServletResponse

getRequest

public SipServletRequest getRequest()

Specified by:

getRequest in interface SipServletResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface SipServletResponse

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Specified by:

getWriter in interface SipServletResponse

Throws:

IOException

sendReliably

public void sendReliably()
                  throws Rel100Exception

Specified by:

sendReliably in interface SipServletResponse

Throws:

Rel100Exception

setStatus

public void setStatus(int statusCode)

Specified by:

setStatus in interface SipServletResponse

setStatus

public void setStatus(int statusCode,
             String reasonPhrase)

Specified by:

setStatus in interface SipServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Throws:

IOException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

setBufferSize

public void setBufferSize(int arg0)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

setLocale

public void setLocale(Locale arg0)

Specified by:

setLocale in interface javax.servlet.ServletResponse

send

public void send()
          throws IOException

Specified by:

send in interface SipServletMessage

Specified by:

send in interface SipServletResponse

Specified by:

send in class SipServletMessageImpl

Throws:

IOException

send

public void send(boolean sendReliably)
          throws IOException

Throws:

IOException

getChallengeRealms

public Iterator<String> getChallengeRealms()

Specified by:

getChallengeRealms in interface SipServletResponse

getProxyBranch

public ProxyBranch getProxyBranch()

Specified by:

getProxyBranch in interface SipServletResponse

setProxyBranch

public void setProxyBranch(MobicentsProxyBranch proxyBranch)

Specified by:

setProxyBranch in interface MobicentsSipServletResponse

isBranchResponse

public boolean isBranchResponse()

Specified by:

isBranchResponse in interface SipServletResponse

setBranchResponse

public void setBranchResponse(boolean branchResponse)

Specified by:

setBranchResponse in interface MobicentsSipServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

Specified by:

isCommitted in interface SipServletMessage

checkMessageState

protected void checkMessageState()

Specified by:

checkMessageState in class SipServletMessageImpl

setOriginalRequest

public void setOriginalRequest(SipServletRequestImpl originalRequest)

setProxiedResponse

public void setProxiedResponse(boolean isProxiedResponse)

Parameters:

isProxiedResponse - the isProxiedResponse to set

isProxiedResponse

public boolean isProxiedResponse()

Returns:

the isProxiedResponse

setCharacterEncoding

public void setCharacterEncoding(String enc)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

Specified by:

setCharacterEncoding in interface SipServletMessage

Overrides:

setCharacterEncoding in class SipServletMessageImpl

cleanUp

public void cleanUp()

Specified by:

cleanUp in class SipServletMessageImpl

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class SipServletMessageImpl

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class SipServletMessageImpl

Throws:

IOException

isRetransmission

public boolean isRetransmission()

Specified by:

isRetransmission in interface MobicentsSipServletResponse

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface SipServletMessage

Overrides:

getRemoteAddr in class SipServletMessageImpl

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface SipServletMessage

Overrides:

getRemotePort in class SipServletMessageImpl