MySQL Connector/J 9.2.0 · com.mysql.cj.util.SaslPrep

Modifier and Type	Class and Description
public static enum	SaslPrep.StringType The type of string usage regarding the support for unassigned code points as described in RFC 3454, Section 7.

Access	Constructor and Description
public	SaslPrep()

Method Summary

Modifier and Type	Method and Description
private static boolean	Returns: `true` if the character is one of the ASCII control characters, `false` otherwise. isAsciiControlCharacter(char the character to check. chr) Prohibited Output: ASCII control characters [StringPrep, C.2.1].
private static boolean	Returns: `true` if the character is one of the LCat characters, `false` otherwise. isBidiLCat(int the code point of the character to check. cp) Bidirectional Characters: LCat characters.
private static boolean	Returns: `true` if the character is one of the RandALCat characters, `false` otherwise. isBidiRAndAlCat(int the code point of the character to check. cp) Bidirectional Characters: RandALCat characters.
private static boolean	Returns: `true` if the character is one of the change display properties or deprecated characters, `false` otherwise. isChangeDisplayPropertiesOrDeprecatedCharacter(char the character to check. chr) Prohibited Output: change display properties or deprecated characters [StringPrep, C.8].
private static boolean	Returns: `true` if the character is one of the inappropriate for canonical representation characters, `false` otherwise. isInappropriateForCanonicalRepresentationCharacter(char the character to check. chr) Prohibited Output: inappropriate for canonical representation characters [StringPrep, C.7].
private static boolean	Returns: `true` if the character is one of the inappropriate for plain text characters, `false` otherwise. isInappropriateForPlainTextCharacter(char the character to check. chr) Prohibited Output: inappropriate for plain text characters [StringPrep, C.6].
private static boolean	Returns: `true` if the character is one of the "commonly mapped to nothing" characters, `false` otherwise. isMappeableToNothing(char the character to check. chr) Mapping: the "commonly mapped to nothing" characters [StringPrep, B.1] that can be mapped to nothing.
private static boolean	Returns: `true` if the character is one of the non-ASCII control characters, `false` otherwise. isNonAsciiControlCharacter(int the code point of the character to check. cp) Prohibited Output: non-ASCII control characters [StringPrep, C.2.2].
private static boolean	Returns: `true` if the character is one of the non-ASCII space characters, `false` otherwise. isNonAsciiSpaceChar(char the character to check. chr) Mapping: non-ASCII space characters [StringPrep, C.1.2] that can be mapped to SPACE (U+0020).
private static boolean	Returns: `true` if the character is one of the non-character code points, `false` otherwise. isNonCharacterCodePoint(int the code point of the character to check. cp) Prohibited Output: non-character code points [StringPrep, C.4].
private static boolean	Returns: `true` if the character is one of the private use characters, `false` otherwise. isPrivateUseCharacter(int the code point of the character to check. cp) Prohibited Output: private use characters [StringPrep, C.3].
private static boolean	Returns: `true` if the character is prohibited according to the profile rules, `false` otherwise. isProhibited(char the character to check. chr, int the code point of the character to check. cp) Checks if the given character is one of the prohibited characters under the "SASLprep Profile" rules.
private static boolean	Returns: `true` if the character is one of the surrogate code points, `false` otherwise. isSurrogateCode(char the character to check. chr) Prohibited Output: surrogate code points [StringPrep, C.5].
private static boolean	Returns: `true` if the character is one of the tagging characters, `false` otherwise. isTaggingCharacter(int the code point of the character to check. cp) Prohibited Output: tagging characters [StringPrep, C.9].
private static boolean	Returns: `true` if the character is unassigned, `false` otherwise. isUnassigned(int the code point of the character to check. cp) Unassigned Code Points: list of unassigned code points.
private static String	Returns: a normalized version of the given string by the rules of the Unicode normalization form KC. normalizeKc(CharSequence the string to be normalized. str) Normalization: Unicode normalization form KC.
public static String	Returns: the prepared version of the given string. prepare(String the string to prepare. str, SaslPrep.StringType the type of preparation with regard to the support for unassigned code points. sType) Prepares the given string by applying the "SASLprep" profile of the "stringprep" algorithm.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

