io.pkts.packet.sip.impl

Class SipUserHostInfo

java.lang.Object

io.pkts.packet.sip.impl.SipUserHostInfo

public class SipUserHostInfo
extends Object

Represents the user/host info portion of the SIP URI.

Method Summary

Modifier and Type	Method and Description
static SipUserHostInfo	frame(Buffer buffer) Frames a SIP URI user/host info portion, specified in RFC 3261 as:
Buffer	getHost() Accesses the host portion of the SIP URI To be valid, the URI must contain the host portion--this method should always return a value.
Buffer	getPort() Accesses the port portion of the SIP URI
Buffer	getUser() Accesses the user portion of the SIP URI

Methods inherited from class java.lang.Object

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

Method Detail

frame

public static SipUserHostInfo frame(Buffer buffer)
                             throws SipParseException,
                                    IOException

Frames a SIP URI user/host info portion, specified in RFC 3261 as:

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

 userinfo         =  ( user / telephone-subscriber ) [ ":" password ] "@"
 user             =  1*( unreserved / escaped / user-unreserved )
 user-unreserved  =  "&" / "=" / "+" / "$" / "," / ";" / "?" / "/"
 password         =  *( unreserved / escaped / "&" / "=" / "+" / "$" / "," )
 hostport         =  host [ ":" port ]
 

The URI is consumed up to the start uri-parameters or headers section, whichever is encountered first.

Parameters:

buffer - a buffer, which should begin at the start of the user/host info section

Returns:

a SipUserHostInfo object, encoding the parsed information

Throws:

SipParseException

IOException

getUser

public Buffer getUser()

Accesses the user portion of the SIP URI

Returns:

a buffer containing the user portion, or null if not specified in the URI

getHost

public Buffer getHost()

Accesses the host portion of the SIP URI To be valid, the URI must contain the host portion--this method should always return a value.

Returns:

a buffer containing the host portion

getPort

public Buffer getPort()

Accesses the port portion of the SIP URI

Returns:

a buffer containing the port portion, or null if not specified in the URI