io.pkts.packet.sip

Interface SipRequest

All Superinterfaces:

Cloneable, SipMessage

All Known Implementing Classes:

ImmutableSipRequest

public interface SipRequest
extends SipMessage

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SipRequest.Builder

Field Summary

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

UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION

Method Summary

Modifier and Type	Method and Description
static SipRequest.Builder	ack(String requestURI)
static SipRequest.Builder	ack(URI requestURI)
static SipRequest.Builder	bye(String requestURI)
static SipRequest.Builder	bye(URI requestURI)
static SipRequest.Builder	cancel(SipURI requestURI)
static SipRequest.Builder	cancel(String requestURI)
SipRequest	clone() Perform a deep clone of this SipMessage.
SipRequest.Builder	copy()
URI	getRequestUri() Get the request uri of the sip request
static SipRequest.Builder	info(String requestURI)
static SipRequest.Builder	info(URI requestURI)
static SipRequest.Builder	invite(String requestURI) Factory method for creating a new INVITE request builder.
static SipRequest.Builder	invite(URI requestURI)
default boolean	isRequest() Check whether this sip message is a request or not
static SipRequest.Builder	message(String requestURI)
static SipRequest.Builder	message(URI requestURI)
default SipResponse	methodNotAllowed() Convenience method for just replying with a 405 Method Not Allowed to a request.
static SipRequest.Builder	notify(String requestURI)
static SipRequest.Builder	notify(URI requestURI)
default SipResponse	ok() Convenience method for just replying with a 200 to a request.
static SipRequest.Builder	options(String requestURI)
static SipRequest.Builder	options(URI requestURI)
default RouteHeader	popRouteHeader() Pop the top-most route header.
static SipRequest.Builder	prack(String requestURI)
static SipRequest.Builder	prack(URI requestURI)
static SipRequest.Builder	publish(String requestURI)
static SipRequest.Builder	publish(URI requestURI)
static SipRequest.Builder	refer(String requestURI)
static SipRequest.Builder	refer(URI requestURI)
static SipRequest.Builder	register(String requestURI)
static SipRequest.Builder	register(URI requestURI)
static SipRequest.Builder	request(Buffer method, String requestURI)
static SipRequest.Builder	request(Buffer method, URI requestURI)
static SipRequest.Builder	subscribe(String requestURI)
static SipRequest.Builder	subscribe(URI requestURI)
default SipRequest	toRequest() Got tired of casting the SipMessage into a SipRequest so you can use this method instead.
static SipRequest.Builder	update(String requestURI)
static SipRequest.Builder	update(URI requestURI)
static SipRequest.Builder	withMethod(Buffer method)
static SipRequest.Builder	withMethod(String method)

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

countNoOfHeaders, createResponse, createResponse, frame, frame, frame, getAllHeaders, getCallIDHeader, getContactHeader, getContent, getContentLength, getContentTypeHeader, getCSeqHeader, getExpiresHeader, getFromHeader, getHeader, getHeader, getHeaders, getHeaders, getInitialLine, getMaxForwards, getMethod, getRecordRouteHeader, getRecordRouteHeaders, getRouteHeader, getRouteHeaders, getToHeader, getViaHeader, getViaHeaders, hasContent, initialLine, is100Trying, isAck, isBye, isByeRequest, isCancel, isCancelRequest, isClientError, isError, isFinal, isFinalNon2xx, isGlobalError, isInfo, isInfoRequest, isInitial, isInvite, isInviteRequest, isMessage, isMessageRequest, isOptions, isOptionsRequest, isProvisional, isRedirect, isRegister, isRegisterRequest, isResponse, isRinging, isServerError, isSubsequent, isSuccess, isTimeout, toBuffer, toResponse, verify

Method Detail

getRequestUri

URI getRequestUri()
           throws SipParseException

Get the request uri of the sip request

Returns:

Throws:

SipParseException

popRouteHeader

default 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:

toRequest

