io.pkts.packet.sip.address

Interface TelURI

All Superinterfaces:

URI

All Known Implementing Classes:

TelURIImpl

public interface TelURI
extends URI

Author:

dmnava

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TelURI.Builder

Method Summary

Modifier and Type	Method and Description
static TelURI	frame(Buffer buffer) Frame a TEL Uri, which according to RFC 3966 has the following syntax:
Buffer	getParameter(Buffer name) Get the value of the named parameter.
Buffer	getParameter(String name) Same as getParameter(Buffer).
Buffer	getPhoneNumber() Returns the phone number, without the '+' in case of global number
boolean	isGlobal() Specifies whether the telephone number is global or not
default boolean	isTelURI() Check whether this URI is a "tel" URI.
default TelURI	toTelURI()
static TelURI.Builder	withPhoneNumber(Buffer phoneNumber)
static TelURI.Builder	withPhoneNumber(String phoneNumber)

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

clone, copy, getBytes, getScheme, isSipURI, toBuffer, toSipURI

Method Detail

isGlobal

boolean isGlobal()

Specifies whether the telephone number is global or not

Returns:

getPhoneNumber

Buffer getPhoneNumber()

Returns the phone number, without the '+' in case of global number

Returns:

isTelURI

default boolean isTelURI()

Description copied from interface: URI

Check whether this URI is a "tel" URI.

Specified by:

isTelURI in interface URI

Returns:

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

toTelURI

default TelURI toTelURI()

Specified by:

toTelURI in interface URI

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.

frame

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

Frame a TEL Uri, which according to RFC 3966 has the following syntax:

    telephone-uri        = "tel:" telephone-subscriber
    telephone-subscriber = global-number / local-number
    global-number        = global-number-digits *par
    local-number         = local-number-digits *par context *par
    par                  = parameter / extension / isdn-subaddress
    isdn-subaddress      = ";isub=" 1*uric
    extension            = ";ext=" 1*phonedigit
    context              = ";phone-context=" descriptor
    descriptor           = domainname / global-number-digits
    global-number-digits = "+" *phonedigit DIGIT *phonedigit
    local-number-digits  = phonedigit-hex (HEXDIG / "*" / "#")*phonedigit-hex
    domainname           = *( domainlabel "." ) toplabel [ "." ]
    domainlabel          = alphanum
                              / alphanum *( alphanum / "-" ) alphanum
    toplabel             = ALPHA / ALPHA *( alphanum / "-" ) alphanum
    parameter            = ";" pname ["=" pvalue ]
    pname                = 1*( alphanum / "-" )
    pvalue               = 1*paramchar
    paramchar            = param-unreserved / unreserved / pct-encoded
    unreserved           = alphanum / mark
    mark                 = "-" / "_" / "." / "!" / "~" / "*" / "'" / "(" / ")"
    pct-encoded          = "%" HEXDIG HEXDIG
    param-unreserved     = "[" / "]" / "/" / ":" / "&" / "+" / "$"
    phonedigit           = DIGIT / [ visual-separator ]
    phonedigit-hex       = HEXDIG / "*" / "#" / [ visual-separator ]
    visual-separator     = "-" / "." / "(" / ")"
    alphanum             = ALPHA / DIGIT
    reserved             = ";" / "/" / "?" / ":" / "@" / "&" / "=" / "+" / "$" / ","
    uric                 = reserved / unreserved / pct-encoded
 

Specified by:

frame in interface URI

Parameters:

buffer -

Returns:

Throws:

SipParseException

IndexOutOfBoundsException

IOException

withPhoneNumber

static TelURI.Builder withPhoneNumber(Buffer phoneNumber)

withPhoneNumber

static TelURI.Builder withPhoneNumber(String phoneNumber)