core.tut.pori.http.parameters

Class HTTPParameter

java.lang.Object

core.tut.pori.http.parameters.HTTPParameter

Direct Known Subclasses:

BooleanParameter, DataGroups, DoubleParameter, InputStreamParameter, IntegerParameter, Limits, LongParameter, QueryParameter, SortOptions, StringParameter

public abstract class HTTPParameter
extends java.lang.Object

Base class for custom HTTP Parameters. Even though the built-in parameter types should work for most cases, there might rise a need for a case-specific way to parse a given method parameter, this class is for those needs.

Constructor Summary

Constructors

Constructor and Description
HTTPParameter() The inherited class should have no-args default constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameterName()
abstract java.lang.Object	getValue()
abstract boolean	hasValues()
void	initialize(java.io.InputStream parameterValue) Initialize this parameter based on input stream Override this method if you want to accept HTTP Body data.
abstract void	initialize(java.util.List<java.lang.String> parameterValues) Initialize this parameter based on the given parameter values
abstract void	initialize(java.lang.String parameterValue) Initialize this parameter based on the given parameter value
void	initializeRaw(java.util.List<java.lang.String> parameterValues) Initialize the parameter by raw URL encoded string list.
void	initializeRaw(java.lang.String parameterValue) Initialize the parameter by raw URL encoded string.
void	setParameterName(java.lang.String parameterName)

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPParameter

public HTTPParameter()

The inherited class should have no-args default constructor

Method Detail

initializeRaw

public void initializeRaw(java.lang.String parameterValue)
                   throws java.lang.IllegalArgumentException

Initialize the parameter by raw URL encoded string. This can be overridden to intercept the URL encoded parameter, the default implementation decodes the string and calls initialize()

Parameters:

parameterValue -

Throws:

java.lang.IllegalArgumentException

initializeRaw

public void initializeRaw(java.util.List<java.lang.String> parameterValues)
                   throws java.lang.IllegalArgumentException

Initialize the parameter by raw URL encoded string list. This can be overridden to intercept the URL encoded parameter, the default implementation decodes the string and calls initialize()

Parameters:

parameterValues -

Throws:

java.lang.IllegalArgumentException

initialize

public abstract void initialize(java.util.List<java.lang.String> parameterValues)
                         throws java.lang.IllegalArgumentException

Initialize this parameter based on the given parameter values

Parameters:

parameterValues - can NOT be null

Throws:

java.lang.IllegalArgumentException - on bad input data

initialize

public abstract void initialize(java.lang.String parameterValue)
                         throws java.lang.IllegalArgumentException

Initialize this parameter based on the given parameter value

Parameters:

parameterValue - can be null

Throws:

java.lang.IllegalArgumentException - on bad input data

initialize

public void initialize(java.io.InputStream parameterValue)
                throws java.lang.IllegalArgumentException

Initialize this parameter based on input stream Override this method if you want to accept HTTP Body data. The default implementation only throws an exception.

Parameters:

parameterValue - can be null

Throws:

java.lang.IllegalArgumentException - on bad input data

hasValues

public abstract boolean hasValues()

Returns:

true if this parameter has one or more values

getValue

public abstract java.lang.Object getValue()

Returns:

a single value object or null if none available

getParameterName

public java.lang.String getParameterName()

Returns:

the parameterName

setParameterName

public void setParameterName(java.lang.String parameterName)

Parameters:

parameterName - the parameterName to set