io.pkts.packet.sip.address

Interface SipURI

All Superinterfaces:

URI

All Known Implementing Classes:

SipURIImpl

public interface SipURI
extends URI

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SipURI.Builder

Method Summary

Modifier and Type	Method and Description
SipURI	clone()
boolean	equals(Object o) See rules for comparing URI's in RFC3261 section 19.1.4.
static SipURI	frame(Buffer buffer) Frame a sip or sips-uri, which according to RFC3261 is:
Buffer	getHost() Get the host portion of this URI.
Buffer	getMAddrParam() Get the maddr parameter.
Buffer	getMethodParam() Get the method parameter.
Buffer	getParameter(Buffer name) Get the value of the named parameter.
Buffer	getParameter(String name) Same as getParameter(Buffer).
int	getPort() Get the port.
Buffer	getTransportParam() Same as #getParameter("transport")
int	getTTLParam() Get the ttl parameter.
Buffer	getUser() Get the user portion of this URI.
Buffer	getUserParam() Get the user parameter.
boolean	isSecure() Check whether this is a sips URI.
void	setParameter(Buffer name, Buffer value) Sets the value of the specified parameter.
void	setParameter(Buffer name, int value)
void	setParameter(String name, int value)
void	setParameter(String name, String value)
void	setPort(int port) Set the port.
Buffer	toBuffer() Get the entire content of the SipURI as a Buffer.
static SipURI.Builder	with()
static SipURI.Builder	with(SipURI uri) Create a new SipURI.Builder based on the SipURI.

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

getBytes, getScheme, isSipURI

Method Detail

getUser

Buffer getUser()

Get the user portion of this URI.

Returns:

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

getHost

Buffer getHost()

Get the host portion of this URI.

Returns:

getPort

int getPort()

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

Returns:

setPort

void setPort(int port)

Set the port. If you specify -1 (negative one), then no port will be included in the final SIP URI. However, if you explicitly set the port to something, then it will be included in the final result.

Parameters:

port -

isSecure

boolean isSecure()

Check whether this is a sips URI.

Returns:

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

getTransportParam

Buffer getTransportParam()
                  throws SipParseException

Same as #getParameter("transport")

Returns:

Throws:

SipParseException

getUserParam

Buffer getUserParam()
             throws SipParseException

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

Returns:

Throws:

SipParseException

getTTLParam

int getTTLParam()
         throws SipParseException

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

Returns:

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

Throws:

SipParseException

getMAddrParam

Buffer getMAddrParam()
              throws SipParseException

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

Returns:

Throws:

SipParseException

getMethodParam

Buffer getMethodParam()
               throws SipParseException

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

Returns:

Throws:

SipParseException

getParameter

Buffer getParameter(Buffer name)
             throws SipParseException,
                    IllegalArgumentException

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.

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

Buffer getParameter(String name)
             throws SipParseException,
                    IllegalArgumentException

Same as getParameter(Buffer).

Parameters:

name -

Returns:

Throws:

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

IllegalArgumentException - in case the name is null.

setParameter

void setParameter(Buffer name,
                  Buffer value)
           throws SipParseException,
                  IllegalArgumentException

Sets the value of the specified parameter. If there already is a parameter with the same name its value will be overridden. A value of null or a zero length buffer means that this parameter is a flag parameter

Parameters:

name - the name of the parameter

value - the value of the parameter or null if you just want to set a flag parameter

Throws:

SipParseException - in case anything goes wrong when setting the parameter.

IllegalArgumentException - in case the name is null or empty.

setParameter

void setParameter(String name,
                  String value)
           throws SipParseException,
                  IllegalArgumentException

Parameters:

name -

value -

Throws:

SipParseException

IllegalArgumentException

setParameter

void setParameter(Buffer name,
                  int value)
           throws SipParseException,
                  IllegalArgumentException

Parameters:

name -

value -

Throws:

SipParseException

IllegalArgumentException

setParameter

void setParameter(String name,
                  int value)
           throws SipParseException,
                  IllegalArgumentException

Parameters:

name -

value -

Throws:

SipParseException

IllegalArgumentException

equals

boolean equals(Object o)

See rules for comparing URI's in RFC3261 section 19.1.4.

Overrides:

equals in class Object

Parameters:

o -

Returns:

toBuffer

Buffer toBuffer()

Get the entire content of the SipURI as a Buffer.

Returns:

clone

SipURI clone()

Specified by:

clone in interface URI

frame

static SipURI frame(Buffer buffer)
             throws SipParseException,
                    IndexOutOfBoundsException,
                    IOException

Frame a sip or sips-uri, which according to RFC3261 is:

 SIP-URI          =  "sip:" [ userinfo ] hostport
                      uri-parameters [ headers ]
 SIPS-URI         =  "sips:" [ userinfo ] hostport
                      uri-parameters [ headers ]
 

Remember though that all these frame-functions will only do a basic verification that all things are ok so just because this function return without an exception doesn't mean that you actually framed a valid URI. Everything is done lazily so things may blow up later. Also note that this function assumes that someone else has already determined the boundaries for this sip(s)-uri and as such, this function does not expect '<' etc.

Specified by:

frame in interface URI

Parameters:

buffer -

Returns:

Throws:

SipParseException

IOException

IndexOutOfBoundsException

with

static SipURI.Builder with()

with

static SipURI.Builder with(SipURI uri)

Create a new SipURI.Builder based on the SipURI.

• user
• host
• port
• transport
• schema (sip or sips)

Any other parameter will be ignored.

Parameters:

uri -

Returns: