io.pkts.packet.sip

Interface SipRequest

All Superinterfaces:

Cloneable, SipMessage

All Known Implementing Classes:

SipRequestImpl

public interface SipRequest
extends SipMessage

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SipRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SipRequest.Builder	ack(SipURI requestURI)
static SipRequest.Builder	ack(String requestURI)
static SipRequest.Builder	cancel(SipURI requestURI)
static SipRequest.Builder	cancel(String requestURI)
SipRequest	clone() Perform a deep clone of this SipMessage.
URI	getRequestUri() Get the request uri of the sip request
static SipRequest.Builder	invite(String requestURI) Factory method for creating a new INVITE request builder.
RouteHeader	popRouteHeader() Pop the top-most route header.
static SipRequest.Builder	request(Buffer method, String requestURI)

Methods inherited from interface io.pkts.packet.sip.SipMessage

addHeader, addHeaderFirst, createResponse, frame, frame, getCallIDHeader, getContactHeader, getContent, getContentTypeHeader, getCSeqHeader, getExpiresHeader, getFromHeader, getHeader, getHeader, getInitialLine, getMaxForwards, getMethod, getRawContent, getRecordRouteHeader, getRecordRouteHeaders, getRouteHeader, getRouteHeaders, getToHeader, getViaHeader, getViaHeaders, hasContent, isAck, isBye, isCancel, isInfo, isInitial, isInvite, isMessage, isOptions, isRegister, isRequest, isResponse, popHeader, setHeader, toBuffer, toRequest, toResponse, verify

Method Detail

getRequestUri

URI getRequestUri()
           throws SipParseException

Get the request uri of the sip request

Returns:

Throws:

SipParseException

popRouteHeader

RouteHeader popRouteHeader()

Pop the top-most route header. This is a convenience method for calling SipMessage.popHeader(Buffer).

Returns:

the top-most RouteHeader or null if this SipRequest contained no RouteHeaders.

clone

SipRequest clone()

Description copied from interface: SipMessage

Perform a deep clone of this SipMessage.

Specified by:

clone in interface SipMessage

Returns:

invite

static SipRequest.Builder invite(String requestURI)
                          throws SipParseException

Factory method for creating a new INVITE request builder.

Parameters:

requestURI - the request-uri of the INVITE request.

Returns:

a SipRequestBuilder

Throws:

SipParseException - in case the request uri cannot be parsed

ack

static SipRequest.Builder ack(String requestURI)
                       throws SipParseException

Throws:

SipParseException

ack

static SipRequest.Builder ack(SipURI requestURI)
                       throws SipParseException

Throws:

SipParseException

cancel

static SipRequest.Builder cancel(SipURI requestURI)
                          throws SipParseException

Throws:

SipParseException

cancel

static SipRequest.Builder cancel(String requestURI)
                          throws SipParseException

Throws:

SipParseException

request

static SipRequest.Builder request(Buffer method,
                                  String requestURI)
                           throws SipParseException

Throws:

SipParseException