org.jxmpp.util

Class XmppStringUtils

java.lang.Object

org.jxmpp.util.XmppStringUtils

public class XmppStringUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
XmppStringUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	completeJidFrom(java.lang.String localpart, java.lang.String domainpart)
static java.lang.String	completeJidFrom(java.lang.String localpart, java.lang.String domainpart, java.lang.String resource)
static java.lang.String	escapeLocalpart(java.lang.String localpart) Escapes the localpart of a JID according to "JID Escaping" (XEP-0106).
static boolean	isFullJID(java.lang.String jid) Returns true if jid is a full JID (i.e.
static java.lang.String	parseBareAddress(java.lang.String jid) Returns the JID with any resource information removed.
static java.lang.String	parseDomain(java.lang.String jid) Returns the domain of a JID.
static java.lang.String	parseLocalpart(java.lang.String jid) Returns the localpart of a JID.
static java.lang.String	parseResource(java.lang.String jid) Returns the resource portion of a JID.
static java.lang.String	unescapeLocalpart(java.lang.String localpart) Un-escapes the localpart of a JID according to "JID Escaping" (XEP-0106).

Methods inherited from class java.lang.Object

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

Constructor Detail

XmppStringUtils

public XmppStringUtils()

Method Detail

parseLocalpart

public static java.lang.String parseLocalpart(java.lang.String jid)

Returns the localpart of a JID. For example, for the address "matt@jivesoftware.com/Smack", "matt" would be returned. If no username is present in the address, the empty string will be returned.

Parameters:

jid - the XMPP address.

Returns:

the name portion of the XMPP address.

parseDomain

public static java.lang.String parseDomain(java.lang.String jid)

Returns the domain of a JID. For example, for the address "matt@jivesoftware.com/Smack", "jivesoftware.com" would be returned. If no server is present in the address, the empty string will be returned.

Parameters:

jid - the XMPP address.

Returns:

the server portion of the XMPP address.

parseResource

public static java.lang.String parseResource(java.lang.String jid)

Returns the resource portion of a JID. For example, for the address "matt@jivesoftware.com/Smack", "Smack" would be returned. If no resource is present in the address, the empty string will be returned.

Parameters:

jid - the XMPP address.

Returns:

the resource portion of the XMPP address.

parseBareAddress

public static java.lang.String parseBareAddress(java.lang.String jid)

Returns the JID with any resource information removed. For example, for the address "matt@jivesoftware.com/Smack", "matt@jivesoftware.com" would be returned.

Parameters:

jid - the XMPP address.

Returns:

the bare XMPP address without resource information.

isFullJID

public static boolean isFullJID(java.lang.String jid)

Returns true if jid is a full JID (i.e. a JID with resource part).

Parameters:

jid -

Returns:

true if full JID, false otherwise

escapeLocalpart

public static java.lang.String escapeLocalpart(java.lang.String localpart)

Escapes the localpart of a JID according to "JID Escaping" (XEP-0106). Escaping replaces characters prohibited by Nodeprep with escape sequences, as follows:

Unescaped Character	Encoded Sequence
<space>	\20
"	\22
&	\26
'	\27
/	\2f
:	\3a
<	\3c
>	\3e
@	\40
\	\5c

This process is useful when the localpart comes from an external source that doesn't conform to Nodeprep. For example, a username in LDAP may be "Joe Smith". Because the <space> character isn't a valid part of a localpart, the username should be escaped to "Joe\20Smith" before being made into a JID (e.g. "joe\20smith@example.com" after case-folding, etc. has been applied).

All localpart escaping and un-escaping must be performed manually at the appropriate time; the JID class will not escape or un-escape automatically.

Parameters:

localpart - the localpart.

Returns:

the escaped version of the localpart.

See Also:

XEP-106: JID Escaping

unescapeLocalpart

public static java.lang.String unescapeLocalpart(java.lang.String localpart)

Un-escapes the localpart of a JID according to "JID Escaping" (XEP-0106). Escaping replaces characters prohibited by Nodeprep with escape sequences, as follows:

Unescaped Character	Encoded Sequence
<space>	\20
"	\22
&	\26
'	\27
/	\2f
:	\3a
<	\3c
>	\3e
@	\40
\	\5c

This process is useful when the localpart comes from an external source that doesn't conform to Nodeprep. For example, a username in LDAP may be "Joe Smith". Because the <space> character isn't a valid part of a localpart, the username should be escaped to "Joe\20Smith" before being made into a JID (e.g. "joe\20smith@example.com" after case-folding, etc. has been applied).

All localpart escaping and un-escaping must be performed manually at the appropriate time; the JID class will not escape or un-escape automatically.

Parameters:

localpart - the escaped version of the localpart.

Returns:

the un-escaped version of the localpart.

See Also:

XEP-106: JID Escaping

completeJidFrom

public static java.lang.String completeJidFrom(java.lang.String localpart,
                               java.lang.String domainpart)

completeJidFrom

public static java.lang.String completeJidFrom(java.lang.String localpart,
                               java.lang.String domainpart,
                               java.lang.String resource)