org.jwat.common

Class UriProfile

java.lang.Object

org.jwat.common.UriProfile

public class UriProfile
extends java.lang.Object

Implementation of an URI profile. A profile can be used to customize which characters and features are acceptable when a certain profile is used. An array of integers is used to defined which categories the first 8-bit characters belong to.

Author:

nicl

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	asciiHexTab Hex char to integer conversion table.
static int	B_ALPHAS Bit to categorize a char as an alpha.
static int	B_DIGITS Bit to categorize a char as a digit.
static int	B_FRAGMENT Bit to categorize a char as FRAGMENT in RFC3986.
static int	B_GEN_DELIMS Bit to categorize a char as GEN-DELIMS in RFC3986.
static int	B_PATH Bit to categorize a char as PATH in RFC3986.
static int	B_PCHAR Bit to categorize a char as PCHAR in RFC3986.
static int	B_QUERY Bit to categorize a char as QUERY in RFC3986.
static int	B_REGNAME Bit to categorize a char as REGNAME in RFC3986.
static int	B_RESERVED Bit to categorize a char as RESERVED in RFC3986.
static int	B_SCHEME_FIRST Bit to categorize a char as first in scheme.
static int	B_SCHEME_FOLLOW Bit to categorize a char as following in scheme.
static int	B_SEGMENT Bit to categorize a char as SEGMENT in RFC3986.
static int	B_SEGMENT_NZ Bit to categorize a char as SEGMENT-NZ in RFC3986.
static int	B_SEGMENT_NZ_NC Bit to categorize a char as SEGMENT-NZ-NC in RFC3986.
static int	B_SUB_DELIMS Bit to categorize a char as SUB-DELIMS in RFC3986.
static int	B_UNRESERVED Bit to categorize a char as UNRESERVED in RFC3986.
static int	B_USERINFO Bit to categorize a char as USERINFO in RFC3986.
boolean	bAllow16bitPercentEncoding Does profile allow 16-bit percent encoding.
boolean	bAllowInvalidPercentEncoding Does profile allow invalid percent encoding.
boolean	bAllowRelativeUris Does profile allow relative URIs.
protected int[]	charTypeMap Array of integers used to categorize all 8bit chars.
protected static int[]	defaultCharTypeMap Default array of integers used to categorize all 8bit chars.
static char[]	hexTab Integer to hex char conversion table.
static UriProfile	RFC3986 RFC3986 compliant URI profile.
static UriProfile	RFC3986_ABS_16BIT Modified RFC3986 URI profile which disallows relative URIs and allows 16-bit percent encoding.
static UriProfile	RFC3986_ABS_16BIT_LAX Relaxed RFC3986 URI profile which disallows relative URIs, allows 16-bit percent encoding, allow invalid percent encoding and allows most 8-bit characters.

Constructor Summary

Constructors

Constructor and Description
UriProfile() Construct an UriProfile initialized with RFC3986 rules.
UriProfile(UriProfile uriProfile) Construct an UriProfile initialized from another profile.

Method Summary

Modifier and Type	Method and Description
static void	charTypeAddAndOr(int[] charTypeMap, java.lang.String chars, int bw_and, int bw_or) Helper method to populate an integer array with character categories.
void	charTypeAddAndOr(java.lang.String chars, int bw_and, int bw_or) Helper method to populate the profiles integer array with character categories.
int	indexOf(int bw_and, java.lang.String str, int pos) Given a collection of characters find the index of the first occurrence of any of the characters in the supplied string starting from a certain position.
java.lang.String	validate_decode(int bw_and, java.lang.String componentName, java.lang.String str) Validates an URI component according to the supplied character category bitfield.
void	validate_first_follow(java.lang.String str, int bw_and_first, int bw_and_follow) Validate an URI component using two character categories.

Methods inherited from class java.lang.Object

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

Field Detail

B_ALPHAS

public static final int B_ALPHAS

Bit to categorize a char as an alpha.

See Also:

Constant Field Values

B_DIGITS

public static final int B_DIGITS

Bit to categorize a char as a digit.

See Also:

Constant Field Values

B_SCHEME_FIRST

public static final int B_SCHEME_FIRST

Bit to categorize a char as first in scheme.

See Also:

Constant Field Values

B_SCHEME_FOLLOW

public static final int B_SCHEME_FOLLOW

Bit to categorize a char as following in scheme.

See Also:

Constant Field Values

B_UNRESERVED

public static final int B_UNRESERVED

Bit to categorize a char as UNRESERVED in RFC3986.

See Also:

Constant Field Values

B_GEN_DELIMS

public static final int B_GEN_DELIMS

Bit to categorize a char as GEN-DELIMS in RFC3986.

See Also:

Constant Field Values

B_SUB_DELIMS

public static final int B_SUB_DELIMS

Bit to categorize a char as SUB-DELIMS in RFC3986.

See Also:

Constant Field Values

B_RESERVED

public static final int B_RESERVED

Bit to categorize a char as RESERVED in RFC3986.

See Also:

Constant Field Values

B_PCHAR

public static final int B_PCHAR

Bit to categorize a char as PCHAR in RFC3986.

See Also:

Constant Field Values

B_USERINFO

public static final int B_USERINFO

Bit to categorize a char as USERINFO in RFC3986.

See Also:

Constant Field Values

B_REGNAME

public static final int B_REGNAME

Bit to categorize a char as REGNAME in RFC3986.

See Also:

Constant Field Values

B_SEGMENT

public static final int B_SEGMENT

Bit to categorize a char as SEGMENT in RFC3986.

See Also:

Constant Field Values

B_SEGMENT_NZ

public static final int B_SEGMENT_NZ

Bit to categorize a char as SEGMENT-NZ in RFC3986.

See Also:

Constant Field Values

B_SEGMENT_NZ_NC

public static final int B_SEGMENT_NZ_NC

Bit to categorize a char as SEGMENT-NZ-NC in RFC3986.

See Also:

Constant Field Values

B_PATH

public static final int B_PATH

Bit to categorize a char as PATH in RFC3986.

See Also:

Constant Field Values

B_QUERY

public static final int B_QUERY

Bit to categorize a char as QUERY in RFC3986.

See Also:

Constant Field Values

B_FRAGMENT

public static final int B_FRAGMENT

Bit to categorize a char as FRAGMENT in RFC3986.

See Also:

Constant Field Values

charTypeMap

protected final int[] charTypeMap

Array of integers used to categorize all 8bit chars.

bAllowRelativeUris

public boolean bAllowRelativeUris

Does profile allow relative URIs.

bAllow16bitPercentEncoding

public boolean bAllow16bitPercentEncoding

Does profile allow 16-bit percent encoding.

bAllowInvalidPercentEncoding

public boolean bAllowInvalidPercentEncoding

Does profile allow invalid percent encoding.

asciiHexTab

public static int[] asciiHexTab

Hex char to integer conversion table.

hexTab

public static char[] hexTab

Integer to hex char conversion table.

defaultCharTypeMap

protected static int[] defaultCharTypeMap

Default array of integers used to categorize all 8bit chars.

RFC3986

public static final UriProfile RFC3986

RFC3986 compliant URI profile.

RFC3986_ABS_16BIT

public static final UriProfile RFC3986_ABS_16BIT

Modified RFC3986 URI profile which disallows relative URIs and allows 16-bit percent encoding.

RFC3986_ABS_16BIT_LAX

public static final UriProfile RFC3986_ABS_16BIT_LAX

Relaxed RFC3986 URI profile which disallows relative URIs, allows 16-bit percent encoding, allow invalid percent encoding and allows most 8-bit characters.

Constructor Detail

UriProfile

public UriProfile()

Construct an UriProfile initialized with RFC3986 rules.

UriProfile

public UriProfile(UriProfile uriProfile)

Construct an UriProfile initialized from another profile.

Parameters:

uriProfile - URI profile to base a new profile on

Method Detail

charTypeAddAndOr

public void charTypeAddAndOr(java.lang.String chars,
                             int bw_and,
                             int bw_or)

Helper method to populate the profiles integer array with character categories.

Parameters:

chars - characters to categorize or null

bw_and - character categories to include in new category

bw_or - new category/categories

indexOf

public int indexOf(int bw_and,
                   java.lang.String str,
                   int pos)
            throws java.net.URISyntaxException

Given a collection of characters find the index of the first occurrence of any of the characters in the supplied string starting from a certain position.

Parameters:

bw_and - bits identifying one or more character categories

str - string to search through

pos - position to start searching from

Returns:

index of the first character in the string present in the character collection(s)

Throws:

java.net.URISyntaxException - if a character with a value larger that 255 is encountered

validate_first_follow

public void validate_first_follow(java.lang.String str,
                                  int bw_and_first,
                                  int bw_and_follow)
                           throws java.net.URISyntaxException

Validate an URI component using two character categories. One category for the first character and another for the following characters.

Parameters:

str - URI component string

bw_and_first - bits identifying first character categories

bw_and_follow - bits identifying following character categories

Throws:

java.net.URISyntaxException - if an error occurs parsing component

validate_decode

public java.lang.String validate_decode(int bw_and,
                                        java.lang.String componentName,
                                        java.lang.String str)
                                 throws java.net.URISyntaxException

Validates an URI component according to the supplied character category bitfield.

Parameters:

bw_and - bits identifying one or more character categories

componentName - URI component name

str - URI component string

Returns:

decoded and validated string

Throws:

java.net.URISyntaxException - if an error occurs parsing/validating component

charTypeAddAndOr

public static void charTypeAddAndOr(int[] charTypeMap,
                                    java.lang.String chars,
                                    int bw_and,
                                    int bw_or)

Helper method to populate an integer array with character categories.

Parameters:

charTypeMap - integer array with character categories

chars - characters to categorize or null

bw_and - character categories to include in new category

bw_or - new category/categories