Package io.quarkus.rest.data.panache.deployment.methods

Class ListMethodImplementor

java.lang.Object

io.quarkus.rest.data.panache.deployment.methods.StandardMethodImplementor

io.quarkus.rest.data.panache.deployment.methods.ListMethodImplementor

All Implemented Interfaces:

MethodImplementor

public final class ListMethodImplementor
extends StandardMethodImplementor

Field Summary

Fields inherited from interface io.quarkus.rest.data.panache.deployment.methods.MethodImplementor

APPLICATION_HAL_JSON, APPLICATION_JSON

Constructor Summary

Constructors

Constructor	Description
ListMethodImplementor(boolean isResteasyClassic)

Method Summary

Modifier and Type	Method	Description
protected String	getResourceMethodName()	Get a name of a method which this controller uses to access data.
protected void	implementInternal(io.quarkus.gizmo.ClassCreator classCreator, ResourceMetadata resourceMetadata, ResourceProperties resourceProperties, io.quarkus.gizmo.FieldDescriptor resourceField)	Generate JAX-RS GET method that exposes RestDataResource.list(Page, Sort).

Methods inherited from class io.quarkus.rest.data.panache.deployment.methods.StandardMethodImplementor

addConsumesAnnotation, addContextAnnotation, addDefaultValueAnnotation, addDeleteAnnotation, addGetAnnotation, addLinksAnnotation, addPathAnnotation, addPathParamAnnotation, addPostAnnotation, addProducesAnnotation, addPutAnnotation, addQueryParamAnnotation, addSortQueryParamValidatorAnnotation, appendToPath, implement, implementTryBlock

Methods inherited from class java.lang.Object

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

Constructor Detail

ListMethodImplementor

public ListMethodImplementor(boolean isResteasyClassic)

Method Detail

implementInternal

protected void implementInternal(io.quarkus.gizmo.ClassCreator classCreator,
                                 ResourceMetadata resourceMetadata,
                                 ResourceProperties resourceProperties,
                                 io.quarkus.gizmo.FieldDescriptor resourceField)

Generate JAX-RS GET method that exposes RestDataResource.list(Page, Sort). Generated pseudo-code with enabled pagination is shown below. If pagination is disabled pageIndex and pageSize query parameters are skipped and null Page instance is used.

 
     @GET
     @Path("")
     @Produces({"application/json"})
     @LinkResource(
         rel = "list",
         entityClassName = "com.example.Entity"
     )
     public Response list(@QueryParam("page") @DefaultValue("0") int pageIndex,
             @QueryParam("size") @DefaultValue("20") int pageSize,
             @QueryParam("sort") String sortQuery) {
         Page page = Page.of(pageIndex, pageSize);
         Sort sort = ...; // Build a sort instance by parsing a query param
         try {
             List<Entity> entities = resource.getAll(page, sort);
             // Get the page count, and build first, last, next, previous page instances
             Response.ResponseBuilder responseBuilder = Response.status(200);
             responseBuilder.entity(entities);
             // Add headers with first, last, next and previous page URIs if they exist
             return responseBuilder.build();
         } catch (Throwable t) {
             throw new RestDataPanacheException(t);
         }
     }
 
 

Specified by:

implementInternal in class StandardMethodImplementor

getResourceMethodName

protected String getResourceMethodName()

Description copied from class: StandardMethodImplementor

Get a name of a method which this controller uses to access data.

Specified by:

getResourceMethodName in class StandardMethodImplementor