io.pkts.packet.sip.header

Class ViaHeader.Builder

java.lang.Object

io.pkts.packet.sip.header.ViaHeader.Builder

All Implemented Interfaces:

SipHeader.Builder<ViaHeader>

Enclosing interface:

ViaHeader

public static class ViaHeader.Builder
extends Object
implements SipHeader.Builder<ViaHeader>

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(Buffer buffer)
Builder(Transport transport, Buffer host, int port, List<Buffer[]> params, int indexOfBranch, int indexOfReceived, int indexOfRPort)

Method Summary

Modifier and Type	Method and Description
ViaHeader	build()
boolean	hasRPort() Check to see if this via we are building as the rport parameter on it.
ViaHeader.Builder	withBranch() Convenience method for generating a default branch.
ViaHeader.Builder	withBranch(Buffer branch)
ViaHeader.Builder	withBranch(String branch)
ViaHeader.Builder	withHost(Buffer host)
ViaHeader.Builder	withHost(String host)
ViaHeader.Builder	withParameter(Buffer name, Buffer value)
ViaHeader.Builder	withParameter(String name, String value)
ViaHeader.Builder	withPort(int port)
ViaHeader.Builder	withReceived(Buffer received)
ViaHeader.Builder	withReceived(String received)
ViaHeader.Builder	withRPort(int rport)
ViaHeader.Builder	withRPortFlag() When you send out a request you typically want to add rport as a flag parameter to indicate to the downstream element that it should fill it out.
ViaHeader.Builder	withTransport(Buffer transport) Set the transport.
ViaHeader.Builder	withTransport(String transport)
ViaHeader.Builder	withTransport(Transport transport)
ViaHeader.Builder	withTransportSCTP()
ViaHeader.Builder	withTransportTCP()
ViaHeader.Builder	withTransportTLS()
ViaHeader.Builder	withTransportUDP()
ViaHeader.Builder	withTransportWS()
ViaHeader.Builder	withTransportWSS()
SipHeader.Builder<ViaHeader>	withValue(Buffer value)

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.header.SipHeader.Builder

withValue

Constructor Detail

Builder

public Builder()

Builder

public Builder(Transport transport,
               Buffer host,
               int port,
               List<Buffer[]> params,
               int indexOfBranch,
               int indexOfReceived,
               int indexOfRPort)

Builder

public Builder(Buffer buffer)
        throws IOException

Throws:

IOException

Method Detail

withParameter

public ViaHeader.Builder withParameter(Buffer name,
                                       Buffer value)
                                throws SipParseException,
                                       IllegalArgumentException

Throws:

SipParseException

IllegalArgumentException

withParameter

public ViaHeader.Builder withParameter(String name,
                                       String value)
                                throws SipParseException,
                                       IllegalArgumentException

Throws:

SipParseException

IllegalArgumentException

withPort

public ViaHeader.Builder withPort(int port)

withHost

public ViaHeader.Builder withHost(Buffer host)

withHost

public ViaHeader.Builder withHost(String host)

withBranch

public ViaHeader.Builder withBranch()

Convenience method for generating a default branch. Same as calling: ViaHeader.generateBranch() and pass that into withBranch(Buffer)

Returns:

withBranch

public ViaHeader.Builder withBranch(Buffer branch)

withBranch

public ViaHeader.Builder withBranch(String branch)

withRPortFlag

public ViaHeader.Builder withRPortFlag()

When you send out a request you typically want to add rport as a flag parameter to indicate to the downstream element that it should fill it out.

Returns:

hasRPort

public boolean hasRPort()

Check to see if this via we are building as the rport parameter on it.

Returns:

withRPort

public ViaHeader.Builder withRPort(int rport)

withReceived

public ViaHeader.Builder withReceived(String received)

withReceived

public ViaHeader.Builder withReceived(Buffer received)

withTransportUDP

public ViaHeader.Builder withTransportUDP()

withTransportSCTP

public ViaHeader.Builder withTransportSCTP()

withTransportTCP

public ViaHeader.Builder withTransportTCP()

withTransportTLS

public ViaHeader.Builder withTransportTLS()

withTransportWS

public ViaHeader.Builder withTransportWS()

withTransportWSS

public ViaHeader.Builder withTransportWSS()

withTransport

public ViaHeader.Builder withTransport(Buffer transport)
                                throws SipParseException

Set the transport. Normally, you should really use the #transportUDP() methods rather than this.

Parameters:

transport -

Returns:

Throws:

SipParseException - in case the transport is not any of UDP, TCP, TLS, SCTP or WS.

withTransport

public ViaHeader.Builder withTransport(Transport transport)
                                throws SipParseException

Throws:

SipParseException

withTransport

public ViaHeader.Builder withTransport(String transport)
                                throws SipParseException

Throws:

SipParseException

withValue

public SipHeader.Builder<ViaHeader> withValue(Buffer value)

Specified by:

withValue in interface SipHeader.Builder<ViaHeader>

build

public ViaHeader build()
                throws SipParseException

Specified by:

build in interface SipHeader.Builder<ViaHeader>

Throws:

SipParseException