ml.alternet.security.web.server

Class FormReader

java.lang.Object

ml.alternet.security.web.server.FormReader

public abstract class FormReader
extends Object

Extract the passwords of an HTML form, and replace their characters with '*'.

Author:

Philippe Poulard

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	replace Indicates that the raw data in the input buffer has to be replaced with '*'

Constructor Summary

Constructors

Constructor and Description
FormReader(FormLimit formLimit, PasswordManager pm) Create an HTML form reader, encoded in UTF-8.

Method Summary

Modifier and Type	Method and Description
static int	convertHexDigit(int c) Convert an HEX digit to a byte.
int	get(int size, byte[] buf, int offset, int length) This method is called when the ByteBuffer has to be read for further parsing ; it is used to fill the "buf" byte array.
abstract CaptureContext<?>	getCurrentCaptureContext() Hold the passwords that are extracted ; the capture context also indicates which fields in the form has to be captured, and hold a reference to the incoming data source.
abstract void	log(Exception exception) Log an exception.
abstract int	readItem(byte[] buf, int i) Read the next byte ; if the replace flag is set, the input source AND the buffer have to be set to '*', but the byte read has to kept unchanged.
void	reset() Reset this form reader.

Methods inherited from class java.lang.Object

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

Field Detail

replace

protected boolean replace

Indicates that the raw data in the input buffer has to be replaced with '*'

Constructor Detail

FormReader

public FormReader(FormLimit formLimit,
                  PasswordManager pm)

Create an HTML form reader, encoded in UTF-8.

Parameters:

formLimit - The size limits of the form to read.

pm - Used to create safe passwords.

Method Detail

reset

public void reset()

Reset this form reader.

get

public int get(int size,
               byte[] buf,
               int offset,
               int length)

This method is called when the ByteBuffer has to be read for further parsing ; it is used to fill the "buf" byte array.

Parameters:

size - The max amount of data that can be read.

buf - The target buffer to fill.

offset - The offset index to read.

length - The length to read.

Returns:

The amount of data effectively read.

readItem

public abstract int readItem(byte[] buf,
                             int i)

Read the next byte ; if the replace flag is set, the input source AND the buffer have to be set to '*', but the byte read has to kept unchanged.

Parameters:

buf - The target buffer to fill.

i - The index of the target buffer.

Returns:

The byte read ; do not set it to '*', it's a byte from the password.

getCurrentCaptureContext

public abstract CaptureContext<?> getCurrentCaptureContext()

Hold the passwords that are extracted ; the capture context also indicates which fields in the form has to be captured, and hold a reference to the incoming data source.

Returns:

The current capture context.

log

public abstract void log(Exception exception)

Log an exception.

Parameters:

exception - The exception to log.

convertHexDigit

public static int convertHexDigit(int c)

Convert an HEX digit to a byte.

Parameters:

c - An ASCII encoded character 0-9 a-f A-F

Returns:

The byte value of the character 0-16.