io.pkts.packet.sip.address

Class SipURI.Builder

java.lang.Object

io.pkts.packet.sip.address.SipURI.Builder

Enclosing interface:

SipURI

public static class SipURI.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
SipURI	build() Construct a SipURI.
SipURI.Builder	host(Buffer host) Specify the host.
SipURI.Builder	host(java.lang.String host)
SipURI.Builder	parameter(Buffer name, Buffer value)
SipURI.Builder	parameter(java.lang.String name, java.lang.String value)
SipURI.Builder	port(int port) Set the port.
SipURI.Builder	secure() Mark this SipURI as a secure sip address, i.e.
SipURI.Builder	secure(boolean secure) Mark this SipURI as a secure sip address, i.e.
SipURI.Builder	user(Buffer user)
SipURI.Builder	user(java.lang.String user)
SipURI.Builder	useSCTP() Use SCTP as the transport.
SipURI.Builder	useTCP() Use TCP as the transport.
SipURI.Builder	useTLS() Use TLS as the transport.
SipURI.Builder	useUDP() Use UDP as the transport.
SipURI.Builder	useWS() Use WebSocket as the transport.

Methods inherited from class java.lang.Object

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

Method Detail

user

public SipURI.Builder user(Buffer user)

Parameters:

user -

Returns:

user

public SipURI.Builder user(java.lang.String user)

Parameters:

user -

Returns:

host

public SipURI.Builder host(Buffer host)
                    throws SipParseException

Specify the host. The host portion of a SipURI is mandatory so

Parameters:

host -

Returns:

Throws:

SipParseException

host

public SipURI.Builder host(java.lang.String host)
                    throws SipParseException

Throws:

SipParseException

parameter

public SipURI.Builder parameter(Buffer name,
                                Buffer value)
                         throws SipParseException,
                                java.lang.IllegalArgumentException

Throws:

SipParseException

java.lang.IllegalArgumentException

parameter

public SipURI.Builder parameter(java.lang.String name,
                                java.lang.String value)
                         throws SipParseException,
                                java.lang.IllegalArgumentException

Throws:

SipParseException

java.lang.IllegalArgumentException

secure

public SipURI.Builder secure()

Mark this SipURI as a secure sip address, i.e. "sips". Same as calling #secure(true)

Returns:

secure

public SipURI.Builder secure(boolean secure)

Mark this SipURI as a secure sip address, i.e. "sips" or as a non-secure, i.e. "sip"

Returns:

port

public SipURI.Builder port(int port)
                    throws SipParseException

Set the port. Specify -1 (negative one) means that we should use the default port, as in we won't include the port at all in the resulting buffer. However, if you explicitly set the port to 5060 then it will be included in the final buffer..

Parameters:

port -

Returns:

Throws:

SipParseException

useUDP

public SipURI.Builder useUDP()

Use UDP as the transport.

Returns:

useTCP

public SipURI.Builder useTCP()

Use TCP as the transport.

Returns:

useTLS

public SipURI.Builder useTLS()

Use TLS as the transport.

Returns:

useSCTP

public SipURI.Builder useSCTP()

Use SCTP as the transport.

Returns:

useWS

public SipURI.Builder useWS()

Use WebSocket as the transport.

Returns:

build

public SipURI build()
             throws SipParseException

Construct a SipURI.

Returns:

Throws:

SipParseException - in case mandatory parameters, such as host(Buffer) is missing or if other aspects of constructing the SipURI fails.