io.pkts.packet.sip.impl

Class SipResponseBuilder

java.lang.Object

io.pkts.packet.sip.impl.SipMessageBuilder<SipResponse>

io.pkts.packet.sip.impl.SipResponseBuilder

All Implemented Interfaces:

SipMessage.Builder<SipResponse>, SipResponse.Builder

public final class SipResponseBuilder
extends SipMessageBuilder<SipResponse>
implements SipResponse.Builder

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
SipResponseBuilder(int statusCode)

Method Summary

Modifier and Type	Method and Description
protected SipInitialLine	buildInitialLine()
protected CSeqHeader	generateDefaultCSeqHeader() For a response the only way we know which method this response is for is from the CSeq-header so if that one doesn't exist then there is simply nothing we can do.
protected ToHeader	generateDefaultToHeader()
protected SipResponse	internalBuild(Buffer msg, SipInitialLine initialLine, Map<String,List<SipHeader>> headers, SipHeader toHeader, SipHeader fromHeader, SipHeader cSeqHeader, SipHeader callIdHeader, SipHeader maxForwardsHeader, SipHeader viaHeader, SipHeader routeHeader, SipHeader recordRouteHeader, SipHeader contactHeader, Buffer body)
protected boolean	isBuildingResponse() Indicates whether or not we are building a response.
SipResponse.Builder	withReasonPhrase(Buffer reason)
SipResponse.Builder	withReasonPhrase(String reason)

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

build, getRequestURIFunction, isBuildingRequest, onCommit, onContactHeader, onCSeqHeader, onFromHeader, onHeader, onMaxForwardsHeader, onRecordRouteHeader, onRequestURI, onRouteHeader, onToHeader, onTopMostRecordRouteHeader, onTopMostRouteHeader, onTopMostViaHeader, onViaHeader, withBody, withCallIdHeader, withContactHeader, withCSeqHeader, withFromHeader, withFromHeader, withHeader, withHeaders, withMaxForwardsHeader, withNoDefaults, withNoRoutes, withPoppedRoute, withPoppedVia, withPushHeader, withRecordRouteHeader, withRecordRouteHeaders, withRecordRouteHeaders, withRouteHeader, withRouteHeaders, withRouteHeaders, withToHeader, withToHeader, withTopMostRecordRouteHeader, withTopMostRouteHeader, withTopMostViaHeader, withTopMostViaHeader, withViaHeader, withViaHeaders, withViaHeaders

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pkts.packet.sip.SipResponse.Builder

build, isSipResponseBuilder, toSipResponseBuilder

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

isSipRequestBuilder, onCommit, onContactHeader, onCSeqHeader, onFromHeader, onHeader, onMaxForwardsHeader, onRecordRouteHeader, onRequestURI, onRouteHeader, onToHeader, onTopMostRecordRouteHeader, onTopMostRouteHeader, onTopMostViaHeader, onViaHeader, toSipRequestBuilder, withBody, withCallIdHeader, withContactHeader, withCSeqHeader, withFromHeader, withFromHeader, withHeader, withHeaders, withMaxForwardsHeader, withNoDefaults, withNoRoutes, withPoppedRoute, withPoppedVia, withPushHeader, withRecordRouteHeader, withRecordRouteHeaders, withRecordRouteHeaders, withRouteHeader, withRouteHeaders, withRouteHeaders, withToHeader, withToHeader, withTopMostRecordRouteHeader, withTopMostRouteHeader, withTopMostViaHeader, withTopMostViaHeader, withViaHeader, withViaHeaders, withViaHeaders

Constructor Detail

SipResponseBuilder

public SipResponseBuilder(int statusCode)

Method Detail

isBuildingResponse

protected final boolean isBuildingResponse()

Description copied from class: SipMessageBuilder

Indicates whether or not we are building a response. Must be overridden by the response builder. Used for e.g. SipHeaderBuilderWrapper#enforceDefaults()

Overrides:

isBuildingResponse in class SipMessageBuilder<SipResponse>

Returns:

generateDefaultToHeader

protected ToHeader generateDefaultToHeader()

Specified by:

generateDefaultToHeader in class SipMessageBuilder<SipResponse>

generateDefaultCSeqHeader

protected CSeqHeader generateDefaultCSeqHeader()

For a response the only way we know which method this response is for is from the CSeq-header so if that one doesn't exist then there is simply nothing we can do.

Specified by:

generateDefaultCSeqHeader in class SipMessageBuilder<SipResponse>

Returns:

buildInitialLine

protected SipInitialLine buildInitialLine()
                                   throws SipParseException

Specified by:

buildInitialLine in class SipMessageBuilder<SipResponse>

Throws:

SipParseException

internalBuild

protected SipResponse internalBuild(Buffer msg,
                                    SipInitialLine initialLine,
                                    Map<String,List<SipHeader>> headers,
                                    SipHeader toHeader,
                                    SipHeader fromHeader,
                                    SipHeader cSeqHeader,
                                    SipHeader callIdHeader,
                                    SipHeader maxForwardsHeader,
                                    SipHeader viaHeader,
                                    SipHeader routeHeader,
                                    SipHeader recordRouteHeader,
                                    SipHeader contactHeader,
                                    Buffer body)

Specified by:

internalBuild in class SipMessageBuilder<SipResponse>

withReasonPhrase

public SipResponse.Builder withReasonPhrase(String reason)

Specified by:

withReasonPhrase in interface SipResponse.Builder

withReasonPhrase

public SipResponse.Builder withReasonPhrase(Buffer reason)

Specified by:

withReasonPhrase in interface SipResponse.Builder