|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gov.nist.javax.sip.parser.StringMsgParser
Parse SIP message and parts of SIP messages such as URI's etc from memory and return a structure. Intended use: UDP message processing. This class is used when you have an entire SIP message or SIPHeader or SIP URL in memory and you want to generate a parsed structure from it. For SIP messages, the payload can be binary or String. If you have a binary payload, use parseSIPMessage(byte[]) else use parseSIPMessage(String) The payload is accessible from the parsed message using the getContent and getContentBytes methods provided by the SIPMessage class. If SDP parsing is enabled using the parseContent method, then the SDP body is also parsed and can be accessed from the message using the getSDPAnnounce method. Currently only eager parsing of the message is supported (i.e. the entire message is parsed in one feld swoop).
Constructor Summary | |
StringMsgParser()
|
|
StringMsgParser(ParseExceptionListener exhandler)
Constructor (given a parse exception handler). |
Method Summary | |
String |
getCurrentHeader()
Get the current header. |
int |
getCurrentLineNumber()
Get the current line number. |
String[] |
getHeaders()
get the headers as an array of strings. |
AddressImpl |
parseAddress(String address)
Parse an address (nameaddr or address spec) and return and address structure. |
Host |
parseHost(String host)
Parse a host name and return a parsed structure. |
HostPort |
parseHostPort(String hostport)
Parse a host:port and return a parsed structure. |
SIPHeader |
parseSIPHeader(String header)
Parse an individual SIP message header from a string. |
gov.nist.javax.sip.message.SIPMessage |
parseSIPMessage(byte[] msgBuffer)
Parse a buffer containing a single SIP Message where the body is an array of un-interpreted bytes. |
gov.nist.javax.sip.message.SIPMessage |
parseSIPMessage(String sipMessages)
Parse a buffer containing one or more SIP Messages and return an array of SIPMessage parsed structures. |
RequestLine |
parseSIPRequestLine(String requestLine)
Parse the SIP Request Line |
StatusLine |
parseSIPStatusLine(String statusLine)
Parse the SIP Response message status line |
SipUri |
parseSIPUrl(String url)
Parse a SIP url from a string and return a URI structure for it. |
TelephoneNumber |
parseTelephoneNumber(String telephone_number)
Parse a telephone number return a parsed structure. |
GenericURI |
parseUrl(String url)
Parse a uri from a string and return a URI structure for it. |
void |
setParseExceptionListener(ParseExceptionListener pexhandler)
add a handler for header parsing errors. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public StringMsgParser()
public StringMsgParser(ParseExceptionListener exhandler)
exhandler
- is the parse exception listener for the message parser.Method Detail |
public void setParseExceptionListener(ParseExceptionListener pexhandler)
public gov.nist.javax.sip.message.SIPMessage parseSIPMessage(byte[] msgBuffer) throws ParseException
msgBuffer
- a byte buffer containing the messages to be parsed.
This can consist of multiple SIP Messages concatenated together.
SIPIllegalMessageException
- is thrown when an
illegal message has been encountered (and
the rest of the buffer is discarded).
ParseException
ParseExceptionListener
public gov.nist.javax.sip.message.SIPMessage parseSIPMessage(String sipMessages) throws ParseException
sipMessages
- a String containing the messages to be parsed.
This can consist of multiple SIP Messages concatenated together.
SIPIllegalMessageException
- is thrown when an
illegal message has been encountered (and
the rest of the buffer is discarded).
ParseException
ParseExceptionListener
public AddressImpl parseAddress(String address) throws ParseException
address
- is a String containing the address to be parsed.
ParseException
- when the address is badly formatted.public HostPort parseHostPort(String hostport) throws ParseException
hostport
- is a String containing the host:port to be parsed
throws
- a ParseException when the address is badly formatted.
ParseException
public Host parseHost(String host) throws ParseException
host
- is a String containing the host name to be parsed
throws
- a ParseException when the hostname is badly formatted.
ParseException
public TelephoneNumber parseTelephoneNumber(String telephone_number) throws ParseException
throws
- a ParseException when the address is badly formatted.
ParseException
public SipUri parseSIPUrl(String url) throws ParseException
url
- a String containing the URI structure to be parsed.
ParseException
- if there was an error parsing the message.public GenericURI parseUrl(String url) throws ParseException
url
- a String containing the URI structure to be parsed.
ParseException
- if there was an error parsing the message.public SIPHeader parseSIPHeader(String header) throws ParseException
header
- String containing the SIP header.
ParseException
- if there was an error parsing the message.public RequestLine parseSIPRequestLine(String requestLine) throws ParseException
requestLine
- a String containing the request line to be parsed.
ParseException
- if there was an error parsing the requestLine.public StatusLine parseSIPStatusLine(String statusLine) throws ParseException
statusLine
- a String containing the Status line to be parsed.
ParseException
- if there was an error parsingStatusLine
public String getCurrentHeader()
public String[] getHeaders()
public int getCurrentLineNumber()
|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |