org.owasp.esapi.codecs

Class PercentCodec

java.lang.Object

org.owasp.esapi.codecs.Codec

org.owasp.esapi.codecs.PercentCodec

public class PercentCodec
extends Codec

Implementation of the Codec interface for percent encoding (aka URL encoding).

Since:

June 1, 2007

See Also:

Encoder

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ALPHA_NUMERIC_STR
private static boolean	ENCODED_NON_ALPHA_NUMERIC_UNRESERVED
private static java.lang.String	RFC3986_NON_ALPHANUMERIC_UNRESERVED_STR
private static java.lang.String	RFC3986_RESERVED_STR
private static java.util.Set<java.lang.Character>	UNENCODED_SET
private static java.lang.String	UNENCODED_STR

Constructor Summary

Constructors

Constructor and Description
PercentCodec()

Method Summary

Modifier and Type	Method and Description
private static java.lang.StringBuilder	appendTwoUpperHex(java.lang.StringBuilder sb, int b) Append the two upper case hex characters for a byte.
java.lang.Character	decodeCharacter(PushbackString input) Returns the decoded version of the next character from the input string and advances the current character in the PushbackString.
java.lang.String	encodeCharacter(char[] immune, java.lang.Character c) Encode a character for URLs
private static byte[]	toUtf8Bytes(java.lang.String str) Convinence method to encode a string into UTF-8.

Methods inherited from class org.owasp.esapi.codecs.Codec

containsCharacter, decode, encode, getHexForNonAlphanumeric, toHex, toOctal

Methods inherited from class java.lang.Object

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

Field Detail

ALPHA_NUMERIC_STR

private static final java.lang.String ALPHA_NUMERIC_STR

See Also:

Constant Field Values

RFC3986_RESERVED_STR

private static final java.lang.String RFC3986_RESERVED_STR

See Also:

Constant Field Values

RFC3986_NON_ALPHANUMERIC_UNRESERVED_STR

private static final java.lang.String RFC3986_NON_ALPHANUMERIC_UNRESERVED_STR

See Also:

Constant Field Values

ENCODED_NON_ALPHA_NUMERIC_UNRESERVED

private static final boolean ENCODED_NON_ALPHA_NUMERIC_UNRESERVED

See Also:

Constant Field Values

UNENCODED_STR

private static final java.lang.String UNENCODED_STR

See Also:

Constant Field Values

UNENCODED_SET

private static final java.util.Set<java.lang.Character> UNENCODED_SET

Constructor Detail

PercentCodec

public PercentCodec()

Method Detail

toUtf8Bytes

private static byte[] toUtf8Bytes(java.lang.String str)

Convinence method to encode a string into UTF-8. This wraps the UnsupportedEncodingException that String.getBytes(String) throws in a IllegalStateException as UTF-8 support is required by the Java spec and should never throw this exception.

Parameters:

str - the string to encode

Returns:

str encoded in UTF-8 as bytes.

Throws:

java.lang.IllegalStateException - wrapped UnsupportedEncodingException if String.getBytes(String) throws it.

appendTwoUpperHex

private static java.lang.StringBuilder appendTwoUpperHex(java.lang.StringBuilder sb,
                                                         int b)

Append the two upper case hex characters for a byte.

Parameters:

sb - The string buffer to append to.

b - The byte to hexify

Returns:

sb with the hex characters appended.

encodeCharacter

public java.lang.String encodeCharacter(char[] immune,
                                        java.lang.Character c)

Encode a character for URLs

Overrides:

encodeCharacter in class Codec

Parameters:

immune - characters not to encode

c - character to encode

Returns:

the encoded string representing c

decodeCharacter

public java.lang.Character decodeCharacter(PushbackString input)

Returns the decoded version of the next character from the input string and advances the current character in the PushbackString. If the current character is not encoded, this method MUST reset the PushbackString. Formats all are legal both upper/lower case: %hh;

Overrides:

decodeCharacter in class Codec

Parameters:

input - encoded character using percent characters (such as URL encoding)

Returns:

the decoded Character