core.tut.pori.http.parameters

Class InputStreamParameter

java.lang.Object

core.tut.pori.http.parameters.HTTPParameter

core.tut.pori.http.parameters.InputStreamParameter

public class InputStreamParameter
extends HTTPParameter

Input stream parameter for reading data as a stream. This only supports data received as an InputStream (e.g. http body)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAMETER_DEFAULT_NAME Default parameter name to use for a body parameter.

Constructor Summary

Constructors

Constructor and Description
InputStreamParameter()

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getValue() Note: if this class is used with default \@HttpServiceMethod annotation designated as a body parameter, you do not need to close the stream manually, it will be automatically closed when the connection disconnects.
boolean	hasValues()
void	initialize(java.io.InputStream stream) Initialize this parameter based on input stream Override this method if you want to accept HTTP Body data.
void	initialize(java.util.List<java.lang.String> parameterValues) Initialize this parameter based on the given parameter values
void	initialize(java.lang.String parameterValue) Initialize this parameter based on the given parameter value

Methods inherited from class core.tut.pori.http.parameters.HTTPParameter

getParameterName, initializeRaw, initializeRaw, setParameterName

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_DEFAULT_NAME

public static final java.lang.String PARAMETER_DEFAULT_NAME

Default parameter name to use for a body parameter. If the parameter is defined as being a body parameter, the name has no effect.

See Also:

Constant Field Values

Constructor Detail

InputStreamParameter

public InputStreamParameter()

Method Detail

initialize

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

Description copied from class: HTTPParameter

Initialize this parameter based on the given parameter values

Specified by:

initialize in class HTTPParameter

Parameters:

parameterValues - can NOT be null

Throws:

java.lang.UnsupportedOperationException

initialize

public void initialize(java.lang.String parameterValue)
                throws java.lang.UnsupportedOperationException

Description copied from class: HTTPParameter

Initialize this parameter based on the given parameter value

Specified by:

initialize in class HTTPParameter

Parameters:

parameterValue - can be null

Throws:

java.lang.UnsupportedOperationException

hasValues

public boolean hasValues()

Specified by:

hasValues in class HTTPParameter

Returns:

true if this parameter has one or more values

initialize

public void initialize(java.io.InputStream stream)

Description copied from class: HTTPParameter

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.

Overrides:

initialize in class HTTPParameter

Parameters:

stream - can be null

getValue

public java.io.InputStream getValue()

Note: if this class is used with default \@HttpServiceMethod annotation designated as a body parameter, you do not need to close the stream manually, it will be automatically closed when the connection disconnects.

Specified by:

getValue in class HTTPParameter

Returns:

the input stream