Package org.jainslee.resources.sip

Interface SipMessage

All Known Subinterfaces:

IncomingSipRequest, IncomingSipResponse, OutgoingSipRequest, OutgoingSipResponse, SipRequest, SipResponse, StatelessSipResponse

public interface SipMessage

Method Summary

Modifier and Type	Method	Description
void	addAcceptLanguage(Locale locale)
void	addAddressHeader(String headerName, Address address, boolean first)
void	addHeader(String headerName, String value)
void	addHeaderGeneric(String headerName, Object value, boolean first)
void	addParameterableHeader(String headerName, Parameterable header, boolean first)
Locale	getAcceptLanguage()
Iterator	getAcceptLanguages()
Address	getAddressHeader(String headerName)
ListIterator<Address>	getAddressHeaders(String headerName)
String	getCallId()
String	getCharacterEncoding()
Object	getContent()
Locale	getContentLanguage()
int	getContentLength()
String	getContentType()
int	getExpires()
Address	getFrom()
String	getHeader(String headerName)
Object	getHeaderGeneric(String headerName)	Gets the first header value of the named header where we don't know its type in advance.
Iterator<String>	getHeaderNames()
ListIterator<String>	getHeaders(String headerName)
ListIterator<Object>	getHeadersGeneric(String headerName)
String	getLocalAddr()
int	getLocalPort()
String	getMethod()
Parameterable	getParameterableHeader(String headerName)
ListIterator<Parameterable>	getParameterableHeaders(String headerName)
String	getProtocol()
byte[]	getRawContent()
String	getRemoteAddr()
int	getRemotePort()
String	getRemoteUser()
long	getSequenceNumber()
SipSession	getSession()
SipSession	getSession(boolean create)
Address	getTo()
String	getTransport()
Principal	getUserPrincipal()
boolean	isCommitted()
boolean	isExtensionRequired(String optionTag)	Convenience method to determine if this message contains a Require header value with the given option tag.
boolean	isExtensionSupported(String optionTag)	Convenience method to determine if this message contains a Supported header value with the given option tag.
boolean	isSecure()
boolean	isUserInRole(String role)
void	removeHeader(String headerName)
void	setAcceptLanguage(Locale locale)
void	setAddressHeader(String headerName, Address address)
void	setCharacterEncoding(String encoding)
void	setContent(Object content, String contentType)
void	setContentLanguage(Locale locale)
void	setContentType(String contentType)
void	setExpires(int i)
void	setHeader(String headerName, String value)
void	setHeaderGeneric(String headerName, Object value)
void	setParameterableHeader(String headerName, Parameterable header)

Method Detail

getFrom

Address getFrom()

getTo

Address getTo()

getMethod

String getMethod()

getSequenceNumber

long getSequenceNumber()

getProtocol

String getProtocol()

getHeader

String getHeader(String headerName)

getHeaders

ListIterator<String> getHeaders(String headerName)

getHeaderNames

Iterator<String> getHeaderNames()

setHeader

void setHeader(String headerName,
               String value)

addHeader

void addHeader(String headerName,
               String value)

removeHeader

void removeHeader(String headerName)

getAddressHeader

Address getAddressHeader(String headerName)
                  throws SipParseException

Throws:

SipParseException

getAddressHeaders

ListIterator<Address> getAddressHeaders(String headerName)
                                 throws SipParseException

Throws:

SipParseException

setAddressHeader

void setAddressHeader(String headerName,
                      Address address)

addAddressHeader

void addAddressHeader(String headerName,
                      Address address,
                      boolean first)

getParameterableHeader

Parameterable getParameterableHeader(String headerName)
                              throws SipParseException

Throws:

SipParseException

getParameterableHeaders

ListIterator<Parameterable> getParameterableHeaders(String headerName)
                                             throws SipParseException

Throws:

SipParseException

setParameterableHeader

void setParameterableHeader(String headerName,
                            Parameterable header)

addParameterableHeader

void addParameterableHeader(String headerName,
                            Parameterable header,
                            boolean first)

getHeaderGeneric

Object getHeaderGeneric(String headerName)

Gets the first header value of the named header where we don't know its type in advance.

Parameters:

headerName - the header name

Returns:

an instance of the most specific type: either Address, Parameterable or String in that order. The RA will perform the conversion and the caller can check the return value's type using instanceof.

getHeadersGeneric

ListIterator<Object> getHeadersGeneric(String headerName)

setHeaderGeneric

void setHeaderGeneric(String headerName,
                      Object value)

addHeaderGeneric

void addHeaderGeneric(String headerName,
                      Object value,
                      boolean first)

getCallId

String getCallId()

getExpires

int getExpires()

setExpires

void setExpires(int i)

getCharacterEncoding

String getCharacterEncoding()

setCharacterEncoding

void setCharacterEncoding(String encoding)
                   throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getContentLength

int getContentLength()

getContentType

String getContentType()

getRawContent

byte[] getRawContent()
              throws IOException

Throws:

IOException

getContent

Object getContent()
           throws IOException,
                  UnsupportedEncodingException

Throws:

IOException

UnsupportedEncodingException

setContent

void setContent(Object content,
                String contentType)
         throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

setContentType

void setContentType(String contentType)

getSession

SipSession getSession()

getSession

SipSession getSession(boolean create)

getAcceptLanguage

Locale getAcceptLanguage()

getAcceptLanguages

Iterator getAcceptLanguages()

setAcceptLanguage

void setAcceptLanguage(Locale locale)

addAcceptLanguage

void addAcceptLanguage(Locale locale)

setContentLanguage

void setContentLanguage(Locale locale)

getContentLanguage

Locale getContentLanguage()

isSecure

boolean isSecure()

isCommitted

boolean isCommitted()

getRemoteUser

String getRemoteUser()

isUserInRole

boolean isUserInRole(String role)

getUserPrincipal

Principal getUserPrincipal()

getLocalAddr

String getLocalAddr()

getLocalPort

int getLocalPort()

getRemoteAddr

String getRemoteAddr()

getRemotePort

int getRemotePort()

getTransport

String getTransport()

isExtensionSupported

boolean isExtensionSupported(String optionTag)

Convenience method to determine if this message contains a Supported header value with the given option tag. Examples of option tags are: "100rel", for RFC3262 reliable provisional responses support; and "timer", for RFC4028 session timer support.

Parameters:

optionTag - the option tag denoting the extension

Returns:

true if the message contains a Supported header value with the given option tag; otherwise false.

isExtensionRequired

boolean isExtensionRequired(String optionTag)

Convenience method to determine if this message contains a Require header value with the given option tag. Examples of option tags are: "100rel", for RFC3262 reliable provisional responses support; and "timer", for RFC4028 session timer support.

Parameters:

optionTag - the option tag denoting the extension

Returns:

true if the message contains a Require header value with the given option tag; otherwise false.