org.cipango.server

Class SipMessage

java.lang.Object

org.cipango.server.SipMessage

All Implemented Interfaces:

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

Direct Known Subclasses:

SipRequest, SipResponse

public abstract class SipMessage
extends java.lang.Object
implements javax.servlet.sip.SipServletMessage

Nested Class Summary

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

javax.servlet.sip.SipServletMessage.HeaderForm

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_characterEncoding
protected SipFields	_fields
protected java.lang.String	_method
protected Session	_session
protected SipMethod	_sipMethod

Constructor Summary

Constructors

Constructor and Description
SipMessage()
SipMessage(SipMessage other)

Method Summary

Modifier and Type	Method and Description
void	addAcceptLanguage(java.util.Locale locale)
void	addAddressHeader(java.lang.String name, javax.servlet.sip.Address address, boolean first)
void	addHeader(java.lang.String name, java.lang.String value)
void	addParameterableHeader(java.lang.String name, javax.servlet.sip.Parameterable parameterable, boolean first)
ApplicationSession	appSession()
protected abstract boolean	canSetContact()
AddressImpl	from()
java.util.Locale	getAcceptLanguage()
java.util.Iterator<java.util.Locale>	getAcceptLanguages()
javax.servlet.sip.Address	getAddressHeader(java.lang.String name)
java.util.ListIterator<javax.servlet.sip.Address>	getAddressHeaders(java.lang.String name)
javax.servlet.sip.SipApplicationSession	getApplicationSession()
javax.servlet.sip.SipApplicationSession	getApplicationSession(boolean create)
java.lang.Object	getAttribute(java.lang.String name)
java.util.Enumeration<java.lang.String>	getAttributeNames()
java.lang.String	getCallId()
java.lang.String	getCharacterEncoding()
SipConnection	getConnection()
java.lang.Object	getContent()
java.util.Locale	getContentLanguage()
int	getContentLength()
long	getContentLengthLong()
java.lang.String	getContentType()
CSeq	getCSeq()
int	getExpires()
SipFields	getFields()
javax.servlet.sip.Address	getFrom()
SipServletHolder	getHandler()
java.lang.String	getHeader(java.lang.String name)
javax.servlet.sip.SipServletMessage.HeaderForm	getHeaderForm()
java.util.Iterator<java.lang.String>	getHeaderNames()
java.util.ListIterator<java.lang.String>	getHeaders(java.lang.String name)
java.lang.String	getInitialRemoteAddr()
int	getInitialRemotePort()
java.lang.String	getInitialTransport()
java.lang.String	getLocalAddr()
int	getLocalPort()
javax.servlet.sip.Parameterable	getParameterableHeader(java.lang.String name)
java.util.ListIterator<? extends javax.servlet.sip.Parameterable>	getParameterableHeaders(java.lang.String name)
java.lang.String	getProtocol()
byte[]	getRawContent()
java.lang.String	getRemoteAddr()
int	getRemotePort()
java.lang.String	getRemoteUser()
javax.servlet.sip.SipSession	getSession()
javax.servlet.sip.SipSession	getSession(boolean create)
SipMethod	getSipMethod()
long	getTimeStamp()
javax.servlet.sip.Address	getTo()
Via	getTopVia()
java.lang.String	getToTag()
abstract Transaction	getTransaction()
java.lang.String	getTransport()
org.eclipse.jetty.server.UserIdentity	getUserIdentity()
java.security.Principal	getUserPrincipal()
boolean	isAck()
boolean	isBye()
boolean	isCancel()
boolean	isCommitted()
boolean	isInvite()
boolean	isMethod(SipMethod method)
boolean	isNotify()
boolean	isPrack()
boolean	isRegister()
abstract boolean	isRequest()
boolean	isSecure()
boolean	isSubscribe()
protected boolean	isSystemHeader(SipHeader header)
boolean	isUpdate()
boolean	isUserInRole(java.lang.String role)
abstract boolean	needsContact()
void	removeAttribute(java.lang.String name)
void	removeHeader(java.lang.String name)
Via	removeTopVia()
Session	session()
void	setAcceptLanguage(java.util.Locale locale)
void	setAddressHeader(java.lang.String name, javax.servlet.sip.Address address)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setCharacterEncoding(java.lang.String encoding)
void	setCommitted(boolean b)
void	setConnection(SipConnection connection)
void	setContent(java.lang.Object o, java.lang.String type)
void	setContentLanguage(java.util.Locale locale)
void	setContentLength(int length)
void	setContentType(java.lang.String contentType)
void	setExpires(int seconds)
void	setHandler(SipServletHolder handler)
void	setHeader(java.lang.String name, java.lang.String value)
void	setHeaderForm(javax.servlet.sip.SipServletMessage.HeaderForm form)
void	setInitialRemoteAddr(java.lang.String initialRemoteAddr)
void	setInitialRemotePort(int initialRemotePort)
void	setInitialTransport(java.lang.String initialTransport)
void	setParameterableHeader(java.lang.String name, javax.servlet.sip.Parameterable parameterable)
void	setSession(Session session)
void	setTimeStamp(long ts)
void	setUserIdentity(org.eclipse.jetty.server.UserIdentity userIdentity)
AddressImpl	to()
abstract java.lang.String	toStringCompact()

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.sip.SipServletMessage

