io.pkts.packet.sip.address.impl

Class SipURIImpl

java.lang.Object

io.pkts.packet.sip.address.impl.URIImpl

io.pkts.packet.sip.address.impl.SipURIImpl

All Implemented Interfaces:

SipURI, URI

public class SipURIImpl
extends URIImpl
implements SipURI

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested classes/interfaces inherited from interface io.pkts.packet.sip.address.SipURI

SipURI.Builder

Constructor Summary

Constructors

Constructor and Description
SipURIImpl(boolean isSips, Buffer userInfo, Buffer host, Buffer port, Buffer paramsHeaders, Buffer original)

Method Summary

Modifier and Type	Method and Description
SipURI	clone()
SipURI.Builder	copy() All URIs are immutable so if you wish to change it you need to obtain a copy of it which will return a new builder that allows you to change and build a new URI.
boolean	equals(Object other) Comparing two SipURIs aren't trivial and the full set of rules are described in RFC3261 section 19.1.4 See rules for comparing URI's in RFC3261 section 19.1.4.
Buffer	getHost() Get the host portion of this URI.
Optional<Buffer>	getMAddrParam() Get the maddr parameter.
Optional<Buffer>	getMethodParam() Get the method parameter.
Optional<Buffer>	getParameter(Buffer name) Get the value of the named parameter.
Optional<Buffer>	getParameter(String name) Same as SipURI.getParameter(Buffer).
int	getPort() Get the port.
Optional<Transport>	getTransportParam() Same as #getParameter("transport")
int	getTTLParam() Get the ttl parameter.
Optional<Buffer>	getUser() Get the user portion of this URI.
Optional<Buffer>	getUserParam() Get the user parameter.
int	hashCode() Now, the hash-code doesn't actually have to be unique for every little parameter and detail as the equals(Object) method is checking, we just need to take enough stuff into account to have a good enough spread and then the equals-method would be used to sort out any ties.
boolean	isSecure() Check whether this is a sips URI.
boolean	isSipURI() Check whether this URI is a "sip" or "sips" URI.
Buffer	toBuffer() Get the entire content of this URI as a Buffer.
String	toString()

Methods inherited from class io.pkts.packet.sip.address.impl.URIImpl

getBytes, getRawURI, getScheme

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.pkts.packet.sip.address.SipURI

builder, frame, frame, toSipURI, with, withHost, withHost, withParameters, withTemplate, withUser, withUser

Methods inherited from interface io.pkts.packet.sip.address.URI

getBytes, getScheme, isTelURI, toTelURI

Constructor Detail

SipURIImpl

public SipURIImpl(boolean isSips,
                  Buffer userInfo,
                  Buffer host,
                  Buffer port,
                  Buffer paramsHeaders,
                  Buffer original)

Parameters:

isSips - whether this is a sip or sips URL

userInfo - contains the so-called "userinfo" portion. Typically this is just the user but can optionally contain a password as well. See SipParser.consumeUserInfoHostPort(Buffer) for more information.

hostPort - contains the so-called "hostport", which is the domain + optional port.

paramsHeaders - any uri-parameters or headers that were on the SIP uri will be in this buffer. If empty or null then there were none.

original - the original buffer just because as long as no one is changing the content we can just return this buffer fast and easy.

Method Detail

isSipURI

public boolean isSipURI()

Check whether this URI is a "sip" or "sips" URI.

Specified by:

isSipURI in interface URI

Overrides:

isSipURI in class URIImpl

Returns:

true if this URI is a SIP URI, false otherwise.

isSecure

public boolean isSecure()

Check whether this is a sips URI.

Specified by:

isSecure in interface SipURI

Returns:

true if this indeed is a sips URI, false otherwise.

clone

public SipURI clone()

Specified by:

clone in interface SipURI

Specified by:

clone in interface URI

Specified by:

clone in class URIImpl

copy

public SipURI.Builder copy()

Description copied from interface: URI

All URIs are immutable so if you wish to change it you need to obtain a copy of it which will return a new builder that allows you to change and build a new URI.

Specified by:

copy in interface SipURI

Specified by:

copy in interface URI

Returns:

toBuffer

public Buffer toBuffer()

Get the entire content of this URI as a Buffer.

Specified by:

toBuffer in interface URI

Returns:

getUser

public Optional<Buffer> getUser()

Get the user portion of this URI.

Specified by:

getUser in interface SipURI

Returns:

the user portion of this URI or an empty optional if there is no user portion

getHost

public Buffer getHost()

Get the host portion of this URI.

Specified by:

getHost in interface SipURI

Returns:

getPort

public int getPort()

Get the port. If the port isn't set then -1 (negative one) will be returned.

Specified by:

getPort in interface SipURI

Returns:

getTransportParam

public Optional<Transport> getTransportParam()
                                      throws SipParseException

Description copied from interface: SipURI

Same as #getParameter("transport")

Specified by:

getTransportParam in interface SipURI

Returns:

Throws:

SipParseException

getUserParam

public Optional<Buffer> getUserParam()
                              throws SipParseException

Description copied from interface: SipURI

Get the user parameter. This is the same as #getParameter("user")

Specified by:

getUserParam in interface SipURI

Returns:

Throws:

SipParseException

getTTLParam

public int getTTLParam()
                throws SipParseException

Description copied from interface: SipURI

Get the ttl parameter. This is the same as #getParameter("ttl")

Specified by:

getTTLParam in interface SipURI

Returns:

the value of the TTL parameter or -1 (negative one) if it is not set.

Throws:

SipParseException

getMAddrParam

public Optional<Buffer> getMAddrParam()
                               throws SipParseException

Description copied from interface: SipURI

Get the maddr parameter. This is the same as #getParameter("maddr")

Specified by:

getMAddrParam in interface SipURI

Returns:

Throws:

SipParseException

getMethodParam

public Optional<Buffer> getMethodParam()
                                throws SipParseException

Description copied from interface: SipURI

Get the method parameter. This is the same as #getParameter("method")

Specified by:

getMethodParam in interface SipURI

Returns:

Throws:

SipParseException

equals

public boolean equals(Object other)

Comparing two SipURIs aren't trivial and the full set of rules are described in RFC3261 section 19.1.4 See rules for comparing URI's in RFC3261 section 19.1.4.

Specified by:

equals in interface SipURI

Overrides:

equals in class Object

hashCode

public int hashCode()

Now, the hash-code doesn't actually have to be unique for every little parameter and detail as the equals(Object) method is checking, we just need to take enough stuff into account to have a good enough spread and then the equals-method would be used to sort out any ties.

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getParameter

public Optional<Buffer> getParameter(Buffer name)
                              throws SipParseException,
                                     IllegalArgumentException

Description copied from interface: SipURI

Get the value of the named parameter. If the named parameter is a so-called flag parameter, then the value returned will be an empty Buffer, which can be checked with Buffer.isEmpty() or Buffer.capacity(), which will return zero. As with any empty Buffer, if you do Buffer.toString() you will be getting an empty String back, which would be yet another way to check for a flag parameter.

Specified by:

getParameter in interface SipURI

Parameters:

name - the name of the parameter we are looking for.

Returns:

the value of the named parameter or null if there is no such parameter. If the named parameter is a flag parameter, then an empty buffer will be returned.

Throws:

SipParseException - in case anything goes wrong while extracting the parameter.

IllegalArgumentException - in case the name is null.

getParameter

public Optional<Buffer> getParameter(String name)
                              throws SipParseException,
                                     IllegalArgumentException

Description copied from interface: SipURI

Same as SipURI.getParameter(Buffer).

Specified by:

getParameter in interface SipURI

Returns:

Throws:

SipParseException - in case anything goes wrong while extracting the parameter.

IllegalArgumentException - in case the name is null.