com.avaya.collaboration.call.sip

Interface SipResponse

public interface SipResponse

Wrapper class of javax.servlet.sip.SipServletResponse.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value) Adds a header with the given name and value.
SipAddress	getAddressHeader(String name) Returns the value of the specified header as a Address object.
ListIterator	getAddressHeaders(String name) Returns a ListIterator over all Address header field values for the specified header.
String	getContentType() Returns the value of the Content-Type header field.
SipAddress	getFrom() Returns the value of the From header.
String	getHeader(String name) Returns the value of the specified header as a String.
Iterator	getHeaderNames() Returns an Iterator over all the header names this message contains.
ListIterator	getHeaders(String name) Returns all the values of the specified header as a ListIterator over a number of String objects.
String	getMethod() Returns the SIP method of this message.
byte[]	getRawContent() Returns message content as a byte array.
String	getReasonPhrase() Returns the reason phrase for this response object.
int	getStatus() Returns the status code of this response object.
SipAddress	getTo() Returns the value of the To header.
void	removeHeader(String name) Removes the specified header.
void	setHeader(String name, String value) Sets a header with the given name and value.

Method Detail

getReasonPhrase

String getReasonPhrase()

Returns the reason phrase for this response object. Wrapper method of javax.servlet.sip.SipServletResponse#getReasonPhrase().

Returns:

reason phrase for this response

getStatus

int getStatus()

Returns the status code of this response object. Wrapper method of javax.servlet.sip.SipServletResponse#getStatus().

Returns:

status code of this response

addHeader

void addHeader(String name,
             String value)

Adds a header with the given name and value. This method allows headers to have multiple values. The container MAY check that the specified header field can legally appear in this message. Wrapper method of javax.servlet.sip.SipServletMessage#addHeader(String, String).

Parameters:

name - a String specifying the header name, either the long or compact form

value - the additional header value

Throws:

IllegalArgumentException - if the specified header field is a system header or if it cannot legally appear in this message. If either name or value are null.

getAddressHeader

SipAddress getAddressHeader(String name)

Returns the value of the specified header as a Address object. Wrapper method of javax.servlet.sip.SipServletMessage#getAddressHeader(String).

Parameters:

name - a case insensitive String specifying the name of the header, either the long or compact form

Returns:

value of the header as an Address

Throws:

IllegalStateException - if the specified header field cannot be parsed as a SIP address object

IllegalArgumentException - if name is null.

getAddressHeaders

ListIterator getAddressHeaders(String name)

Returns a ListIterator over all Address header field values for the specified header. The values returned by the Iterator follow the order in which they appear in the message header. Wrapper method of javax.servlet.sip.SipServletMessage#getAddressHeaders(String) .

Parameters:

name - a case insensitive String specifying the name of the header field, either the long or compact form

Returns:

a ListIterator over the Address values of the specified header field

Throws:

IllegalStateException - if the specified header field cannot be parsed as a SIP address object

IllegalArgumentException - if name is null.

getHeader

String getHeader(String name)

Returns the value of the specified header as a String. If the message did not include a header of the specified name, this method returns null. If the message included a header of the specified name with no value, this method returns an empty String. If multiple headers exist, the first one is returned. The header name is case insensitive. Wrapper method of javax.servlet.sip.SipServletMessage#getHeader(String).

Parameters:

name - a String specifying the header name, either the long or compact form

Returns:

a String containing the value of the requested header, or null if the message does not have a header of that name

Throws:

IllegalArgumentException - if name is null.

getHeaderNames

Iterator getHeaderNames()

Returns an Iterator over all the header names this message contains. If the message has no headers, this method returns an empty Iterator. Wrapper method of javax.servlet.sip.SipServletMessage#getHeaderNames().

Returns:

an Iterator over the names of all header fields present within this message; if the message has no header fields, an empty enumeration; if the servlet container does not allow servlets to use this method, null

getHeaders

ListIterator getHeaders(String name)

Returns all the values of the specified header as a ListIterator over a number of String objects. The values returned by the Iterator follow the order in which they appear in the message header. Wrapper method of javax.servlet.sip.SipServletMessage#getHeaders(String).

Parameters:

name - a String specifying the header name, either the long or compact form

Returns:

a ListIterator over the String values of the specified header field

Throws:

IllegalArgumentException - if name is null.

getFrom

SipAddress getFrom()

Returns the value of the From header. Wrapper method of javax.servlet.sip.SipServletMessage#getFrom().

Returns:

internal representation of the From header

getTo

SipAddress getTo()

Returns the value of the To header. Wrapper method of javax.servlet.sip.SipServletMessage#getTo().

Returns:

internal representation of the To header

getMethod

String getMethod()

Returns the SIP method of this message. This is a token consisting of all upper-case letters, for example "INVITE". Wrapper method of javax.servlet.sip.SipServletMessage#getMethod().

Returns:

the SIP method of this SipRequest

getRawContent

byte[] getRawContent()
                     throws IOException

Returns message content as a byte array. The reference is returned if the service wants to re-use the content for another message it should make a copy. Wrapper method of javax.servlet.sip.SipServletMessage#getRawContent().

Returns:

message content as a raw byte array, or null if no content is set

Throws:

IOException - if an IOException occurred

removeHeader

void removeHeader(String name)

Removes the specified header. If multiple headers exists with the given name, they're all removed. Wrapper method of javax.servlet.sip.SipServletMessage#removeHeader(String).

Parameters:

name - a String specifying the header name, either the long or compact form

Throws:

IllegalArgumentException - if the specified header field is a system header or null.

getContentType

String getContentType()

Returns the value of the Content-Type header field. Wrapper method of javax.servlet.sip.SipServletMessage#getContentType().

Returns:

a String containing the name of the MIME type of this message, or null if the body is empty

setHeader

void setHeader(String name,
             String value)

Sets a header with the given name and value. If the header had already been set, the new value overwrites the previous one. If there are multiple headers with the same name, they all are replaced by this header name, value pair. Wrapper method of javax.servlet.sip.SipServletMessage#setHeader(String,String).

Parameters:

name - a String specifying the header name, either the long or compact form

value - the header value

Throws:

IllegalArgumentException - if the specified header field is a system header or any of arguments are null.