Package net.officefloor.web.state

Interface HttpRequestState

public interface HttpRequestState

State for the HttpRequest.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
java.io.Serializable	getAttribute(java.lang.String name)	Obtains the Object that is bound to the name.
java.util.Iterator<java.lang.String>	getAttributeNames()	Obtains an Iterator to the names of the bound Object instances.
void	loadValues(ValueLoader valueLoader)	Loads values from the HttpRequest.
void	removeAttribute(java.lang.String name)	Removes the bound Object by the name.
void	setAttribute(java.lang.String name, java.io.Serializable object)	Binds the Object to the name.

Method Detail

loadValues

void loadValues(ValueLoader valueLoader)
         throws HttpException

Loads values from the HttpRequest.

Parameters:

valueLoader - ValueLoader to receive the values.

Throws:

HttpException - if fails to load values.

getAttribute

java.io.Serializable getAttribute(java.lang.String name)

Obtains the Object that is bound to the name.

Parameters:

name - Name.

Returns:

Object bound to the name or null if no Object bound by the name.

getAttributeNames

java.util.Iterator<java.lang.String> getAttributeNames()

Obtains an Iterator to the names of the bound Object instances.

Returns:

Iterator to the names of the bound Object instances.

setAttribute

void setAttribute(java.lang.String name,
                  java.io.Serializable object)

Binds the Object to the name.

Parameters:

name - Name.

object - Object. Must be Serializable as this HttpRequestState may be stored in the HttpSession to maintain its state across a redirect.

removeAttribute

void removeAttribute(java.lang.String name)

Removes the bound Object by the name.

Parameters:

name - Name of bound Object to remove.