
au.csiro.pathling.extract.ExtractProvider Maven / Gradle / Ivy
/*
* Copyright 2023 Commonwealth Scientific and Industrial Research
* Organisation (CSIRO) ABN 41 687 119 230.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package au.csiro.pathling.extract;
import static au.csiro.pathling.fhir.FhirServer.resourceTypeFromClass;
import static java.util.Objects.requireNonNull;
import au.csiro.pathling.async.AsyncSupported;
import au.csiro.pathling.security.OperationAccess;
import ca.uhn.fhir.rest.annotation.Operation;
import ca.uhn.fhir.rest.annotation.OperationParam;
import ca.uhn.fhir.rest.api.server.RequestDetails;
import ca.uhn.fhir.rest.server.IResourceProvider;
import ca.uhn.fhir.rest.server.servlet.ServletRequestDetails;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.hl7.fhir.instance.model.api.IBaseResource;
import org.hl7.fhir.r4.model.Enumerations.ResourceType;
import org.hl7.fhir.r4.model.IntegerType;
import org.hl7.fhir.r4.model.Parameters;
import org.springframework.context.annotation.Profile;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
/**
* HAPI resource provider that provides an entry point for the "extract" type-level operation.
*
* @author John Grimes
* @see Extract
*/
@Component
@Scope("prototype")
@Profile("server")
public class ExtractProvider implements IResourceProvider {
@Nonnull
private final ExtractExecutor extractExecutor;
@Nonnull
private final Class extends IBaseResource> resourceClass;
@Nonnull
private final ResourceType resourceType;
/**
* @param extractExecutor an instance of {@link ExtractExecutor} to process requests
* @param resourceClass the resource class that this provider will receive requests for
*/
public ExtractProvider(@Nonnull final ExtractExecutor extractExecutor,
@Nonnull final Class extends IBaseResource> resourceClass) {
this.extractExecutor = extractExecutor;
this.resourceClass = resourceClass;
resourceType = resourceTypeFromClass(resourceClass);
}
@Override
public Class extends IBaseResource> getResourceType() {
return resourceClass;
}
/**
* Extended FHIR operation: "extract".
*
* @param column a list of column expressions
* @param filter a list of filter expressions
* @param limit a maximum number of rows to return
* @param requestDetails the {@link ServletRequestDetails} containing HAPI inferred info
* @return {@link Parameters} object representing the result
*/
@Operation(name = "$extract", idempotent = true)
@AsyncSupported
public Parameters extract(
@Nullable @OperationParam(name = "column") final List column,
@Nullable @OperationParam(name = "filter") final List filter,
@Nullable @OperationParam(name = "limit") final IntegerType limit,
@SuppressWarnings("unused") @Nullable final ServletRequestDetails requestDetails) {
return invoke(column, filter, limit, requestDetails);
}
@OperationAccess("extract")
private Parameters invoke(@Nullable final List column,
@Nullable final List filter, @Nullable final IntegerType limit,
@Nullable final RequestDetails requestDetails) {
requireNonNull(requestDetails);
final String requestId = requestDetails.getRequestId();
final String resultId = requestId != null
? requestId
: UUID.randomUUID().toString();
final ExtractRequest query = ExtractRequest.fromUserInput(resourceType,
Optional.ofNullable(column),
Optional.ofNullable(filter), Optional.ofNullable(limit).map(IntegerType::getValue));
final ExtractResponse result = extractExecutor.execute(query,
requestDetails.getFhirServerBase(), resultId);
return result.toParameters();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy