net.officefloor.plugin.web.http.application

Interface HttpRequestState

All Known Implementing Classes:

ServletHttpRequestStateManagedObjectSource.ServletHttpRequestStateManagedObject

public interface HttpRequestState

State for the HttpRequest.

A ClassManagedObjectSource provides similar functionality for each bound object, however only objects registered with this HttpRequestState will be available across redirects.

Also this interface is used within the WebAutoWireApplication to allow integration with a JEE Servlet container.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
Serializable	exportState() Exports a momento for the current state of this HttpRequestState.
Serializable	getAttribute(String name) Obtains the Object that is bound to the name.
Iterator<String>	getAttributeNames() Obtains an Iterator to the names of the bound Object instances.
void	importState(Serializable momento) Imports the state from the momento.
void	removeAttribute(String name) Removes the bound Object by the name.
void	setAttribute(String name, Serializable object) Binds the Object to the name.

Method Detail

getAttribute

Serializable getAttribute(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

Iterator<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(String name,
                  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(String name)

Removes the bound Object by the name.

Parameters:

name - Name of bound Object to remove.

exportState

Serializable exportState()
                  throws IOException

Exports a momento for the current state of this HttpRequestState.

Returns:

Momento for the current state of this HttpRequestState.

Throws:

IOException - If fails to export state.

importState

void importState(Serializable momento)
          throws IOException,
                 IllegalArgumentException

Imports the state from the momento.

Parameters:

momento - Momento containing the state for the HttpRequestState.

Throws:

IOException - If fails to import state.

IllegalArgumentException - If invalid momento.