Class 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 Detail

      • AbstractJaxRsPageProvider

        protected AbstractJaxRsPageProvider​(ca.uhn.fhir.context.FhirContext ctx)
        Provides the ability to set the FhirContext instance.
        Parameters:
        ctx - the FhirContext instance.
    • Method Detail

      • getPages

        @GET
        public javax.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>