• Home
• com.ibm.fhir
• fhir-server
• 4.9.2
• source code
• Operation.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.ibm.fhir.server.resources.Operation Maven / Gradle / Ivy

/*
 * (C) Copyright IBM Corp. 2016, 2021
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package com.ibm.fhir.server.resources;

import static com.ibm.fhir.server.util.FHIROperationUtil.checkAndVerifyOperationAllowed;
import static com.ibm.fhir.server.util.IssueTypeToHttpStatusMapper.issueListToStatus;

import java.net.URI;
import java.util.Date;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.annotation.security.RolesAllowed;
import javax.enterprise.context.RequestScoped;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.HttpMethod;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.SecurityContext;

import com.ibm.fhir.core.FHIRMediaType;
import com.ibm.fhir.exception.FHIROperationException;
import com.ibm.fhir.model.resource.OperationOutcome.Issue;
import com.ibm.fhir.model.resource.Resource;
import com.ibm.fhir.model.util.FHIRUtil;
import com.ibm.fhir.server.operation.spi.FHIROperationContext;
import com.ibm.fhir.server.util.FHIRRestHelper;
import com.ibm.fhir.server.util.RestAuditLogger;

@Path("/")
@Consumes({ FHIRMediaType.APPLICATION_FHIR_JSON, MediaType.APPLICATION_JSON,
        FHIRMediaType.APPLICATION_FHIR_XML, MediaType.APPLICATION_XML })
@Produces({ FHIRMediaType.APPLICATION_FHIR_JSON, MediaType.APPLICATION_JSON,
        FHIRMediaType.APPLICATION_FHIR_XML, MediaType.APPLICATION_XML })
@RolesAllowed({"FHIRUsers", "FHIROperationAdmin"})
@RequestScoped
public class Operation extends FHIRResource {
    private static final Logger log = java.util.logging.Logger.getLogger(Operation.class.getName());

    public Operation() throws Exception {
        super();
    }

    @Context
    protected HttpHeaders httpHeaders;

    @Context
    protected SecurityContext securityContext;

    @GET
    @Path("${operationName}")
    public Response invoke(@PathParam("operationName") String operationName) {
        log.entering(this.getClass().getName(), "invoke(String)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext =
                    FHIROperationContext.createSystemOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, HttpMethod.GET);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result = helper.doInvoke(operationContext, null, null, null, operationName,
                    null, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, null, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            status = issueListToStatus(e.getIssues());
            return exceptionResponse(e, status);
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, null, null, null,
                        startTime, new Date(), status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String)");
        }
    }

    @POST
    @Path("${operationName}")
    public Response invoke(@PathParam("operationName") String operationName, Resource resource) {
        log.entering(this.getClass().getName(), "invoke(String,Resource)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext =
                    FHIROperationContext.createSystemOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, "POST");
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result = helper.doInvoke(operationContext, null, null, null, operationName,
                    resource, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, null, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            status = issueListToStatus(e.getIssues());
            return exceptionResponse(e, status);
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, null, null, null,
                        startTime, new Date(), status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String,Resource)");
        }
    }

    @DELETE
    @Path("${operationName}")
    public Response invokeDelete(@PathParam("operationName") String operationName) {
        // Support for calling a HTTP DELETE for a System-Level Operation calls.

        log.entering(this.getClass().getName(), "invokeDelete(String)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext = FHIROperationContext.createSystemOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, "DELETE");
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result =
                    helper.doInvoke(operationContext, null, null, null, operationName, null, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, null, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            status = issueListToStatus(e.getIssues());
            return exceptionResponse(e, status);
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, null, null, null, startTime, new Date(),
                        status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String,Resource)");
        }
    }

    @GET
    @Path("{resourceTypeName}/${operationName}")
    public Response invoke(@PathParam("resourceTypeName") String resourceTypeName,
            @PathParam("operationName") String operationName) {
        log.entering(this.getClass().getName(), "invoke(String,String)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkType(resourceTypeName);
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext =
                    FHIROperationContext.createResourceTypeOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, HttpMethod.GET);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result = helper.doInvoke(operationContext, resourceTypeName, null, null, operationName,
                    null, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, resourceTypeName, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            status = issueListToStatus(e.getIssues());
            return exceptionResponse(e, status);
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, resourceTypeName, null, null,
                        startTime, new Date(), status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String,String)");
        }
    }

    @POST
    @Path("{resourceTypeName}/${operationName}")
    public Response invoke(@PathParam("resourceTypeName") String resourceTypeName,
            @PathParam("operationName") String operationName, Resource resource) {
        log.entering(this.getClass().getName(), "invoke(String,String,Resource)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkType(resourceTypeName);
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext =
                    FHIROperationContext.createResourceTypeOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, HttpMethod.POST);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result = helper.doInvoke(operationContext, resourceTypeName, null, null, operationName,
                    resource, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, resourceTypeName, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            // response 200 OK if no failure issue found.
            boolean isFailure = false;
            for (Issue issue : e.getIssues()) {
                if (FHIRUtil.isFailure(issue.getSeverity())) {
                    isFailure = true;
                    break;
                }
            }
            if (isFailure) {
                status = issueListToStatus(e.getIssues());
                return exceptionResponse(e, status);
            } else {
                status = Status.OK;
                return exceptionResponse(e, Response.Status.OK);
            }
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, resourceTypeName, null, null,
                        startTime, new Date(), status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String,String,Resource)");
        }
    }

    @GET
    @Path("{resourceTypeName}/{logicalId}/${operationName}")
    public Response invoke(@PathParam("resourceTypeName") String resourceTypeName,
            @PathParam("logicalId") String logicalId,
            @PathParam("operationName") String operationName) {
        log.entering(this.getClass().getName(), "invoke(String,String,String)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkType(resourceTypeName);
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext =
                    FHIROperationContext.createInstanceOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, HttpMethod.GET);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result = helper.doInvoke(operationContext, resourceTypeName, logicalId, null, operationName,
                    null, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, resourceTypeName, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            status = issueListToStatus(e.getIssues());
            return exceptionResponse(e, status);
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, resourceTypeName, logicalId, null,
                        startTime, new Date(), status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String,String,String)");
        }
    }

    @POST
    @Path("{resourceTypeName}/{logicalId}/${operationName}")
    public Response invoke(@PathParam("resourceTypeName") String resourceTypeName,
            @PathParam("logicalId") String logicalId,
            @PathParam("operationName") String operationName, Resource resource) {
        log.entering(this.getClass().getName(), "invoke(String,String,String,Resource)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkType(resourceTypeName);
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext =
                    FHIROperationContext.createInstanceOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, HttpMethod.POST);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result = helper.doInvoke(operationContext, resourceTypeName, logicalId, null, operationName,
                    resource, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, resourceTypeName, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            status = issueListToStatus(e.getIssues());
            return exceptionResponse(e, status);
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, resourceTypeName, logicalId, null,
                        startTime, new Date(), status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String,String,String,Resource)");
        }
    }

    @GET
    @Path("{resourceTypeName}/{logicalId}/_history/{versionId}/${operationName}")
    public Response invoke(@PathParam("resourceTypeName") String resourceTypeName,
            @PathParam("logicalId") String logicalId,
            @PathParam("versionId") String versionId,
            @PathParam("operationName") String operationName) {
        log.entering(this.getClass().getName(), "invoke(String,String,String,String)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkType(resourceTypeName);
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext =
                    FHIROperationContext.createInstanceOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, HttpMethod.GET);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result = helper.doInvoke(operationContext, resourceTypeName, logicalId, versionId, operationName,
                    null, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, resourceTypeName, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            status = issueListToStatus(e.getIssues());
            return exceptionResponse(e, status);
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, resourceTypeName, logicalId, versionId,
                        startTime, new Date(), status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String,String,String,String)");
        }
    }

    @POST
    @Path("{resourceTypeName}/{logicalId}/_history/{versionId}/${operationName}")
    public Response invoke(@PathParam("resourceTypeName") String resourceTypeName,
            @PathParam("logicalId") String logicalId,
            @PathParam("versionId") String versionId,
            @PathParam("operationName") String operationName, Resource resource) {
        log.entering(this.getClass().getName(), "invoke(String,String,String,String,Resource)");
        Date startTime = new Date();
        Response.Status status = null;

        try {
            checkInitComplete();
            checkType(resourceTypeName);
            checkAndVerifyOperationAllowed(operationName);

            FHIROperationContext operationContext =
                    FHIROperationContext.createInstanceOperationContext();
            operationContext.setProperty(FHIROperationContext.PROPNAME_URI_INFO, uriInfo);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_HEADERS, httpHeaders);
            operationContext.setProperty(FHIROperationContext.PROPNAME_SECURITY_CONTEXT, securityContext);
            operationContext.setProperty(FHIROperationContext.PROPNAME_HTTP_REQUEST, httpServletRequest);
            operationContext.setProperty(FHIROperationContext.PROPNAME_METHOD_TYPE, HttpMethod.POST);

            FHIRRestHelper helper = new FHIRRestHelper(getPersistenceImpl());
            Resource result = helper.doInvoke(operationContext, resourceTypeName, logicalId, versionId, operationName,
                    resource, uriInfo.getQueryParameters());
            Response response = buildResponse(operationContext, resourceTypeName, result);
            status = Response.Status.fromStatusCode(response.getStatus());
            return response;
        } catch (FHIROperationException e) {
            status = issueListToStatus(e.getIssues());
            return exceptionResponse(e, status);
        } catch (Exception e) {
            status = Status.INTERNAL_SERVER_ERROR;
            return exceptionResponse(e, status);
        } finally {
            try {
                RestAuditLogger.logOperation(httpServletRequest, operationName, resourceTypeName, logicalId, versionId,
                        startTime, new Date(), status);
            } catch (Exception e) {
                log.log(Level.SEVERE, AUDIT_LOGGING_ERR_MSG, e);
            }

            log.exiting(this.getClass().getName(), "invoke(String,String,String,String,Resource)");
        }
    }

    private Response buildResponse(FHIROperationContext operationContext, String resourceTypeName, Resource resource)
            throws Exception {
        // The following code allows the downstream application to change the response code
        // This enables the 202 accepted to be sent back
        Response.Status status = Response.Status.OK;
        Object o = operationContext.getProperty(FHIROperationContext.PROPNAME_STATUS_TYPE);
        if (o != null) {
            status = (Response.Status) o;
            if (Response.Status.ACCEPTED.equals(status)) {
                // This change is for BulkData operations which manipulate the response code.
                // Operations that return Accepted need to implement their own approach.
                Object ox = operationContext.getProperty(FHIROperationContext.PROPNAME_RESPONSE);
                return (Response) ox;
            }
        }

        URI locationURI =
                (URI) operationContext.getProperty(FHIROperationContext.PROPNAME_LOCATION_URI);
        if (locationURI != null) {
            return Response.status(status)
                    .location(toUri(getAbsoluteUri(getRequestBaseUri(resourceTypeName), locationURI.toString())))
                    .entity(resource)
                    .build();
        }
        return Response.status(status).entity(resource).build();
    }
}