getMethod, send

Field Detail

_fields

protected final SipFields _fields

_characterEncoding

protected java.lang.String _characterEncoding

_session

protected Session _session

_sipMethod

protected SipMethod _sipMethod

_method

protected java.lang.String _method

Constructor Detail

SipMessage

public SipMessage()

SipMessage

public SipMessage(SipMessage other)

Method Detail

isRegister

public boolean isRegister()

isInvite

public boolean isInvite()

isAck

public boolean isAck()

isCancel

public boolean isCancel()

isBye

public boolean isBye()

isPrack

public boolean isPrack()

isSubscribe

public boolean isSubscribe()

isNotify

public boolean isNotify()

isUpdate

public boolean isUpdate()

isMethod

public boolean isMethod(SipMethod method)

getSipMethod

public SipMethod getSipMethod()

isSystemHeader

protected boolean isSystemHeader(SipHeader header)

getFields

public SipFields getFields()

setTimeStamp

public void setTimeStamp(long ts)

getTimeStamp

public long getTimeStamp()

setConnection

public void setConnection(SipConnection connection)

getConnection

public SipConnection getConnection()

setSession

public void setSession(Session session)

isRequest

public abstract boolean isRequest()

canSetContact

protected abstract boolean canSetContact()

needsContact

public abstract boolean needsContact()

toStringCompact

public abstract java.lang.String toStringCompact()

getTransaction

public abstract Transaction getTransaction()

getTopVia

public Via getTopVia()

getCSeq

public CSeq getCSeq()

getToTag

public java.lang.String getToTag()

from

public AddressImpl from()

to

public AddressImpl to()

session

public Session session()

appSession

public ApplicationSession appSession()

addAcceptLanguage

public void addAcceptLanguage(java.util.Locale locale)

Specified by:

addAcceptLanguage in interface javax.servlet.sip.SipServletMessage

addAddressHeader

public void addAddressHeader(java.lang.String name,
                             javax.servlet.sip.Address address,
                             boolean first)

Specified by:

addAddressHeader in interface javax.servlet.sip.SipServletMessage

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Specified by:

addHeader in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.addHeader(String, String)

addParameterableHeader

public void addParameterableHeader(java.lang.String name,
                                   javax.servlet.sip.Parameterable parameterable,
                                   boolean first)

Specified by:

addParameterableHeader in interface javax.servlet.sip.SipServletMessage

getAcceptLanguage

public java.util.Locale getAcceptLanguage()

Specified by:

getAcceptLanguage in interface javax.servlet.sip.SipServletMessage

getAcceptLanguages

public java.util.Iterator<java.util.Locale> getAcceptLanguages()

Specified by:

getAcceptLanguages in interface javax.servlet.sip.SipServletMessage

