Package org.apache.juneau.rest.server.arg

Class RequestBeanArg

java.lang.Object

org.apache.juneau.rest.server.arg.RequestBeanArg

All Implemented Interfaces:

RestOpArg

public class RequestBeanArg
extends Object
implements RestOpArg

Resolves method parameters annotated with Request on RestOp-annotated Java methods.

The parameter value is resolved using:

opSession .getRequest() .getRequest(meta, setters);

meta is derived from the Request annotation and context configuration.

See Also:

• Request Beans

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestBeanArg(ParameterInfo paramInfo, AnnotationWorkList annotations)	Constructor.

Method Summary

Modifier and Type	Method	Description
static RequestBeanArg	create(ParameterInfo paramInfo, AnnotationWorkList annotations)	Static creator.
Object	resolve(RestOpSession opSession)	Resolves the parameter object.

Methods inherited from class java.lang.Object

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

Constructor Details

RequestBeanArg

protected RequestBeanArg(ParameterInfo paramInfo,
 AnnotationWorkList annotations)

Constructor.

Parameters:

paramInfo - The Java method parameter being resolved. Must not be null.

annotations - The annotations to apply to any new part parsers.

Throws:

IllegalArgumentException - If the bean is a concrete class with no public no-arg constructor, or with an annotated getter that has no matching setter (see RequestBeanSetters.resolve(java.lang.Class<?>, org.apache.juneau.httppart.bean.RequestBeanMeta)).

Method Details

create

public static RequestBeanArg create(ParameterInfo paramInfo,
 AnnotationWorkList annotations)

Static creator.

Parameters:

paramInfo - The Java method parameter being resolved. Must not be null.

annotations - The annotations to apply to any new part parsers.

Returns:

A new RequestBeanArg, or null if the parameter is not annotated with Request.

resolve

public Object resolve(RestOpSession opSession)
               throws Exception

Description copied from interface: RestOpArg

Resolves the parameter object.

Specified by:

resolve in interface RestOpArg

Parameters:

opSession - The rest call.

Returns:

The resolved object.

Throws:

Exception - Generic error occurred.