SaslPrep	back to summary
public SaslPrep()

Method Detail

isAsciiControlCharacter back to summary

isAsciiControlCharacter	back to summary
private static boolean isAsciiControlCharacter(char chr) Prohibited Output: ASCII control characters [StringPrep, C.2.1]. Parameters chr:char the character to check. Returns:boolean `true` if the character is one of the ASCII control characters, `false` otherwise.

private static boolean isAsciiControlCharacter(char chr)

Prohibited Output: ASCII control characters [StringPrep, C.2.1].

Parameters

chr:char: the character to check.

Returns:boolean

true if the character is one of the ASCII control characters, false otherwise.

isBidiLCat back to summary

isBidiLCat	back to summary
private static boolean isBidiLCat(int cp) Bidirectional Characters: LCat characters. See also RFC 3454, Section 6 Parameters cp:int the code point of the character to check. Returns:boolean `true` if the character is one of the LCat characters, `false` otherwise.

private static boolean isBidiLCat(int cp)

Bidirectional Characters: LCat characters. See also RFC 3454, Section 6

Parameters

cp:int: the code point of the character to check.

Returns:boolean

true if the character is one of the LCat characters, false otherwise.

isBidiRAndAlCat back to summary

isBidiRAndAlCat	back to summary
private static boolean isBidiRAndAlCat(int cp) Bidirectional Characters: RandALCat characters. See also RFC 3454, Section 6 Parameters cp:int the code point of the character to check. Returns:boolean `true` if the character is one of the RandALCat characters, `false` otherwise.

private static boolean isBidiRAndAlCat(int cp)

Bidirectional Characters: RandALCat characters. See also RFC 3454, Section 6

Parameters

cp:int: the code point of the character to check.

Returns:boolean

true if the character is one of the RandALCat characters, false otherwise.

isChangeDisplayPropertiesOrDeprecatedCharacter back to summary

isChangeDisplayPropertiesOrDeprecatedCharacter	back to summary
private static boolean isChangeDisplayPropertiesOrDeprecatedCharacter(char chr) Prohibited Output: change display properties or deprecated characters [StringPrep, C.8]. Parameters chr:char the character to check. Returns:boolean `true` if the character is one of the change display properties or deprecated characters, `false` otherwise.

private static boolean isChangeDisplayPropertiesOrDeprecatedCharacter(char chr)

Prohibited Output: change display properties or deprecated characters [StringPrep, C.8].

Parameters

chr:char: the character to check.

Returns:boolean

true if the character is one of the change display properties or deprecated characters, false otherwise.

isInappropriateForCanonicalRepresentationCharacter back to summary

isInappropriateForCanonicalRepresentationCharacter	back to summary
private static boolean isInappropriateForCanonicalRepresentationCharacter(char chr) Prohibited Output: inappropriate for canonical representation characters [StringPrep, C.7]. Parameters chr:char the character to check. Returns:boolean `true` if the character is one of the inappropriate for canonical representation characters, `false` otherwise.

private static boolean isInappropriateForCanonicalRepresentationCharacter(char chr)

Prohibited Output: inappropriate for canonical representation characters [StringPrep, C.7].

Parameters

chr:char: the character to check.

Returns:boolean

true if the character is one of the inappropriate for canonical representation characters, false otherwise.

isInappropriateForPlainTextCharacter back to summary

isInappropriateForPlainTextCharacter	back to summary
private static boolean isInappropriateForPlainTextCharacter(char chr) Prohibited Output: inappropriate for plain text characters [StringPrep, C.6]. Parameters chr:char the character to check. Returns:boolean `true` if the character is one of the inappropriate for plain text characters, `false` otherwise.

