io.pkts.packet.sip.address

Class SipURI.Builder

java.lang.Object

io.pkts.packet.sip.address.URI.Builder<SipURI>

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

Enclosing interface:

SipURI

public static class SipURI.Builder
extends URI.Builder<SipURI>

Method Summary

Modifier and Type	Method and Description
SipURI	build() Construct a SipURI.
boolean	hasParameters()
SipURI.Builder	secure() Mark this SipURI as a secure sip address, i.e.
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.
SipURI.Builder	useWSS()
SipURI.Builder	withHost(Buffer host) Specify the host.
SipURI.Builder	withHost(String host)
SipURI.Builder	withNoParameters() Wipe out all parameters.
SipURI.Builder	withNoPort() Convenience method for removing the port from this SIP URI.
SipURI.Builder	withParameter(Buffer name, Buffer value)
SipURI.Builder	withParameter(Buffer name, int value)
SipURI.Builder	withParameter(String name, int value)
SipURI.Builder	withParameter(String name, String value)
SipURI.Builder	withPort(Buffer port) Specify the port as a buffer.
SipURI.Builder	withPort(int port) Set the port.
SipURI.Builder	withSecure(boolean secure) Mark this SipURI as a secure sip address, i.e.
SipURI.Builder	withTransport(Buffer transport)
SipURI.Builder	withTransport(String transport)
SipURI.Builder	withTransport(Transport transport)
SipURI.Builder	withUser(Buffer user)
SipURI.Builder	withUser(String user)

Methods inherited from class java.lang.Object

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

Method Detail

withUser

public SipURI.Builder withUser(Buffer user)

Parameters:

user -

Returns:

withUser

public SipURI.Builder withUser(String user)

Parameters:

user -

Returns:

withHost

public SipURI.Builder withHost(Buffer host)
                        throws SipParseException

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

Parameters:

host -

Returns:

Throws:

SipParseException

withHost

public SipURI.Builder withHost(String host)
                        throws SipParseException

Throws:

SipParseException

withTransport

public SipURI.Builder withTransport(Transport transport)
                             throws SipParseException

Throws:

SipParseException

withTransport

public SipURI.Builder withTransport(Buffer transport)
                             throws SipParseException

Throws:

SipParseException

withTransport

public SipURI.Builder withTransport(String transport)
                             throws SipParseException

Throws:

SipParseException

withParameter

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

Throws:

SipParseException

IllegalArgumentException

withParameter

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

Throws:

SipParseException

IllegalArgumentException

withParameter

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

Throws:

SipParseException

IllegalArgumentException

withParameter

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

Throws:

SipParseException

IllegalArgumentException

withNoParameters

public SipURI.Builder withNoParameters()

Wipe out all parameters. Useful if you e.g. create a copy of a SipURI but you want to remove any potential parameters that may be on the SIP URI.

Returns:

secure

public SipURI.Builder secure()

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

Returns:

withSecure

public SipURI.Builder withSecure(boolean secure)

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

Returns:

withPort

public SipURI.Builder withPort(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

withPort

public SipURI.Builder withPort(Buffer port)
                        throws SipParseException

Specify the port as a buffer.

Parameters:

port - if null the port will be reset.

Returns:

Throws:

SipParseException - in case the port is

withNoPort

public SipURI.Builder withNoPort()
                          throws SipParseException

Convenience method for removing the port from this SIP URI. Same as io.pkts.packet.sip.address.SipURI.Builder#withPort(null)

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:

useWSS

public SipURI.Builder useWSS()

hasParameters

public boolean hasParameters()

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.