rocks.xmpp.precis

Class PrecisProfiles

java.lang.Object

rocks.xmpp.precis.PrecisProfiles

public final class PrecisProfiles
extends Object

This class provides common PRECIS profiles, mainly specified by Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords (RFC 7613). Each profile offers methods for preparation, enforcement and comparison of Unicode strings.

Preparation

Preparation ensures, that a string contains only valid characters, but usually does not apply any mapping rules.

 
 PrecisProfiles.USERNAME_CASE_MAPPED.prepare("UpperCaseUsername");
 
 

If the passed string contains any invalid characters, an InvalidCodePointException is thrown:

 
 PrecisProfiles.USERNAME_CASE_MAPPED.prepare("Username♚"); // Contains symbol, throws exception.
 
 

Enforcement

Enforcement applies specific rules (e.g. case mapping) to the string for the purpose of determining if the string can be used in a given protocol slot.

 
 String enforced = PrecisProfiles.USERNAME_CASE_MAPPED.enforce("UpperCaseUsername"); // uppercaseusername
 
 

Comparison

Usually you can just use String.equals() on two enforced strings to determine if they are equivalent, e.g.:

 
 PrecisProfile profile = PrecisProfiles.USERNAME_CASE_MAPPED;
 if (profile.enforce("foobar").equals(profile.enforce("FooBar"))) {
     // username already exists.
 }
 
 

However, using PrecisProfile.compare(CharSequence, CharSequence) is preferable, because a profile may use different rules during comparison than during enforcement (as the Nickname profile, RFC 7700):

 
 if (profile.compare("foobar", "FooBar") == 0) {
     // username already exists.
 }
 
 

Also note that PrecisProfile implements Comparator.

See Also:

PrecisProfile

Field Summary

Fields

Modifier and Type	Field and Description
static PrecisProfile	NICKNAME The "Nickname Profile" specified in "Preparation, Enforcement, and Comparison of Internationalized Strings Representing Nicknames", RFC 7700.
static PrecisProfile	OPAQUE_STRING The "OpaqueString Profile" specified in "Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords", RFC 7613.
static PrecisProfile	USERNAME_CASE_MAPPED The "UsernameCaseMapped Profile" specified in "Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords", RFC 7613.
static PrecisProfile	USERNAME_CASE_PRESERVED The "UsernameCasePreserved Profile" specified in "Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords", RFC 7613.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

USERNAME_CASE_MAPPED

public static final PrecisProfile USERNAME_CASE_MAPPED

The "UsernameCaseMapped Profile" specified in "Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords", RFC 7613.

See Also:

3.2. UsernameCaseMapped Profile

USERNAME_CASE_PRESERVED

public static final PrecisProfile USERNAME_CASE_PRESERVED

The "UsernameCasePreserved Profile" specified in "Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords", RFC 7613.

See Also:

3.3. UsernameCasePreserved Profile

OPAQUE_STRING

public static final PrecisProfile OPAQUE_STRING

The "OpaqueString Profile" specified in "Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords", RFC 7613.

See Also:

4.2. OpaqueString Profile

NICKNAME

public static final PrecisProfile NICKNAME

The "Nickname Profile" specified in "Preparation, Enforcement, and Comparison of Internationalized Strings Representing Nicknames", RFC 7700.

See Also:

Preparation, Enforcement, and Comparison of Internationalized Strings Representing Nicknames