org.echarts.servlet.sip.messages
Class Status

java.lang.Object
  extended by org.echarts.servlet.sip.messages.Request
      extended by org.echarts.servlet.sip.messages.Info
          extended by org.echarts.servlet.sip.messages.Status
All Implemented Interfaces:
java.lang.Cloneable, javax.servlet.ServletRequest, SipServletMessage, SipServletRequest, OtherRequest

public class Status
extends Info

Represents a received message conveying generic status information sent from another SIP Servlet application. This is a special type of Info request, containing a proprietary header marking it as such a request. The message content is text/xml, containing a type, as well as an arbitrary number of parameters. Status messages can be created via SipPort.createStatusMessage(type, props).


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.servlet.sip.SipServletMessage
SipServletMessage.HeaderForm
 
Field Summary
protected  StatusParser parser
           
protected  java.util.Properties properties
           
static java.lang.String STATUS_HEADER
           
protected  java.lang.String type
           
 
Constructor Summary
Status(SipServletRequest r)
           
 
Method Summary
 java.util.Properties getProperties()
          Get the properties used to create status message.
 java.lang.String getProperty(java.lang.String propName)
          Get the value of a specific property used to create status message.
 java.lang.String getType()
          Get the type used to create status message.
protected  void parse(java.lang.String content)
          Parse message body to obtain type and properties.
 java.lang.String toString()
           
 
Methods inherited from class org.echarts.servlet.sip.messages.Request
addAcceptLanguage, addAddressHeader, addAuthHeader, addAuthHeader, addHeader, addParameterableHeader, createCancel, createMessage, createResponse, createResponse, getAcceptLanguage, getAcceptLanguages, getAddressHeader, getAddressHeaders, getApplicationSession, getApplicationSession, getAttribute, getAttributeNames, getB2buaHelper, getCallId, getCharacterEncoding, getContent, getContentAsBytes, getContentAsString, getContentLanguage, getContentLength, getContentType, getExpires, getFrom, getHeader, getHeaderForm, getHeaderNames, getHeaders, getInitialPoppedRoute, getInitialRemoteAddr, getInitialRemotePort, getInitialTransport, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getMaxForwards, getMethod, getOriginalMessage, getParameter, getParameterableHeader, getParameterableHeaders, getParameterMap, getParameterNames, getParameterValues, getPoppedRoute, getProtocol, getProxy, getProxy, getRawContent, getReader, getRealPath, getRegion, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequestDispatcher, getRequestURI, getRoutingDirective, getScheme, getServerName, getServerPort, getSession, getSession, getSubscriberURI, getTo, getTransport, getUserPrincipal, isCommitted, isInitial, isSecure, isUserInRole, pushPath, pushRoute, pushRoute, removeAttribute, removeHeader, send, setAcceptLanguage, setAddressHeader, setAttribute, setCharacterEncoding, setContent, setContentLanguage, setContentLength, setContentType, setExpires, setHeader, setHeaderForm, setMaxForwards, setOriginalRequestURI, setParameterableHeader, setRequestURI, setRoutingDirective
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.servlet.sip.SipServletRequest
addAuthHeader, addAuthHeader, createCancel, createResponse, createResponse, getB2buaHelper, getInitialPoppedRoute, getInputStream, getMaxForwards, getPoppedRoute, getProxy, getProxy, getReader, getRegion, getRequestURI, getRoutingDirective, getSubscriberURI, isInitial, pushPath, pushRoute, pushRoute, send, setMaxForwards, setRequestURI, setRoutingDirective
 
Methods inherited from interface javax.servlet.ServletRequest
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding
 
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, getRemoteAddr, getRemotePort, getRemoteUser, getSession, getSession, getTo, getTransport, getUserPrincipal, isCommitted, isSecure, isUserInRole, removeAttribute, removeHeader, setAcceptLanguage, setAddressHeader, setAttribute, setCharacterEncoding, setContent, setContentLanguage, setContentLength, setContentType, setExpires, setHeader, setHeaderForm, setParameterableHeader
 

Field Detail

STATUS_HEADER

public static final java.lang.String STATUS_HEADER
See Also:
Constant Field Values

type

protected java.lang.String type

properties

protected java.util.Properties properties

parser

protected StatusParser parser
Constructor Detail

Status

public Status(SipServletRequest r)
       throws java.io.UnsupportedEncodingException,
              java.io.IOException,
              StatusParseException
Throws:
java.io.UnsupportedEncodingException
java.io.IOException
StatusParseException
Method Detail

parse

protected void parse(java.lang.String content)
              throws StatusParseException
Parse message body to obtain type and properties.

Parameters:
content -
Throws:
StatusParseException

getType

public java.lang.String getType()
Get the type used to create status message.

Returns:
type

getProperties

public java.util.Properties getProperties()
Get the properties used to create status message.

Returns:
properties

getProperty

public java.lang.String getProperty(java.lang.String propName)
Get the value of a specific property used to create status message.

Parameters:
propName -
Returns:
property value

toString

public java.lang.String toString()
Overrides:
toString in class Request