io.pkts.packet.sip

Class SipRequest.Builder

java.lang.Object

io.pkts.packet.sip.SipRequest.Builder

Enclosing interface:

SipRequest

public static class SipRequest.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
SipRequest	build() Build a new SipRequest.
SipRequest.Builder	callId(CallIdHeader callId)
SipRequest.Builder	contact(ContactHeader contact)
SipRequest.Builder	cseq(CSeqHeader cseq)
SipRequest.Builder	from(FromHeader from)
SipRequest.Builder	to(ToHeader to)
SipRequest.Builder	via(ViaHeader via) Add a via header to this request.

Methods inherited from class java.lang.Object

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

Method Detail

to

public SipRequest.Builder to(ToHeader to)

from

public SipRequest.Builder from(FromHeader from)

callId

public SipRequest.Builder callId(CallIdHeader callId)

contact

public SipRequest.Builder contact(ContactHeader contact)

cseq

public SipRequest.Builder cseq(CSeqHeader cseq)

via

public SipRequest.Builder via(ViaHeader via)

Add a via header to this request. Multiple via headers are allowed so calling this method multiple times will result in all of those ViaHeaders being added to this request.

Parameters:

via -

Returns:

build

public SipRequest build()
                 throws SipParseException

Build a new SipRequest. The only mandatory value is the request-uri and the From-address. The following headers will be generated with default values unless specified:

• To will be based off of the request-uri (user and host)
• CSeq will be set to 0 METHOD, e.g. 0 INVITE
• Max-Forwards will be set to 70
• Call-ID will automatically be generated

NOTE: no ContactHeader will automatically be generated since it is impossible to figure out a default value that actually will work. If you are building your own SIP stack you should set the ContactHeader in the transport layer before you send it off.

Returns:

Throws:

SipParseException