getAddressHeader

public javax.servlet.sip.Address getAddressHeader(java.lang.String name)
                                           throws javax.servlet.sip.ServletParseException

Specified by:

getAddressHeader in interface javax.servlet.sip.SipServletMessage

Throws:

javax.servlet.sip.ServletParseException

getAddressHeaders

public java.util.ListIterator<javax.servlet.sip.Address> getAddressHeaders(java.lang.String name)
                                                                    throws javax.servlet.sip.ServletParseException

Specified by:

getAddressHeaders in interface javax.servlet.sip.SipServletMessage

Throws:

javax.servlet.sip.ServletParseException

getApplicationSession

public javax.servlet.sip.SipApplicationSession getApplicationSession()

Specified by:

getApplicationSession in interface javax.servlet.sip.SipServletMessage

getApplicationSession

public javax.servlet.sip.SipApplicationSession getApplicationSession(boolean create)

Specified by:

getApplicationSession in interface javax.servlet.sip.SipServletMessage

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Specified by:

getAttribute in interface javax.servlet.sip.SipServletMessage

getAttributeNames

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

Specified by:

getAttributeNames in interface javax.servlet.sip.SipServletMessage

getCallId

public java.lang.String getCallId()

Specified by:

getCallId in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getCallId()

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.sip.SipServletMessage

getContent

public java.lang.Object getContent()
                            throws java.io.IOException,
                                   java.io.UnsupportedEncodingException

Specified by:

getContent in interface javax.servlet.sip.SipServletMessage

Throws:

java.io.IOException

java.io.UnsupportedEncodingException

getContentLanguage

public java.util.Locale getContentLanguage()

Specified by:

getContentLanguage in interface javax.servlet.sip.SipServletMessage

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface javax.servlet.sip.SipServletMessage

getContentLengthLong

public long getContentLengthLong()

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.sip.SipServletMessage

getExpires

public int getExpires()

Specified by:

getExpires in interface javax.servlet.sip.SipServletMessage

getFrom

public javax.servlet.sip.Address getFrom()

Specified by:

getFrom in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getFrom()

getHeader

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

Specified by:

getHeader in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getHeader(String)

getHeaderForm

public javax.servlet.sip.SipServletMessage.HeaderForm getHeaderForm()

Specified by:

getHeaderForm in interface javax.servlet.sip.SipServletMessage

getHeaderNames

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

Specified by:

getHeaderNames in interface javax.servlet.sip.SipServletMessage

getHeaders

public java.util.ListIterator<java.lang.String> getHeaders(java.lang.String name)

Specified by:

getHeaders in interface javax.servlet.sip.SipServletMessage

getInitialRemoteAddr

public java.lang.String getInitialRemoteAddr()

Specified by:

getInitialRemoteAddr in interface javax.servlet.sip.SipServletMessage

getInitialRemotePort

public int getInitialRemotePort()

Specified by:

getInitialRemotePort in interface javax.servlet.sip.SipServletMessage

getInitialTransport

public java.lang.String getInitialTransport()

Specified by:

getInitialTransport in interface javax.servlet.sip.SipServletMessage

getLocalAddr

public java.lang.String getLocalAddr()

Specified by:

getLocalAddr in interface javax.servlet.sip.SipServletMessage

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface javax.servlet.sip.SipServletMessage

getParameterableHeader

public javax.servlet.sip.Parameterable getParameterableHeader(java.lang.String name)
                                                       throws javax.servlet.sip.ServletParseException

Specified by:

getParameterableHeader in interface javax.servlet.sip.SipServletMessage

Throws:

javax.servlet.sip.ServletParseException

getParameterableHeaders

public java.util.ListIterator<? extends javax.servlet.sip.Parameterable> getParameterableHeaders(java.lang.String name)
                                                                                          throws javax.servlet.sip.ServletParseException

Specified by:

getParameterableHeaders in interface javax.servlet.sip.SipServletMessage

Throws:

javax.servlet.sip.ServletParseException

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface javax.servlet.sip.SipServletMessage

