ca.uhn.fhir.util.OperationOutcomeUtil.java Source code

Introduction

Here is the source code for ca.uhn.fhir.util.OperationOutcomeUtil.java

Source

package ca.uhn.fhir.util;

/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * Copyright (C) 2014 - 2016 University Health Network
 * %%
 * 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.
 * #L%
 */
import static org.apache.commons.lang3.StringUtils.isNotBlank;

import java.util.List;

import org.hl7.fhir.instance.model.api.IBase;
import org.hl7.fhir.instance.model.api.IBaseOperationOutcome;
import org.hl7.fhir.instance.model.api.IBaseResource;
import org.hl7.fhir.instance.model.api.IPrimitiveType;

import ca.uhn.fhir.context.BaseRuntimeChildDefinition;
import ca.uhn.fhir.context.BaseRuntimeElementCompositeDefinition;
import ca.uhn.fhir.context.BaseRuntimeElementDefinition;
import ca.uhn.fhir.context.FhirContext;
import ca.uhn.fhir.context.FhirVersionEnum;
import ca.uhn.fhir.context.RuntimeResourceDefinition;
import ca.uhn.fhir.rest.server.exceptions.InternalErrorException;

/**
 * Utilities for dealing with OperationOutcome resources across various model versions
 */
public class OperationOutcomeUtil {

    //   /**
    //    * Add an issue to an OperationOutcome
    //    * 
    //    * @param theCtx
    //    *           The fhir context
    //    * @param theOperationOutcome
    //    *           The OO resource to add to
    //    * @param theSeverity
    //    *           The severity (e.g. "error")
    //    * @param theDetails
    //    *           The details string
    //    * @param theCode 
    //    */
    //   public static void addIssue(FhirContext theCtx, IBaseOperationOutcome theOperationOutcome, String theSeverity, String theDetails, String theCode) {
    //      IBase issue = createIssue(theCtx, theOperationOutcome);
    //      populateDetails(theCtx, issue, theSeverity, theDetails, null, theCode);
    //   }

    /**
     * Add an issue to an OperationOutcome
     * 
     * @param theCtx
     *           The fhir context
     * @param theOperationOutcome
     *           The OO resource to add to
     * @param theSeverity
     *           The severity (e.g. "error")
     * @param theDetails
     *           The details string
     * @param theCode 
     */
    public static void addIssue(FhirContext theCtx, IBaseOperationOutcome theOperationOutcome, String theSeverity,
            String theDetails, String theLocation, String theCode) {
        IBase issue = createIssue(theCtx, theOperationOutcome);
        populateDetails(theCtx, issue, theSeverity, theDetails, theLocation, theCode);
    }

    private static IBase createIssue(FhirContext theCtx, IBaseResource theOutcome) {
        RuntimeResourceDefinition ooDef = theCtx.getResourceDefinition(theOutcome);
        BaseRuntimeChildDefinition issueChild = ooDef.getChildByName("issue");
        BaseRuntimeElementCompositeDefinition<?> issueElement = (BaseRuntimeElementCompositeDefinition<?>) issueChild
                .getChildByName("issue");

        IBase issue = issueElement.newInstance();
        issueChild.getMutator().addValue(theOutcome, issue);
        return issue;
    }

    public static String getFirstIssueDetails(FhirContext theCtx, IBaseOperationOutcome theOutcome) {
        if (theCtx.getVersion().getVersion().isNewerThan(FhirVersionEnum.DSTU1)) {
            return getFirstIssueStringPart(theCtx, theOutcome, "diagnostics");
        } else {
            return getFirstIssueStringPart(theCtx, theOutcome, "details");
        }
    }

    public static String getFirstIssueLocation(FhirContext theCtx, IBaseOperationOutcome theOutcome) {
        return getFirstIssueStringPart(theCtx, theOutcome, "location");
    }

    private static String getFirstIssueStringPart(FhirContext theCtx, IBaseOperationOutcome theOutcome,
            String name) {
        if (theOutcome == null) {
            return null;
        }

        RuntimeResourceDefinition ooDef = theCtx.getResourceDefinition(theOutcome);
        BaseRuntimeChildDefinition issueChild = ooDef.getChildByName("issue");

        List<IBase> issues = issueChild.getAccessor().getValues(theOutcome);
        if (issues.isEmpty()) {
            return null;
        }

        IBase issue = issues.get(0);
        BaseRuntimeElementCompositeDefinition<?> issueElement = (BaseRuntimeElementCompositeDefinition<?>) theCtx
                .getElementDefinition(issue.getClass());
        BaseRuntimeChildDefinition detailsChild = issueElement.getChildByName(name);

        List<IBase> details = detailsChild.getAccessor().getValues(issue);
        if (details.isEmpty()) {
            return null;
        }
        return ((IPrimitiveType<?>) details.get(0)).getValueAsString();
    }

    /**
     * Returns true if the given OperationOutcome has 1 or more Operation.issue repetitions
     */
    public static boolean hasIssues(FhirContext theCtx, IBaseOperationOutcome theOutcome) {
        if (theOutcome == null) {
            return false;
        }
        RuntimeResourceDefinition ooDef = theCtx.getResourceDefinition(theOutcome);
        BaseRuntimeChildDefinition issueChild = ooDef.getChildByName("issue");
        return issueChild.getAccessor().getValues(theOutcome).size() > 0;
    }

    public static IBaseOperationOutcome newInstance(FhirContext theCtx) {
        RuntimeResourceDefinition ooDef = theCtx.getResourceDefinition("OperationOutcome");
        try {
            return (IBaseOperationOutcome) ooDef.getImplementingClass().newInstance();
        } catch (InstantiationException e) {
            throw new InternalErrorException("Unable to instantiate OperationOutcome", e);
        } catch (IllegalAccessException e) {
            throw new InternalErrorException("Unable to instantiate OperationOutcome", e);
        }
    }

    private static void populateDetails(FhirContext theCtx, IBase theIssue, String theSeverity, String theDetails,
            String theLocation, String theCode) {
        BaseRuntimeElementCompositeDefinition<?> issueElement = (BaseRuntimeElementCompositeDefinition<?>) theCtx
                .getElementDefinition(theIssue.getClass());
        BaseRuntimeChildDefinition detailsChild;
        if (theCtx.getVersion().getVersion().isNewerThan(FhirVersionEnum.DSTU1)) {
            detailsChild = issueElement.getChildByName("diagnostics");

            BaseRuntimeChildDefinition codeChild = issueElement.getChildByName("code");
            IPrimitiveType<?> codeElem = (IPrimitiveType<?>) codeChild.getChildByName("code")
                    .newInstance(codeChild.getInstanceConstructorArguments());
            codeElem.setValueAsString(theCode);
            codeChild.getMutator().addValue(theIssue, codeElem);
        } else {
            detailsChild = issueElement.getChildByName("details");
        }

        BaseRuntimeElementDefinition<?> stringDef = detailsChild.getChildByName(detailsChild.getElementName());
        BaseRuntimeChildDefinition severityChild = issueElement.getChildByName("severity");
        BaseRuntimeChildDefinition locationChild = issueElement.getChildByName("location");

        IPrimitiveType<?> severityElem = (IPrimitiveType<?>) severityChild.getChildByName("severity")
                .newInstance(severityChild.getInstanceConstructorArguments());
        severityElem.setValueAsString(theSeverity);
        severityChild.getMutator().addValue(theIssue, severityElem);

        IPrimitiveType<?> string = (IPrimitiveType<?>) stringDef.newInstance();
        string.setValueAsString(theDetails);
        detailsChild.getMutator().setValue(theIssue, string);

        if (isNotBlank(theLocation)) {
            IPrimitiveType<?> locationElem = (IPrimitiveType<?>) locationChild.getChildByName("location")
                    .newInstance(locationChild.getInstanceConstructorArguments());
            locationElem.setValueAsString(theLocation);
            locationChild.getMutator().addValue(theIssue, locationElem);
        }
    }

}