core.tut.pori.http.annotations

Annotation Type HTTPMethodParameter

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
 @Inherited
 @Documented
public @interface HTTPMethodParameter

Annotation for defining a single parameter within a HTTPServiceMethod.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	bodyParameter If set to true, the value of body shall be passed on to this parameter, and the default URL parameter lookup will be skipped, in this case the name() of the parameter is ignored.
java.lang.String	defaultValue The parameter value should be defined as it would appear in a method request with values separated by , and URL encoded if needed.
boolean	required

Element Detail

name

public abstract java.lang.String name

Returns:

name of the parameter

defaultValue

public abstract java.lang.String defaultValue

The parameter value should be defined as it would appear in a method request with values separated by , and URL encoded if needed.

Returns:

default value for this parameter

Default:

""

required

public abstract boolean required

Returns:

whether this parameter is required or not

Default:

true

bodyParameter

public abstract boolean bodyParameter

If set to true, the value of body shall be passed on to this parameter, and the default URL parameter lookup will be skipped, in this case the name() of the parameter is ignored. Note: there can be ONLY ONE body parameter per method

Returns:

whether this is a body parameter

Default:

false