oracle.wsc.feature.webrtc.template.sip

Interface WscSipMessage

All Superinterfaces:

Serializable, WscMessage

All Known Subinterfaces:

WscSipRequest, WscSipResponse

public interface WscSipMessage
extends WscMessage

SIP Message interface.

Method Summary

Modifier and Type	Method and Description
void	addAddressHeader(String name, javax.servlet.sip.Address address, boolean first) Adds an address header.
void	addHeader(String name, String value) Adds header value.
void	addParameterableHeader(String name, javax.servlet.sip.Parameterable parameterable, boolean first) Adds a parameterable header.
void	enableSessionRefresh(boolean enable) Enable or disable the session refresh timer of the SIP session.
javax.servlet.sip.Address	getAddressHeader(String name) Gets address header by name.
ListIterator<javax.servlet.sip.Address>	getAddressHeaders(String name) Gets address header values by name.
Object	getContent() Gets message content.
int	getContentLength() Get message content length.
String	getContentType() Gets a message content type.
int	getExpires() Gets message expiry.
javax.servlet.sip.Address	getFrom() Gets the From address header.
String	getHeader(String name) Gets a specific header.
Iterator<String>	getHeaderNames() Gets all header names.
ListIterator<String>	getHeaders(String name) Gets the values of a specific header.
String	getMethod() Gets the SIP method.
javax.servlet.sip.Parameterable	getParameterableHeader(String name) Gets a parameterable header value.
ListIterator<? extends javax.servlet.sip.Parameterable>	getParameterableHeaders(String name) Gets parameterable header values.
String	getSdp() Gets an SDP string.
javax.servlet.sip.Address	getTo() Gets the To address header.
void	removeHeader(String name) Removes header.
void	setAddressHeader(String name, javax.servlet.sip.Address address) Sets an address header.
void	setContactUser(String user) Sets the SIP message Contact URI user parameter.
void	setContent(Object content, String contentType) Sets message content.
void	setContentLength(int len) Sets message content length.
void	setContentType(String type) Sets a message's content type.
void	setExpires(int expires) Sets message expiry.
void	setHeader(String name, String value) Sets header value.
void	setParameterableHeader(String name, javax.servlet.sip.Parameterable parameterable) Sets a parameterable header.
void	setSdp(String sdp) Sets an SDP string.
void	setSipContactParameter(String name, String value) Sets the SIP message contact parameter.
void	setSipContactUriParameter(String name, String value) Sets the SIP message Contact URI parameter.

Methods inherited from interface oracle.wsc.feature.webrtc.template.WscMessage

send

Method Detail

enableSessionRefresh

void enableSessionRefresh(boolean enable)

Enable or disable the session refresh timer of the SIP session.

Parameters:

enable - false to disable, true to enable

getFrom

javax.servlet.sip.Address getFrom()

Gets the From address header.

Returns:

From address header

See Also:

SipServletMessage.getFrom()

getTo

javax.servlet.sip.Address getTo()

Gets the To address header.

Returns:

To address header

See Also:

SipServletMessage.getTo()

getMethod

String getMethod()

Gets the SIP method.

Returns:

SIP method

See Also:

SipServletMessage.getMethod()

getHeader

String getHeader(String name)

Gets a specific header.

Parameters:

name - Header name

Returns:

Header value

See Also:

SipServletMessage.getHeader(String)

getHeaders

ListIterator<String> getHeaders(String name)

Gets the values of a specific header.

Parameters:

name - Header name

Returns:

Header values

See Also:

SipServletMessage.getHeaders(String)

getHeaderNames

Iterator<String> getHeaderNames()

Gets all header names.

Returns:

All header names

See Also:

SipServletMessage.getHeaderNames()

setHeader

void setHeader(String name,
               String value)

Sets header value.

Parameters:

name - Header name

value - Header value

See Also:

SipServletMessage.setHeader(String, String)

addHeader

void addHeader(String name,
               String value)

Adds header value.

Parameters:

name - Header name

value - Header value

See Also:

SipServletMessage.addHeader(String, String)

removeHeader