private static boolean isInappropriateForPlainTextCharacter(char chr)

Prohibited Output: inappropriate for plain text characters [StringPrep, C.6].

Parameters

chr:char: the character to check.

Returns:boolean

true if the character is one of the inappropriate for plain text characters, false otherwise.

isMappeableToNothing back to summary

isMappeableToNothing	back to summary
private static boolean isMappeableToNothing(char chr) Mapping: the "commonly mapped to nothing" characters [StringPrep, B.1] that can be mapped to nothing. Parameters chr:char the character to check. Returns:boolean `true` if the character is one of the "commonly mapped to nothing" characters, `false` otherwise.

private static boolean isMappeableToNothing(char chr)

Mapping: the "commonly mapped to nothing" characters [StringPrep, B.1] that can be mapped to nothing.

Parameters

chr:char: the character to check.

Returns:boolean

true if the character is one of the "commonly mapped to nothing" characters, false otherwise.

isNonAsciiControlCharacter back to summary

isNonAsciiControlCharacter	back to summary
private static boolean isNonAsciiControlCharacter(int cp) Prohibited Output: non-ASCII control characters [StringPrep, C.2.2]. Parameters cp:int the code point of the character to check. Returns:boolean `true` if the character is one of the non-ASCII control characters, `false` otherwise.

private static boolean isNonAsciiControlCharacter(int cp)

Prohibited Output: non-ASCII control characters [StringPrep, C.2.2].

Parameters

cp:int: the code point of the character to check.

Returns:boolean

true if the character is one of the non-ASCII control characters, false otherwise.

isNonAsciiSpaceChar back to summary

isNonAsciiSpaceChar	back to summary
private static boolean isNonAsciiSpaceChar(char chr) Mapping: non-ASCII space characters [StringPrep, C.1.2] that can be mapped to SPACE (U+0020). Parameters chr:char the character to check. Returns:boolean `true` if the character is one of the non-ASCII space characters, `false` otherwise.

private static boolean isNonAsciiSpaceChar(char chr)

Mapping: non-ASCII space characters [StringPrep, C.1.2] that can be mapped to SPACE (U+0020).

Parameters

chr:char: the character to check.

Returns:boolean

true if the character is one of the non-ASCII space characters, false otherwise.

isNonCharacterCodePoint back to summary

isNonCharacterCodePoint	back to summary
private static boolean isNonCharacterCodePoint(int cp) Prohibited Output: non-character code points [StringPrep, C.4]. Parameters cp:int the code point of the character to check. Returns:boolean `true` if the character is one of the non-character code points, `false` otherwise.

private static boolean isNonCharacterCodePoint(int cp)

Prohibited Output: non-character code points [StringPrep, C.4].

Parameters

cp:int: the code point of the character to check.

Returns:boolean

true if the character is one of the non-character code points, false otherwise.

isPrivateUseCharacter back to summary

isPrivateUseCharacter	back to summary
private static boolean isPrivateUseCharacter(int cp) Prohibited Output: private use characters [StringPrep, C.3]. Parameters cp:int the code point of the character to check. Returns:boolean `true` if the character is one of the private use characters, `false` otherwise.

private static boolean isPrivateUseCharacter(int cp)

Prohibited Output: private use characters [StringPrep, C.3].

Parameters

cp:int: the code point of the character to check.

Returns:boolean

true if the character is one of the private use characters, false otherwise.

isProhibited back to summary

isProhibited	back to summary
private static boolean isProhibited(char chr, int cp) Checks if the given character is one of the prohibited characters under the "SASLprep Profile" rules. Parameters chr:char the character to check. cp:int the code point of the character to check. Returns:boolean `true` if the character is prohibited according to the profile rules, `false` otherwise. See Also RFC 4013, Section 2.3

private static boolean isProhibited(char chr, int cp)

Checks if the given character is one of the prohibited characters under the "SASLprep Profile" rules.

