io.pkts.packet.sip.impl

Class SipInitialLine

java.lang.Object

io.pkts.packet.sip.impl.SipParser

io.pkts.packet.sip.impl.SipInitialLine

Direct Known Subclasses:

SipRequestLine, SipResponseLine

public abstract class SipInitialLine
extends SipParser

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested classes/interfaces inherited from class io.pkts.packet.sip.impl.SipParser

SipParser.HeaderValueState

Field Summary

Fields inherited from class io.pkts.packet.sip.impl.SipParser

ACK, AT, BACK_SLASH, BACKTICK, BYE, CANCEL, COLON, COMMA, CR, DASH, DOUBLE_QOUTE, DQUOT, EQ, EXCLAMATIONPOINT, framers, HTAB, INFO, INVITE, LAQUOT, LF, LPAREN, MADDR, MAX_LOOK_AHEAD, MESSAGE, METHOD, NOTIFY, OPTIONS, PERCENT, PERIOD, PLUS, PRACK, PUBLISH, QUESTIONMARK, RAQUOT, REFER, REGISTER, RPAREN, SCHEME_SIP, SCHEME_SIP_COLON, SCHEME_SIPS, SCHEME_SIPS_COLON, SCHEME_TEL, SCHEME_TEL_COLON, SCTP, SEMI, SIP2_0, SIP2_0_SLASH, SLASH, SP, STAR, SUBSCRIBE, TAG, TCP, TICK, TILDE, TLS, TRANSPORT, TRANSPORT_EQ, TTL, UDP, UNDERSCORE, UPDATE, USER, WS, WSS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SipInitialLine()

Method Summary

Modifier and Type	Method and Description
protected abstract SipInitialLine	clone()
abstract boolean	equals(Object other) Two initial lines are considered equal if: They are both a request or response line If response, their status codes are the same (the human readable reason is ignored) If request, the request-uri must be equal according to the rules of URI equality
abstract Buffer	getBuffer() The request initial line as a raw buffer.
abstract void	getBytes(Buffer dst) Write the bytes representing this SipInitialLine into the destination Buffer.
boolean	isRequestLine()
boolean	isResponseLine()
static boolean	isResponseLine(Buffer buffer) Simple method to check whether the supplied buffer could be a SIP response line.
static SipInitialLine	parse(Buffer buffer) Parse the buffer into a SIP initial line, which either can be a SipRequestLine or a SipResponseLine.
static SipInitialLine	parse(Buffer part1, Buffer part2, Buffer part3)
SipRequestLine	toRequestLine()
SipResponseLine	toResponseLine()

Methods inherited from class io.pkts.packet.sip.impl.SipParser

consumeAddressSpec, consumeAddressSpec, consumeAlphaNum, consumeCOLON, consumeCOMMA, consumeCRLF, consumeDisplayName, consumeEQUAL, consumeGenericParam, consumeGenericParams, consumeHostname, consumeLAQUOT, consumeLDQUOT, consumeLPAREN, consumeLWS, consumeMSubtype, consumeMType, consumePort, consumeQuotedString, consumeRAQUOT, consumeRDQUOT, consumeRPAREN, consumeSEMI, consumeSentBye, consumeSentProtocol, consumeSLASH, consumeSTAR, consumeSWS, consumeSWSAfterHColon, consumeToken, consumeUserInfoHostPort, consumeVia, consumeWS, couldBeSipMessage, couldBeSipMessage, expect, expect, expectDigit, expectHCOLON, expectHCOLONStreamFriendly, expectMethod, expectSIP2_0, expectSLASH, expectTel, expectToken, expectWS, frame, frame2, getAlphaNumCount, getFramer, getTokenCount, isAlpha, isAlpha, isAlphaNum, isAlphaNum, isDigit, isDigit, isHostPortCharacter, isHostPortCharacter, isNext, isNextAlphaNum, isNextDigit, isSCTP, isSCTPLower, isSips, isTCP, isTCPLower, isTLS, isTLSLower, isUDP, isUDPLower, isWS, isWSLower, isWSS, isWSSLower, nextHeader, nextHeaderName, nextHeaderNameDontCheckHColon, nextHeaders, readHeaderValues, readHeaderValues

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SipInitialLine

protected SipInitialLine()

Method Detail

equals

public abstract boolean equals(Object other)

Two initial lines are considered equal if:

• They are both a request or response line
• If response, their status codes are the same (the human readable reason is ignored)
• If request, the request-uri must be equal according to the rules of URI equality

Overrides:

equals in class Object

Parameters:

other -

Returns:

getBuffer

public abstract Buffer getBuffer()

The request initial line as a raw buffer.

Returns:

isResponseLine

public static boolean isResponseLine(Buffer buffer)
                              throws IOException

Simple method to check whether the supplied buffer could be a SIP response line. Hence, does it start with SIP/2.0 or not. Note, if this method returns false it does not necessarily mean that this is a request line but if you have already determined that that the incoming data could be a SIP message (e.g. by using the method SipFramer#couldBeSipMessage(Buffer)) then it is very likely that it is a request line.

Returns:

Throws:

IOException

IndexOutOfBoundsException

parse

public static final SipInitialLine parse(Buffer buffer)
                                  throws SipParseException

Parse the buffer into a SIP initial line, which either can be a SipRequestLine or a SipResponseLine. The parsing will only check so that a few things are correct but in general it doesn't do any deeper analysis of the initial line. To make sure that the resulting sip message actually is correct, call the SipMessage.verify() method, which will do a deeper analysis of the sip message

Parameters:

buffer -

Returns:

Throws:

SipParseException

parse

public static final SipInitialLine parse(Buffer part1,
                                         Buffer part2,
                                         Buffer part3)
                                  throws SipParseException

Throws:

SipParseException

toRequestLine

public SipRequestLine toRequestLine()

toResponseLine

public SipResponseLine toResponseLine()

isResponseLine

public boolean isResponseLine()

isRequestLine

public boolean isRequestLine()

getBytes

public abstract void getBytes(Buffer dst)

Write the bytes representing this SipInitialLine into the destination Buffer.

Parameters:

dst -

clone

protected abstract SipInitialLine clone()

Overrides:

clone in class Object