Module eclipselink

Package org.eclipse.persistence.jpa.rs.features.core.selflinks

Class SelfLinksResponseBuilder

java.lang.Object

org.eclipse.persistence.jpa.rs.features.FeatureResponseBuilderImpl

org.eclipse.persistence.jpa.rs.features.core.selflinks.SelfLinksResponseBuilder

All Implemented Interfaces:

FeatureResponseBuilder

public class SelfLinksResponseBuilder
extends FeatureResponseBuilderImpl

FeatureResponseBuilder implementation generating 'self' and 'canonical' links. Used in JPARS 2.0.

Author:

gonural, Dmitry Kornilov

Since:

EclipseList 2.6.0

Constructor Summary

Constructors

Constructor	Description
SelfLinksResponseBuilder()

Method Summary

Modifier and Type	Method	Description
Object	buildAttributeResponse(PersistenceContext context, Map<String,Object> queryParams, String attribute, Object item, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the attribute response.
Object	buildReadAllQueryResponse(PersistenceContext context, Map<String,Object> queryParams, List<Object> items, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the read all query response.
Object	buildReportQueryResponse(PersistenceContext context, Map<String,Object> queryParams, List<Object[]> results, List<org.eclipse.persistence.internal.queries.ReportItem> items, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the report query response.
Object	buildSingleEntityResponse(PersistenceContext context, Map<String,Object> queryParams, Object result, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the single entity response.
Object	buildSingleResultQueryResponse(PersistenceContext context, Map<String,Object> queryParams, Object result, List<org.eclipse.persistence.internal.queries.ReportItem> items, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the single result query response.

Methods inherited from class org.eclipse.persistence.jpa.rs.features.FeatureResponseBuilderImpl

createShellJAXBElementList

Methods inherited from class java.lang.Object

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

Constructor Detail

SelfLinksResponseBuilder

public SelfLinksResponseBuilder()

Method Detail

buildReadAllQueryResponse

public Object buildReadAllQueryResponse(PersistenceContext context,
                                        Map<String,Object> queryParams,
                                        List<Object> items,
                                        jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FeatureResponseBuilder

Builds the read all query response.

Specified by:

buildReadAllQueryResponse in interface FeatureResponseBuilder

Overrides:

buildReadAllQueryResponse in class FeatureResponseBuilderImpl

Parameters:

context - the context

queryParams - the query params

items - the items

uriInfo - the uri info

Returns:

the object

buildReportQueryResponse

public Object buildReportQueryResponse(PersistenceContext context,
                                       Map<String,Object> queryParams,
                                       List<Object[]> results,
                                       List<org.eclipse.persistence.internal.queries.ReportItem> items,
                                       jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FeatureResponseBuilder

Builds the report query response.

Specified by:

buildReportQueryResponse in interface FeatureResponseBuilder

Overrides:

buildReportQueryResponse in class FeatureResponseBuilderImpl

Parameters:

context - the context

queryParams - the query params

results - the results

items - the items

uriInfo - the uri info

Returns:

the object

buildSingleResultQueryResponse

public Object buildSingleResultQueryResponse(PersistenceContext context,
                                             Map<String,Object> queryParams,
                                             Object result,
                                             List<org.eclipse.persistence.internal.queries.ReportItem> items,
                                             jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FeatureResponseBuilder

Builds the single result query response.

Specified by:

buildSingleResultQueryResponse in interface FeatureResponseBuilder

Overrides:

buildSingleResultQueryResponse in class FeatureResponseBuilderImpl

Parameters:

context - the context

queryParams - the query params

result - the result

items - the report items (result of ReportQuery)

uriInfo - the uri info

Returns:

the response

buildAttributeResponse

public Object buildAttributeResponse(PersistenceContext context,
                                     Map<String,Object> queryParams,
                                     String attribute,
                                     Object item,
                                     jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FeatureResponseBuilder

Builds the attribute response.

Specified by:

buildAttributeResponse in interface FeatureResponseBuilder

Overrides:

buildAttributeResponse in class FeatureResponseBuilderImpl

Parameters:

context - the context

queryParams - the query params

attribute - the attribute

item - the results

uriInfo - the uri info

Returns:

the object

buildSingleEntityResponse

public Object buildSingleEntityResponse(PersistenceContext context,
                                        Map<String,Object> queryParams,
                                        Object result,
                                        jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FeatureResponseBuilder

Builds the single entity response.

Specified by:

buildSingleEntityResponse in interface FeatureResponseBuilder

Overrides:

buildSingleEntityResponse in class FeatureResponseBuilderImpl

Parameters:

context - the context

queryParams - the query params

result - the result

uriInfo - the uri info

Returns:

the object