Parameters

chr:char: the character to check.
cp:int: the code point of the character to check.

Returns:boolean

true if the character is prohibited according to the profile rules, false otherwise.

See Also

RFC 4013, Section 2.3

isSurrogateCode back to summary

isSurrogateCode	back to summary
private static boolean isSurrogateCode(char chr) Prohibited Output: surrogate code points [StringPrep, C.5]. Parameters chr:char the character to check. Returns:boolean `true` if the character is one of the surrogate code points, `false` otherwise.

private static boolean isSurrogateCode(char chr)

Prohibited Output: surrogate code points [StringPrep, C.5].

Parameters

chr:char: the character to check.

Returns:boolean

true if the character is one of the surrogate code points, false otherwise.

isTaggingCharacter back to summary

isTaggingCharacter	back to summary
private static boolean isTaggingCharacter(int cp) Prohibited Output: tagging characters [StringPrep, C.9]. Parameters cp:int the code point of the character to check. Returns:boolean `true` if the character is one of the tagging characters, `false` otherwise.

private static boolean isTaggingCharacter(int cp)

Prohibited Output: tagging characters [StringPrep, C.9].

Parameters

cp:int: the code point of the character to check.

Returns:boolean

true if the character is one of the tagging characters, false otherwise.

isUnassigned back to summary

isUnassigned	back to summary
private static boolean isUnassigned(int cp) Unassigned Code Points: list of unassigned code points. See also RFC 3454, Section 7. Note that this implementation does not check exactly the unassigned code points as specified in the RFC since it is based on Java's Unicode support, which is updated regularly while the specification is based on a static list of code points. This should have no major impact, though. Parameters cp:int the code point of the character to check. Returns:boolean `true` if the character is unassigned, `false` otherwise.

private static boolean isUnassigned(int cp)

Unassigned Code Points: list of unassigned code points. See also RFC 3454, Section 7.

Note that this implementation does not check exactly the unassigned code points as specified in the RFC since it is based on Java's Unicode support, which is updated regularly while the specification is based on a static list of code points. This should have no major impact, though.

Parameters

cp:int: the code point of the character to check.

Returns:boolean

true if the character is unassigned, false otherwise.

normalizeKc	back to summary
private static String normalizeKc(CharSequence str) Normalization: Unicode normalization form KC. Parameters str:CharSequence the string to be normalized. Returns:String a normalized version of the given string by the rules of the Unicode normalization form KC.

normalizeKc

back to summary

private static String normalizeKc(CharSequence str)

Normalization: Unicode normalization form KC.

Parameters

str:CharSequence: the string to be normalized.

Returns:String

a normalized version of the given string by the rules of the Unicode normalization form KC.

prepare	back to summary
public static String prepare(String str, SaslPrep.StringType sType) Prepares the given string by applying the "SASLprep" profile of the "stringprep" algorithm. Parameters str:String the string to prepare. sType:SaslPrep.StringType the type of preparation with regard to the support for unassigned code points. Returns:String the prepared version of the given string. See Also RFC 4013, RFC 3454

prepare

back to summary

public static String prepare(String str, SaslPrep.StringType sType)

Prepares the given string by applying the "SASLprep" profile of the "stringprep" algorithm.

Parameters

str:String: the string to prepare.
sType:SaslPrep.StringType: the type of preparation with regard to the support for unassigned code points.

Returns:String

the prepared version of the given string.

See Also

RFC 4013, RFC 3454

Modifier and Type	Field and Description
public static final SaslPrep.StringType	QUERY Queries for matching strings MAY contain unassigned code points.
public static final SaslPrep.StringType	STORED Stored strings using the profile MUST NOT contain any unassigned code points.

Modifier and Type	Method and Description
public static SaslPrep.StringType	valueOf(String name)
public static SaslPrep.StringType[]	values()

public Class SaslPrep

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum SaslPrep.StringType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail