org.waarp.gateway.kernel

Class AbstractHttpBusinessRequest

java.lang.Object

org.waarp.gateway.kernel.AbstractHttpBusinessRequest

public abstract class AbstractHttpBusinessRequest
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedHashMap<String,AbstractHttpField>	fields
protected HttpPage	page

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpBusinessRequest(LinkedHashMap<String,AbstractHttpField> fields, HttpPage page) Default constructor

Method Summary

Modifier and Type	Method and Description
void	cleanRequest() Used at the end of the request to release the resources
abstract String	getBeginForm()
abstract String	getContentType()
abstract String	getEndForm()
abstract String	getFieldForm(AbstractHttpField field)
abstract String	getFooter()
abstract String	getHeader()
abstract AbstractHttpField	getMainFileUpload() Utility mainly used for PUT where the content is coming out of the decoder
Map<String,AbstractHttpField>	getMapHttpFields()
abstract String	getNextFieldInForm()
abstract boolean	isFieldValid(AbstractHttpField field) Called if fieldtovalidate is true
abstract boolean	isForm()
abstract boolean	isRequestValid() Note that mandatory fields is tested outside of the AbstractHttpBusinessRequest

Methods inherited from class java.lang.Object

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

Field Detail

fields

protected final LinkedHashMap<String,AbstractHttpField> fields

page

protected final HttpPage page

Constructor Detail

AbstractHttpBusinessRequest

protected AbstractHttpBusinessRequest(LinkedHashMap<String,AbstractHttpField> fields,
                                      HttpPage page)

Default constructor

Parameters:

fields -

page -

Method Detail

getMapHttpFields

public Map<String,AbstractHttpField> getMapHttpFields()

Returns:

the Map associated with the current request

getHeader

public abstract String getHeader()

Returns:

the HTML header or null if set through definition

getFooter

public abstract String getFooter()

Returns:

the HTML Footer or null if set through definition

isForm

public abstract boolean isForm()

Returns:

True if the HTML output will be a Form

getBeginForm

public abstract String getBeginForm()

Returns:

the HTML Begin of Form (including URI) or null if set through definition

getEndForm

public abstract String getEndForm()

Returns:

the HTML End of Form or null if set through definition

getFieldForm

public abstract String getFieldForm(AbstractHttpField field)

Parameters:

field -

Returns:

the HTML field form or null if set standard

getNextFieldInForm

public abstract String getNextFieldInForm()

Returns:

the HTML Next Field in Form or null if set through definition

isFieldValid

public abstract boolean isFieldValid(AbstractHttpField field)

Called if fieldtovalidate is true

Parameters:

field -

Returns:

True if the field is valid

isRequestValid

public abstract boolean isRequestValid()

Note that mandatory fields is tested outside of the AbstractHttpBusinessRequest

Returns:

True if according to known informations this request is valid

getContentType

public abstract String getContentType()

Returns:

the string that contains the ContentType in HTML format (as "text/html")

getMainFileUpload

public abstract AbstractHttpField getMainFileUpload()

Utility mainly used for PUT where the content is coming out of the decoder

Returns:

the main FileUpload as AbstractHttpField for the current request

cleanRequest

public void cleanRequest()

Used at the end of the request to release the resources