org.owasp.esapi.codecs

Class WindowsCodec

java.lang.Object

org.owasp.esapi.codecs.Codec

org.owasp.esapi.codecs.WindowsCodec

public class WindowsCodec
extends Codec

Implementation of the Codec interface for '^' encoding from Windows command shell.

Since:

June 1, 2007

See Also:

Encoder

Constructor Summary

Constructors

Constructor and Description
WindowsCodec()

Method Summary

Modifier and Type	Method and Description
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) Default implementation that should be overridden in specific codecs.

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

Constructor Detail

WindowsCodec

public WindowsCodec()

Method Detail

encodeCharacter

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

Default implementation that should be overridden in specific codecs. Returns Windows shell encoded character (which is ^)

Overrides:

encodeCharacter in class Codec

Parameters:

immune -

c - the Character to encode

Returns:

the encoded Character

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. Returns the decoded version of the character starting at index, or null if no decoding is possible.

Formats all are legal both upper/lower case: ^x - all special characters

Overrides:

decodeCharacter in class Codec

Parameters:

input - the Character to decode

Returns:

the decoded Character