default SipRequest toRequest()
                      throws ClassCastException

Description copied from interface: SipMessage

Got tired of casting the SipMessage into a SipRequest so you can use this method instead. Just a short cut for: (SipRequest)sipMessage;

Specified by:

toRequest in interface SipMessage

Returns:

this but casted into a SipRequest

Throws:

ClassCastException - in case this SipMessage is actually a SipResponse.

isRequest

default boolean isRequest()

Description copied from interface: SipMessage

Check whether this sip message is a request or not

Specified by:

isRequest 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

invite

static SipRequest.Builder invite(URI requestURI)
                          throws SipParseException

Throws:

SipParseException

ack

static SipRequest.Builder ack(String requestURI)
                       throws SipParseException

Throws:

SipParseException

ack

static SipRequest.Builder ack(URI 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

bye

static SipRequest.Builder bye(String requestURI)
                       throws SipParseException

Throws:

SipParseException

bye

static SipRequest.Builder bye(URI requestURI)
                       throws SipParseException

Throws:

SipParseException

register

static SipRequest.Builder register(String requestURI)
                            throws SipParseException

Throws:

SipParseException

register

static SipRequest.Builder register(URI requestURI)
                            throws SipParseException

Throws:

SipParseException

update

static SipRequest.Builder update(String requestURI)
                          throws SipParseException

Throws:

SipParseException

update

static SipRequest.Builder update(URI requestURI)
                          throws SipParseException

Throws:

SipParseException

subscribe

static SipRequest.Builder subscribe(String requestURI)
                             throws SipParseException

Throws:

SipParseException

subscribe

static SipRequest.Builder subscribe(URI requestURI)
                             throws SipParseException

Throws:

SipParseException

notify

static SipRequest.Builder notify(String requestURI)
                          throws SipParseException

Throws:

SipParseException

notify

static SipRequest.Builder notify(URI requestURI)
                          throws SipParseException

Throws:

SipParseException

publish

static SipRequest.Builder publish(String requestURI)
                           throws SipParseException

Throws:

SipParseException

publish

static SipRequest.Builder publish(URI requestURI)
                           throws SipParseException

Throws:

SipParseException

info

static SipRequest.Builder info(String requestURI)
                        throws SipParseException

Throws:

SipParseException

info

static SipRequest.Builder info(URI requestURI)
                        throws SipParseException

Throws:

SipParseException

options

static SipRequest.Builder options(String requestURI)
                           throws SipParseException

Throws:

SipParseException

options

static SipRequest.Builder options(URI requestURI)
                           throws SipParseException

Throws:

SipParseException

prack

static SipRequest.Builder prack(String requestURI)
                         throws SipParseException

Throws:

SipParseException

prack

static SipRequest.Builder prack(URI requestURI)
                         throws SipParseException

Throws:

SipParseException

refer

static SipRequest.Builder refer(String requestURI)
                         throws SipParseException

Throws:

SipParseException

refer

static SipRequest.Builder refer(URI requestURI)
                         throws SipParseException

Throws:

SipParseException

message

static SipRequest.Builder message(String requestURI)
                           throws SipParseException

Throws:

SipParseException

message

static SipRequest.Builder message(URI requestURI)
                           throws SipParseException

Throws:

SipParseException

request

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

Throws:

SipParseException

ok

default SipResponse ok()

Convenience method for just replying with a 200 to a request.

Returns:

the 200 OK response.

methodNotAllowed

default SipResponse methodNotAllowed()

Convenience method for just replying with a 405 Method Not Allowed to a request.

Returns:

the 405 response.

copy

SipRequest.Builder copy()

Specified by:

copy in interface SipMessage

request

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

Throws:

SipParseException

withMethod

static SipRequest.Builder withMethod(Buffer method)
                              throws SipParseException

Throws:

SipParseException

withMethod

static SipRequest.Builder withMethod(String method)
                              throws SipParseException

Throws:

SipParseException