getRawContent

public byte[] getRawContent()

Specified by:

getRawContent in interface javax.servlet.sip.SipServletMessage

getRemoteAddr

public java.lang.String getRemoteAddr()

Specified by:

getRemoteAddr in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getRemoteAddr()

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getRemotePort()

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in interface javax.servlet.sip.SipServletMessage

getSession

public javax.servlet.sip.SipSession getSession()

Specified by:

getSession in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getSession()

getSession

public javax.servlet.sip.SipSession getSession(boolean create)

Specified by:

getSession in interface javax.servlet.sip.SipServletMessage

getTo

public javax.servlet.sip.Address getTo()

Specified by:

getTo in interface javax.servlet.sip.SipServletMessage

getTransport

public java.lang.String getTransport()

Specified by:

getTransport in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.getTransport()

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.servlet.sip.SipServletMessage

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.sip.SipServletMessage

See Also:

SipServletMessage.isCommitted()

setCommitted

public void setCommitted(boolean b)

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.servlet.sip.SipServletMessage

isUserInRole

public boolean isUserInRole(java.lang.String role)

Specified by:

isUserInRole in interface javax.servlet.sip.SipServletMessage

removeAttribute

public void removeAttribute(java.lang.String name)

Specified by:

removeAttribute in interface javax.servlet.sip.SipServletMessage

removeHeader

public void removeHeader(java.lang.String name)

Specified by:

removeHeader in interface javax.servlet.sip.SipServletMessage

setAcceptLanguage

public void setAcceptLanguage(java.util.Locale locale)

Specified by:

setAcceptLanguage in interface javax.servlet.sip.SipServletMessage

setAddressHeader

public void setAddressHeader(java.lang.String name,
                             javax.servlet.sip.Address address)

Specified by:

setAddressHeader in interface javax.servlet.sip.SipServletMessage

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Specified by:

setAttribute in interface javax.servlet.sip.SipServletMessage

setCharacterEncoding

public void setCharacterEncoding(java.lang.String encoding)
                          throws java.io.UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface javax.servlet.sip.SipServletMessage

Throws:

java.io.UnsupportedEncodingException

setContent

public void setContent(java.lang.Object o,
                       java.lang.String type)
                throws java.io.UnsupportedEncodingException

Specified by:

setContent in interface javax.servlet.sip.SipServletMessage

Throws:

java.io.UnsupportedEncodingException

setContentLanguage

public void setContentLanguage(java.util.Locale locale)

Specified by:

setContentLanguage in interface javax.servlet.sip.SipServletMessage

setContentLength

public void setContentLength(int length)

Specified by:

setContentLength in interface javax.servlet.sip.SipServletMessage

setContentType

public void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface javax.servlet.sip.SipServletMessage

setExpires

public void setExpires(int seconds)

Specified by:

setExpires in interface javax.servlet.sip.SipServletMessage

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Specified by:

setHeader in interface javax.servlet.sip.SipServletMessage

setHeaderForm

public void setHeaderForm(javax.servlet.sip.SipServletMessage.HeaderForm form)

Specified by:

setHeaderForm in interface javax.servlet.sip.SipServletMessage

setParameterableHeader

public void setParameterableHeader(java.lang.String name,
                                   javax.servlet.sip.Parameterable parameterable)

Specified by:

setParameterableHeader in interface javax.servlet.sip.SipServletMessage

getHandler

public SipServletHolder getHandler()

setHandler

public void setHandler(SipServletHolder handler)

setInitialRemoteAddr

public void setInitialRemoteAddr(java.lang.String initialRemoteAddr)

setInitialRemotePort

public void setInitialRemotePort(int initialRemotePort)

setInitialTransport

public void setInitialTransport(java.lang.String initialTransport)

getUserIdentity

public org.eclipse.jetty.server.UserIdentity getUserIdentity()

setUserIdentity

public void setUserIdentity(org.eclipse.jetty.server.UserIdentity userIdentity)

removeTopVia

public Via removeTopVia()