com.ongres.stringprep

Interface Profile

All Known Implementing Classes:

Nameprep, SASLprep

public interface Profile

The Profile interface is used to define stringprep profiles in order to fully specify the processing options.

Stringprep profiles can also exclude characters that should not normally appear in text that is used in the protocol. The profile can prevent such characters by changing the characters to be excluded to other characters, by removing those characters, or by causing an error if the characters would appear in the output.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
default int[]	additionalMappingTable(int codePoint) Any additional mapping tables specific to the profile.
default String	prepareQuery(String string) "Queries" are strings that are used to match against strings that are stored identifiers, such as user-entered names for digital certificate authorities and DNS lookups.
default String	prepareStored(String string) "Stored strings" are strings that are used in protocol identifiers and named entities, such as names in digital certificates and DNS domain name parts.
Set<Option>	profile() Set of options used by the profile.
default boolean	prohibitedAdditionalCharacters(int codePoint) Any additional characters that are prohibited as output specific to the profile.

Method Detail

profile

Set<Option> profile()

Set of options used by the profile.

Returns:

profile options.

prepareQuery

default String prepareQuery(String string)

"Queries" are strings that are used to match against strings that are stored identifiers, such as user-entered names for digital certificate authorities and DNS lookups.

Parameters:

string - to prepare based on a "stringprep" profile.

Returns:

The prepared String.

Throws:

IllegalArgumentException - if there is a prohibited output.

prepareStored

default String prepareStored(String string)

"Stored strings" are strings that are used in protocol identifiers and named entities, such as names in digital certificates and DNS domain name parts.

Parameters:

string - to prepare based on a "stringprep" profile.

Returns:

The prepared String.

Throws:

IllegalArgumentException - if there is a prohibited output.

additionalMappingTable

default int[] additionalMappingTable(int codePoint)

Any additional mapping tables specific to the profile.

Parameters:

codePoint - the character (Unicode code point) to be mapped.

Returns:

Mapping with the int[] array or with the same codePoint.

prohibitedAdditionalCharacters

default boolean prohibitedAdditionalCharacters(int codePoint)

Any additional characters that are prohibited as output specific to the profile.

Parameters:

codePoint - the character (Unicode code point) to be tested.

Returns:

true if the given codePoint is prohibited on this profile.