SipMessageBuilder (SIP Framer and Parser Library 3.0.5 API)

java.lang.Object
- io.pkts.packet.sip.impl.SipMessageBuilder<T>

All Implemented Interfaces:

SipMessage.Builder<T>

Direct Known Subclasses:

SipRequestBuilder, SipResponseBuilder
```
public abstract class SipMessageBuilder<T extends SipMessage>
extends Object
implements SipMessage.Builder<T>
```
Author:

[email protected]

Constructor Summary

Constructors
Modifier Constructor and Description

protected SipMessageBuilder()

protected SipMessageBuilder(int headerSizeHint)

Constructors
Modifier	Constructor and Description
`protected`	`SipMessageBuilder()`
`protected`	`SipMessageBuilder(int headerSizeHint)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`build()`
`protected abstract SipInitialLine`	`buildInitialLine()`
`protected abstract CSeqHeader`	`generateDefaultCSeqHeader()`
`protected abstract ToHeader`	`generateDefaultToHeader()`
`protected java.util.function.Function<SipURI,SipURI>`	`getRequestURIFunction()`
`protected abstract T`	`internalBuild(Buffer message, SipInitialLine initialLine, List<SipHeader> headers, short indexOfTo, short indexOfFrom, short indexOfCSeq, short indexOfCallId, short indexOfMaxForwards, short indexOfVia, short indexOfRoute, short indexOfRecordRoute, short indexOfContact, Buffer body)`
`protected boolean`	`isBuildingRequest()` Indicates whether or not we are building a request.
`protected boolean`	`isBuildingResponse()` Indicates whether or not we are building a response.
`SipMessage.Builder<T>`	`onCommit(java.util.function.Consumer<SipMessage> f)` After the `SipMessage` has been fully built and created the "end result" will be conveyed to the registered function.
`SipMessage.Builder<T>`	`onContactHeader(java.util.function.Consumer<AddressParametersHeader.Builder<ContactHeader>> f)`
`SipMessage.Builder<T>`	`onCSeqHeader(java.util.function.Consumer<CSeqHeader.Builder> f)`
`SipMessage.Builder<T>`	`onFromHeader(java.util.function.Consumer<AddressParametersHeader.Builder<FromHeader>> f)`
`SipMessage.Builder<T>`	`onHeader(java.util.function.Function<SipHeader,SipHeader> f)` Whenever a header is about to be pushed onto the new `SipMessage` you have a chance to change the value of that header.
`SipMessage.Builder<T>`	`onMaxForwardsHeader(java.util.function.Consumer<MaxForwardsHeader.Builder> f)`
`SipMessage.Builder<T>`	`onRecordRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RecordRouteHeader>> f)` Called when a Record-Route header is processed (except for the top-most one, then `SipMessage.Builder.onTopMostRecordRouteHeader(Consumer)` is called instead)
`SipMessage.Builder<T>`	`onRequestURI(java.util.function.Function<SipURI,SipURI> f)`
`SipMessage.Builder<T>`	`onRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RouteHeader>> f)` Called when a Route header is processed (except for the top-most one, then `SipMessage.Builder.onTopMostRouteHeader(Consumer)` is called instead)
`SipMessage.Builder<T>`	`onToHeader(java.util.function.Consumer<AddressParametersHeader.Builder<ToHeader>> f)`
`SipMessage.Builder<T>`	`onTopMostRecordRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RecordRouteHeader>> f)` Called when the top-most Record Route header is processed.
`SipMessage.Builder<T>`	`onTopMostRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RouteHeader>> f)` Called when the top-most Route header is processed.
`SipMessage.Builder<T>`	`onTopMostViaHeader(java.util.function.Consumer<ViaHeader.Builder> f)` Called when the top-most Via header is processed.
`SipMessage.Builder<T>`	`onViaHeader(java.util.function.BiConsumer<Integer,ViaHeader.Builder> f)` Called when a Via header is processed and the first argument is the index of the Via being processed.
`SipMessage.Builder<T>`	`withBody(Buffer body)`
`SipMessage.Builder<T>`	`withCallIdHeader(CallIdHeader callID)`
`SipMessage.Builder<T>`	`withContactHeader(ContactHeader contact)`
`SipMessage.Builder<T>`	`withCSeqHeader(CSeqHeader cseq)`
`SipMessage.Builder<T>`	`withFromHeader(FromHeader from)` Set the `FromHeader` to be used by the new `SipMessage`.
`SipMessage.Builder<T>`	`withFromHeader(String from)`
`SipMessage.Builder<T>`	`withHeader(SipHeader header)` Adds the header to the list of headers already specified within this builder.
`SipMessage.Builder<T>`	`withHeaders(List<SipHeader> headers)`
`SipMessage.Builder<T>`	`withMaxForwardsHeader(MaxForwardsHeader maxForwards)`
`SipMessage.Builder<T>`	`withNoDefaults()` By default, the following headers will automatically be generated if not explicitly provided (note: there is a slight difference between request/response): `ToHeader` - the request-uri will be used to construct the to-header in the case of a request.
`SipMessage.Builder<T>`	`withNoRoutes()` Sometimes you may want to just wipe out all the potential `RouteHeader`s that e.g.
`SipMessage.Builder<T>`	`withPoppedRoute()` Pop the top-most route.
`SipMessage.Builder<T>`	`withPoppedVia()` Pop the top-most via.
`SipMessage.Builder<T>`	`withPushHeader(SipHeader header)` Push the header to be the first on the list of existing headers already added to this builder.
`SipMessage.Builder<T>`	`withRecordRouteHeader(RecordRouteHeader recordRoute)` Set a Record Router header to be used on the message that is being built.
`SipMessage.Builder<T>`	`withRecordRouteHeaders(List<RecordRouteHeader> recordRoutes)`
`SipMessage.Builder<T>`	`withRecordRouteHeaders(RecordRouteHeader... recordRoutes)` Set a list of Record Route headers.
`SipMessage.Builder<T>`	`withRouteHeader(RouteHeader route)` Set a Router header to be used on the message that is being built.
`SipMessage.Builder<T>`	`withRouteHeaders(List<RouteHeader> routes)`
`SipMessage.Builder<T>`	`withRouteHeaders(RouteHeader... routes)` Set a list of Route headers.
`SipMessage.Builder<T>`	`withToHeader(String to)`
`SipMessage.Builder<T>`	`withToHeader(ToHeader to)`
`SipMessage.Builder<T>`	`withTopMostRecordRouteHeader(RecordRouteHeader recordRoute)` Push the given Record Route header to the top of the potential list of existing Record Route headers.
`SipMessage.Builder<T>`	`withTopMostRouteHeader(RouteHeader route)` Push the given Route header to the top of the potential list of existing Route headers.
`SipMessage.Builder<T>`	`withTopMostViaHeader()` Typically the `ViaHeader` will have to be filled out by the stack at some later point, which is when the message is about to be sent, so when you create the message you don't have all the details just yet.
`SipMessage.Builder<T>`	`withTopMostViaHeader(ViaHeader via)` Push the given Via header to the top of the potential list of existing Via headers.
`SipMessage.Builder<T>`	`withViaHeader(ViaHeader via)` Add a Via header to be used on the message that is being built.
`SipMessage.Builder<T>`	`withViaHeaders(List<ViaHeader> vias)` Set a list of Via headers.
`SipMessage.Builder<T>`	`withViaHeaders(ViaHeader... vias)` Set a list of Via headers.

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.SipMessage.Builder
isSipRequestBuilder, isSipResponseBuilder, toSipRequestBuilder, toSipResponseBuilder

- Constructor Detail
  - SipMessageBuilder
```
protected SipMessageBuilder(int headerSizeHint)
```
  - SipMessageBuilder
```
protected SipMessageBuilder()
```
- Method Detail
  - withNoDefaults
```
public SipMessage.Builder<T> withNoDefaults()
```
    Description copied from interface: SipMessage.Builder
    By default, the following headers will automatically be generated if not explicitly provided (note: there is a slight difference between request/response):
    - ToHeader - the request-uri will be used to construct the to-header in the case of a request. For a response you have to supply it
    - CSeqHeader - a new CSeq header will be added where the method is the same as this message and the sequence number is set to 1
    - CallIdHeader - a new random call-id will be added
    - MaxForwardsHeader - if we are building a request, a max forwards of 70 will be added
    - ContentLengthHeader - Will be added if there is a body on the message and the length set to the correct length.
    but if you don't want that, simply call this method and all the defaults of this builder will be suspended. Of course, if you wish to actually construct a valid SipMessage you are then responsible for adding the mandatory headers to this builder (unless you don't care of course because perhaps you are building a test tool meant to torture test a SIP server).
    Specified by:
    
    withNoDefaults in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - onHeader
```
public SipMessage.Builder<T> onHeader(java.util.function.Function<SipHeader,SipHeader> f)
                               throws IllegalStateException
```
    Description copied from interface: SipMessage.Builder
    Whenever a header is about to be pushed onto the new SipMessage you have a chance to change the value of that header. You do so by registering a function that accepts a SipHeader as an argument and that returns a SipHeader, which is the header that will be pushed onto the new SipMessage. If you do not want to include the header, then simply return null and the header will be dropped. If you wish to leave the header un-touched, then simply return it has is. Also note that the following headers have explicit "on" methods (they are considered to be "system" headers):
    The reason is simply because these are typically manipulated before copying them over to a new request or response (e.g., Max Forwards is decremented, CSeq may increase etc) and therefore it makes life easier if those headers are "down casted" to their specific types.
    Specified by:
    
    onHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
    
    Throws:
    
    IllegalStateException - in case a function already had been registered with this builder.
  - withHeader
```
public SipMessage.Builder<T> withHeader(SipHeader header)
```
    Description copied from interface: SipMessage.Builder
    
    Adds the header to the list of headers already specified within this builder. The header will be added last to the list of headers. Any already existing headers with the same name will be preserved as is. If there are any headers with the same name as part of the SipMessage used as a template, then those headers will TODO: this is essentially an "add header" so should it be called that? TODO: and then should there be a set version? Just goes bad with a fluent TODO: naming.
    
    Specified by:
    
    withHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withHeaders
```
public SipMessage.Builder<T> withHeaders(List<SipHeader> headers)
```
    Specified by:
    
    withHeaders in interface SipMessage.Builder<T extends SipMessage>
  - withPushHeader
```
public SipMessage.Builder<T> withPushHeader(SipHeader header)
```
    Description copied from interface: SipMessage.Builder
    
    Push the header to be the first on the list of existing headers already added to this builder. TODO: naming
    
    Specified by:
    
    withPushHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - onFromHeader
```
public SipMessage.Builder<T> onFromHeader(java.util.function.Consumer<AddressParametersHeader.Builder<FromHeader>> f)
```
    Specified by:
    
    onFromHeader in interface SipMessage.Builder<T extends SipMessage>
  - withFromHeader
```
public SipMessage.Builder<T> withFromHeader(FromHeader from)
```
    Description copied from interface: SipMessage.Builder
    
    Set the FromHeader to be used by the new SipMessage. If there already is a FromHeader present, either through a template or because this method has been called previously, that value will be overwritten.
    
    Specified by:
    
    withFromHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withFromHeader
```
public SipMessage.Builder<T> withFromHeader(String from)
```
    Specified by:
    
    withFromHeader in interface SipMessage.Builder<T extends SipMessage>
  - onToHeader
```
public SipMessage.Builder<T> onToHeader(java.util.function.Consumer<AddressParametersHeader.Builder<ToHeader>> f)
```
    Specified by:
    
    onToHeader in interface SipMessage.Builder<T extends SipMessage>
  - withToHeader
```
public SipMessage.Builder<T> withToHeader(ToHeader to)
```
    Specified by:
    
    withToHeader in interface SipMessage.Builder<T extends SipMessage>
  - withToHeader
```
public SipMessage.Builder<T> withToHeader(String to)
```
    Specified by:
    
    withToHeader in interface SipMessage.Builder<T extends SipMessage>
  - onContactHeader
```
public SipMessage.Builder<T> onContactHeader(java.util.function.Consumer<AddressParametersHeader.Builder<ContactHeader>> f)
```
    Specified by:
    
    onContactHeader in interface SipMessage.Builder<T extends SipMessage>
  - withContactHeader
```
public SipMessage.Builder<T> withContactHeader(ContactHeader contact)
```
    Specified by:
    
    withContactHeader in interface SipMessage.Builder<T extends SipMessage>
  - onCSeqHeader
```
public SipMessage.Builder<T> onCSeqHeader(java.util.function.Consumer<CSeqHeader.Builder> f)
```
    Specified by:
    
    onCSeqHeader in interface SipMessage.Builder<T extends SipMessage>
  - withCSeqHeader
```
public SipMessage.Builder<T> withCSeqHeader(CSeqHeader cseq)
```
    Specified by:
    
    withCSeqHeader in interface SipMessage.Builder<T extends SipMessage>
  - withCallIdHeader
```
public SipMessage.Builder<T> withCallIdHeader(CallIdHeader callID)
```
    Specified by:
    
    withCallIdHeader in interface SipMessage.Builder<T extends SipMessage>
  - onMaxForwardsHeader
```
public SipMessage.Builder<T> onMaxForwardsHeader(java.util.function.Consumer<MaxForwardsHeader.Builder> f)
```
    Specified by:
    
    onMaxForwardsHeader in interface SipMessage.Builder<T extends SipMessage>
  - withMaxForwardsHeader
```
public SipMessage.Builder<T> withMaxForwardsHeader(MaxForwardsHeader maxForwards)
```
    Specified by:
    
    withMaxForwardsHeader in interface SipMessage.Builder<T extends SipMessage>
  - onTopMostViaHeader
```
public SipMessage.Builder<T> onTopMostViaHeader(java.util.function.Consumer<ViaHeader.Builder> f)
```
    Description copied from interface: SipMessage.Builder
    
    Called when the top-most Via header is processed. If there are more than one Via header present, the other ones will be processed via the io.pkts.packet.sip.SipMessage.Builder#onViaHeader(Consumer) consumer
    
    Specified by:
    
    onTopMostViaHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - onViaHeader
```
public SipMessage.Builder<T> onViaHeader(java.util.function.BiConsumer<Integer,ViaHeader.Builder> f)
```
    Description copied from interface: SipMessage.Builder
    Called when a Via header is processed and the first argument is the index of the Via being processed. The top-most Via header will NEVER be passed to this registered function but rather to the one explicitly meant for processing the top-most via (see SipMessage.Builder.onTopMostViaHeader(Consumer). I.e., Let's say you have the following message (request or response, same same): ... Via: SIP/2.0/TCP 12.13.14.15;branch=z9hG4bK-asdf Via: SIP/2.0/UDP 60.61.62.63;branch=z9hG4bK-1234 Via: SIP/2.0/UDP 96.97.98.99;branch=z9hG4bK-wxyz ...
    - When the top-most via header (12.13.14.15) is processed, the function registered with SipMessage.Builder.onTopMostViaHeader(Consumer) will be called.
    - When the second via is processed (60.61.62.63), the function registered with SipMessage.Builder.onViaHeader(BiConsumer) will be called where the index will be '1' since this is the second via on the list and we of course start counting at zero.
    - When the third via is processed (96.97.98.99), the function registered with SipMessage.Builder.onViaHeader(BiConsumer) will be called where the index will be '2' since this is the third via on the list and so on...
    Specified by:
    
    onViaHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - onTopMostRouteHeader
```
public SipMessage.Builder<T> onTopMostRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RouteHeader>> f)
```
    Description copied from interface: SipMessage.Builder
    
    Called when the top-most Route header is processed. If there are more than one Route header present, the other ones will be processed via the SipMessage.Builder.onRouteHeader(Consumer)
    
    Specified by:
    
    onTopMostRouteHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - onRouteHeader
```
public SipMessage.Builder<T> onRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RouteHeader>> f)
```
    Description copied from interface: SipMessage.Builder
    
    Called when a Route header is processed (except for the top-most one, then SipMessage.Builder.onTopMostRouteHeader(Consumer) is called instead)
    
    Specified by:
    
    onRouteHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withRouteHeader
```
public SipMessage.Builder<T> withRouteHeader(RouteHeader route)
```
    Description copied from interface: SipMessage.Builder
    
    Set a Router header to be used on the message that is being built. This will replace any previously set Route headers. If you wish to add a number of Route headers, use SipMessage.Builder.withRouteHeaders(RouteHeader...). If you want to push a Route header to a potentially already existing list of Record Route headers, then use SipMessage.Builder.withTopMostRouteHeader(RouteHeader)
    
    Specified by:
    
    withRouteHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withRouteHeaders
```
public SipMessage.Builder<T> withRouteHeaders(RouteHeader... routes)
```
    Description copied from interface: SipMessage.Builder
    
    Set a list of Route headers. Any previously Route headers will be replaced by this list.
    
    Specified by:
    
    withRouteHeaders in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withRouteHeaders
```
public SipMessage.Builder<T> withRouteHeaders(List<RouteHeader> routes)
```
    Specified by:
    
    withRouteHeaders in interface SipMessage.Builder<T extends SipMessage>
  - withTopMostRouteHeader
```
public SipMessage.Builder<T> withTopMostRouteHeader(RouteHeader route)
```
    Description copied from interface: SipMessage.Builder
    
    Push the given Route header to the top of the potential list of existing Route headers.
    
    Specified by:
    
    withTopMostRouteHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withPoppedRoute
```
public SipMessage.Builder<T> withPoppedRoute()
```
    Description copied from interface: SipMessage.Builder
    
    Pop the top-most route. Note, if you e.g. add a RouteHeader via the method SipMessage.Builder.withTopMostRouteHeader(RouteHeader) followed by this method, then the route you just added will be removed again. Order is important! Note: if you actually wanted to know the value of that RouteHeader then you should really have checked it on the SipMessage you received and not on the builder object.
    
    Specified by:
    
    withPoppedRoute in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withNoRoutes
```
public SipMessage.Builder<T> withNoRoutes()
```
    Description copied from interface: SipMessage.Builder
    
    Sometimes you may want to just wipe out all the potential RouteHeaders that e.g. were automatically copied from another SipRequest that was used as a template. A common scenario is that you are building a B2BUA acting as the border police to your network and you simply cannot trust incoming requests and as such, you should not honor externally pushed routes, since if you did, an attacker could by-pass your next hop by forcing the request to go to somewhere else.
    
    Specified by:
    
    withNoRoutes in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - onTopMostRecordRouteHeader
```
public SipMessage.Builder<T> onTopMostRecordRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RecordRouteHeader>> f)
```
    Description copied from interface: SipMessage.Builder
    
    Called when the top-most Record Route header is processed. If there are more than one Record Route header present, the other ones will be processed via the SipMessage.Builder.onRecordRouteHeader(Consumer)
    
    Specified by:
    
    onTopMostRecordRouteHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - onRecordRouteHeader
```
public SipMessage.Builder<T> onRecordRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RecordRouteHeader>> f)
```
    Description copied from interface: SipMessage.Builder
    
    Called when a Record-Route header is processed (except for the top-most one, then SipMessage.Builder.onTopMostRecordRouteHeader(Consumer) is called instead)
    
    Specified by:
    
    onRecordRouteHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withRecordRouteHeader
```
public SipMessage.Builder<T> withRecordRouteHeader(RecordRouteHeader recordRoute)
```
    Description copied from interface: SipMessage.Builder
    
    Set a Record Router header to be used on the message that is being built. This will replace any previously set Record Route headers. If you wish to add a number of Record Route headers, use SipMessage.Builder.withRecordRouteHeaders(RecordRouteHeader...). If you want to push a Record Route header to a potentially already existing list of Record Route headers, then use
    
    Specified by:
    
    withRecordRouteHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withRecordRouteHeaders
```
public SipMessage.Builder<T> withRecordRouteHeaders(RecordRouteHeader... recordRoutes)
```
    Description copied from interface: SipMessage.Builder
    
    Set a list of Record Route headers. Any previously Record Route headers will be replaced by this list.
    
    Specified by:
    
    withRecordRouteHeaders in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withRecordRouteHeaders
```
public SipMessage.Builder<T> withRecordRouteHeaders(List<RecordRouteHeader> recordRoutes)
```
    Specified by:
    
    withRecordRouteHeaders in interface SipMessage.Builder<T extends SipMessage>
  - withTopMostRecordRouteHeader
```
public SipMessage.Builder<T> withTopMostRecordRouteHeader(RecordRouteHeader recordRoute)
```
    Description copied from interface: SipMessage.Builder
    
    Push the given Record Route header to the top of the potential list of existing Record Route headers.
    
    Specified by:
    
    withTopMostRecordRouteHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withViaHeader
```
public SipMessage.Builder<T> withViaHeader(ViaHeader via)
```
    Description copied from interface: SipMessage.Builder
    
    Add a Via header to be used on the message that is being built. This will replace any previously set Via headers. If you wish to add a number of Via headers, use SipMessage.Builder.withViaHeaders(ViaHeader...). If you want to push a Via header to a potentially already existing list of Via headers, then use SipMessage.Builder.withTopMostViaHeader(ViaHeader).
    
    Specified by:
    
    withViaHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withViaHeaders
```
public SipMessage.Builder<T> withViaHeaders(ViaHeader... vias)
```
    Description copied from interface: SipMessage.Builder
    
    Set a list of Via headers. Any previously Via headers will be replaced by this list.
    
    Specified by:
    
    withViaHeaders in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withViaHeaders
```
public SipMessage.Builder<T> withViaHeaders(List<ViaHeader> vias)
```
    Description copied from interface: SipMessage.Builder
    
    Set a list of Via headers. Any previously Via headers will be replaced by this list.
    
    Specified by:
    
    withViaHeaders in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withTopMostViaHeader
```
public SipMessage.Builder<T> withTopMostViaHeader(ViaHeader via)
```
    Description copied from interface: SipMessage.Builder
    
    Push the given Via header to the top of the potential list of existing Via headers.
    
    Specified by:
    
    withTopMostViaHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withTopMostViaHeader
```
public SipMessage.Builder<T> withTopMostViaHeader()
```
    Description copied from interface: SipMessage.Builder
    
    Typically the ViaHeader will have to be filled out by the stack at some later point, which is when the message is about to be sent, so when you create the message you don't have all the details just yet. However, just to create a new Via with bogus information only to be re-written later by registering a function with SipMessage.Builder.onTopMostViaHeader(Consumer) is rather silly so therefore you can just indicate that you want a new top-most via header but you will fill out all details later. NOTE: if you do NOT register a function to handle this "empty" Via-header through the method SipMessage.Builder.onTopMostViaHeader(Consumer) things will blow up later with you try to build this message.
    
    Specified by:
    
    withTopMostViaHeader in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withPoppedVia
```
public SipMessage.Builder<T> withPoppedVia()
```
    Description copied from interface: SipMessage.Builder
    
    Pop the top-most via. Note, if you e.g. add a ViaHeader through the method SipMessage.Builder.withTopMostViaHeader(ViaHeader) followed by this method, then the Via you just added will be removed again. Order is important! Note: if you actually wanted to know the value of that ViaHeader then you should really have checked it on the SipMessage you received and not on the builder object.
    
    Specified by:
    
    withPoppedVia in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - getRequestURIFunction
```
protected final java.util.function.Function<SipURI,SipURI> getRequestURIFunction()
```
  - onRequestURI
```
public SipMessage.Builder<T> onRequestURI(java.util.function.Function<SipURI,SipURI> f)
```
    Specified by:
    
    onRequestURI in interface SipMessage.Builder<T extends SipMessage>
    
    Returns:
  - withBody
```
public SipMessage.Builder<T> withBody(Buffer body)
```
    Specified by:
    
    withBody in interface SipMessage.Builder<T extends SipMessage>
  - isBuildingRequest
```
protected boolean isBuildingRequest()
```
    Indicates whether or not we are building a request. Must be overridden by the request builder. Used for e.g. SipHeaderBuilderWrapper#enforceDefaults()
    
    Returns:
  - isBuildingResponse
```
protected boolean isBuildingResponse()
```
    Indicates whether or not we are building a response. Must be overridden by the response builder. Used for e.g. SipHeaderBuilderWrapper#enforceDefaults()
    
    Returns:
  - generateDefaultToHeader
```
protected abstract ToHeader generateDefaultToHeader()
```
  - generateDefaultCSeqHeader
```
protected abstract CSeqHeader generateDefaultCSeqHeader()
```
  - build
```
public T build()
```
    Specified by:
    
    build in interface SipMessage.Builder<T extends SipMessage>
  - buildInitialLine
```
protected abstract SipInitialLine buildInitialLine()
                                            throws SipParseException
```
    Throws:
    
    SipParseException
  - internalBuild
```
protected abstract T internalBuild(Buffer message,
                                   SipInitialLine initialLine,
                                   List<SipHeader> headers,
                                   short indexOfTo,
                                   short indexOfFrom,
                                   short indexOfCSeq,
                                   short indexOfCallId,
                                   short indexOfMaxForwards,
                                   short indexOfVia,
                                   short indexOfRoute,
                                   short indexOfRecordRoute,
                                   short indexOfContact,
                                   Buffer body)
```
  - onCommit
```
public SipMessage.Builder<T> onCommit(java.util.function.Consumer<SipMessage> f)
```
    Description copied from interface: SipMessage.Builder
    
    After the SipMessage has been fully built and created the "end result" will be conveyed to the registered function. It is utterly important that the function returns as quickly as possible since the build method will not be able to return until the call to this function has been completed.
    
    Specified by:
    
    onCommit in interface SipMessage.Builder<T extends SipMessage>

Class SipMessageBuilder<T extends SipMessage>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

SipMessageBuilder

SipMessageBuilder

Method Detail

withNoDefaults

onHeader

withHeader

withHeaders

withPushHeader

onFromHeader

withFromHeader

withFromHeader

onToHeader

withToHeader

withToHeader

onContactHeader

withContactHeader

onCSeqHeader

withCSeqHeader

withCallIdHeader

onMaxForwardsHeader

withMaxForwardsHeader

onTopMostViaHeader

onViaHeader

onTopMostRouteHeader

onRouteHeader

withRouteHeader

withRouteHeaders

withRouteHeaders

withTopMostRouteHeader

withPoppedRoute

withNoRoutes

onTopMostRecordRouteHeader

onRecordRouteHeader

withRecordRouteHeader

withRecordRouteHeaders

withRecordRouteHeaders

withTopMostRecordRouteHeader

withViaHeader

withViaHeaders

withViaHeaders

withTopMostViaHeader

withTopMostViaHeader

withPoppedVia

getRequestURIFunction

onRequestURI

withBody

isBuildingRequest

isBuildingResponse

generateDefaultToHeader

generateDefaultCSeqHeader

build

buildInitialLine

internalBuild

onCommit