void removeHeader(String name)

Removes header.

Parameters:

name - Header name

See Also:

SipServletMessage.removeHeader(String)

getAddressHeader

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

Gets address header by name.

Parameters:

name - Header name

Returns:

Address header

Throws:

javax.servlet.sip.ServletParseException - ServletParseException

See Also:

SipServletMessage.getAddressHeader(String)

getAddressHeaders

ListIterator<javax.servlet.sip.Address> getAddressHeaders(String name)
                                                   throws javax.servlet.sip.ServletParseException

Gets address header values by name.

Parameters:

name - Header name

Returns:

Address header values

Throws:

javax.servlet.sip.ServletParseException - ServletParseException

See Also:

SipServletMessage.getAddressHeaders(String)

setAddressHeader

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

Sets an address header.

Parameters:

name - Header name

address - Address header value

See Also:

SipServletMessage.setAddressHeader(String, javax.servlet.sip.Address)

addAddressHeader

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

Adds an address header.

Parameters:

name - Header name

address - Address header value

first - If the first value

See Also:

SipServletMessage.addAddressHeader(String, javax.servlet.sip.Address, boolean)

getParameterableHeader

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

Gets a parameterable header value.

Parameters:

name - Header name

Returns:

Parameterable header

Throws:

javax.servlet.sip.ServletParseException - ServletParseException

See Also:

SipServletMessage.getParameterableHeader(String)

getParameterableHeaders

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

Gets parameterable header values.

Parameters:

name - Header name

Returns:

Parameterable header values

Throws:

javax.servlet.sip.ServletParseException - ServletParseException

See Also:

SipServletMessage.getParameterableHeaders(String)

setParameterableHeader

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

Sets a parameterable header.

Parameters:

name - Header name

parameterable - Header value

See Also:

SipServletMessage.setParameterableHeader(String, javax.servlet.sip.Parameterable)

addParameterableHeader

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

Adds a parameterable header.

Parameters:

name - Header name

parameterable - Header value

first - If the first value

See Also:

SipServletMessage.addParameterableHeader(String, javax.servlet.sip.Parameterable, boolean)

getExpires

int getExpires()

Gets message expiry.

Returns:

Expiry

See Also:

SipServletMessage.getExpires()

setExpires

void setExpires(int expires)

Sets message expiry.

Parameters:

expires - Expiry

See Also:

SipServletMessage.setExpires(int)

getContent

Object getContent()
           throws IOException

Gets message content.

Returns:

Message content

Throws:

IOException - IOException

See Also:

SipServletMessage.getContent()

getContentLength

int getContentLength()

Get message content length.

Returns:

Message content length

See Also:

SipServletMessage.getContentLength()

getContentType

String getContentType()

Gets a message content type.

Returns:

Message content type

See Also:

SipServletMessage.getContentType()

setContent

void setContent(Object content,
                String contentType)
         throws UnsupportedEncodingException

Sets message content.

Parameters:

content - Message content

contentType - Message content type

Throws:

UnsupportedEncodingException - UnsupportedEncodingException

See Also:

SipServletMessage.setContent(Object, String)

setContentLength

void setContentLength(int len)

Sets message content length.

Parameters:

len - Content length

See Also:

SipServletMessage.setContentLength(int)

setContentType

void setContentType(String type)

Sets a message's content type.

Parameters:

type - Content type

See Also:

SipServletMessage.setContentType(String)

setSipContactParameter

void setSipContactParameter(String name,
                            String value)

Sets the SIP message contact parameter.

Parameters:

name - Parameter name

value - Parameter value

setSipContactUriParameter

void setSipContactUriParameter(String name,
                               String value)

Sets the SIP message Contact URI parameter.

Parameters:

name - Parameter name

value - Parameter value

setContactUser

void setContactUser(String user)

Sets the SIP message Contact URI user parameter.

Parameters:

user - User parameter

getSdp

String getSdp()

Gets an SDP string.

Returns:

SDP or null

setSdp

void setSdp(String sdp)

Sets an SDP string.

Parameters:

sdp - SDP string