Package ca.uhn.fhir.jaxrs.server

Class AbstractJaxRsPageProvider

java.lang.Object

ca.uhn.fhir.jaxrs.server.AbstractJaxRsProvider

ca.uhn.fhir.jaxrs.server.AbstractJaxRsPageProvider

All Implemented Interfaces:

ca.uhn.fhir.rest.api.server.IRestfulServer<JaxRsRequest>, ca.uhn.fhir.rest.server.IRestfulServerDefaults

@Produces({"application/json","application/xml","text/plain"})
public abstract class AbstractJaxRsPageProvider
extends AbstractJaxRsProvider
implements ca.uhn.fhir.rest.api.server.IRestfulServer<JaxRsRequest>

Base class for a provider to provide the [baseUrl]?_getpages=foo request, which is a request to the server to retrieve the next page of a set of paged results.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJaxRsPageProvider()	The default constructor.
protected	AbstractJaxRsPageProvider(ca.uhn.fhir.context.FhirContext ctx)	Provides the ability to set the FhirContext instance.

Method Summary

Modifier and Type	Method	Description
String	getBaseForRequest()	This method returns the server base, including the resource path.
ca.uhn.fhir.context.api.BundleInclusionRule	getBundleInclusionRule()	Default: BundleInclusionRule.BASED_ON_INCLUDES
ca.uhn.fhir.rest.api.PreferReturnEnum	getDefaultPreferReturn()
jakarta.ws.rs.core.Response	getPages(String thePageId)	This method implements the "getpages" action
ca.uhn.fhir.rest.server.IPagingProvider	getPagingProvider()	Default: no paging provider

Methods inherited from class ca.uhn.fhir.jaxrs.server.AbstractJaxRsProvider

getAddProfileTag, getBaseForServer, getDefaultResponseEncoding, getElementsSupport, getETagSupport, getFhirContext, getHeaders, getInterceptors_, getInterceptorService, getParameters, getRequest, getRequest, getServerAddressStrategy, getUriInfo, handleException, isDefaultPrettyPrint, setHeaders, setUriInfo, withStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.rest.api.server.IRestfulServer

canStoreSearchResults

Methods inherited from interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

getAddProfileTag, getDefaultPageSize, getDefaultResponseEncoding, getElementsSupport, getETagSupport, getFhirContext, getInterceptors_, getInterceptorService, getMaximumPageSize, isDefaultPrettyPrint

Constructor Details

AbstractJaxRsPageProvider

protected AbstractJaxRsPageProvider()

The default constructor.

AbstractJaxRsPageProvider

protected AbstractJaxRsPageProvider(ca.uhn.fhir.context.FhirContext ctx)

Provides the ability to set the FhirContext instance.

Parameters:

ctx - the FhirContext instance.

Method Details

getBaseForRequest

public String getBaseForRequest()

Description copied from class: AbstractJaxRsProvider

This method returns the server base, including the resource path. UriInfo#getBaseUri()

Overrides:

getBaseForRequest in class AbstractJaxRsProvider

Returns:

the ascii string for the base resource provider path

getPages

@GET
public jakarta.ws.rs.core.Response getPages(@QueryParam("_getpages")
 String thePageId)
                                     throws IOException

This method implements the "getpages" action

Throws:

IOException

getPagingProvider

public ca.uhn.fhir.rest.server.IPagingProvider getPagingProvider()

Default: no paging provider

Specified by:

getPagingProvider in interface ca.uhn.fhir.rest.api.server.IRestfulServer<JaxRsRequest>

Specified by:

getPagingProvider in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

Overrides:

getPagingProvider in class AbstractJaxRsProvider

getBundleInclusionRule

public ca.uhn.fhir.context.api.BundleInclusionRule getBundleInclusionRule()

Default: BundleInclusionRule.BASED_ON_INCLUDES

Specified by:

getBundleInclusionRule in interface ca.uhn.fhir.rest.api.server.IRestfulServer<JaxRsRequest>

getDefaultPreferReturn

public ca.uhn.fhir.rest.api.PreferReturnEnum getDefaultPreferReturn()

Specified by:

getDefaultPreferReturn in interface ca.uhn.fhir.rest.api.server.IRestfulServer<JaxRsRequest>