ca.uhn.fhir.parser.LenientErrorHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-base Show documentation
Builds the hapi fhir base. Requires Common lang, commons-text, and guava be built first.
There is a newer version: 7.0.2-r12
/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * 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%
 */
package ca.uhn.fhir.parser;

import ca.uhn.fhir.context.FhirContext;
import ca.uhn.fhir.parser.json.BaseJsonLikeValue.ScalarType;
import ca.uhn.fhir.parser.json.BaseJsonLikeValue.ValueType;

import static org.apache.commons.lang3.StringUtils.isBlank;

/**
 * The default error handler, which logs issues but does not abort parsing, with only two exceptions:
 * 
 * The {@link #invalidValue(ca.uhn.fhir.parser.IParserErrorHandler.IParseLocation, String, String)}
 * method will throw a {@link DataFormatException} by default since ignoring this type of error
 * can lead to data loss (since invalid values are silently ignored). See
 * {@link #setErrorOnInvalidValue(boolean)} for information on this.
 * 
 *
 * @see IParser#setParserErrorHandler(IParserErrorHandler)
 * @see FhirContext#setParserErrorHandler(IParserErrorHandler)
 *
 * 
 * The {@link #extensionContainsValueAndNestedExtensions(ca.uhn.fhir.parser.IParserErrorHandler.IParseLocation)}
 * method will throw a {@link DataFormatException} by default since ignoring this type of error will allow malformed
 * resouces to be created and result in errors when attempts to read, update or delete the resource in the future.
 *  See {@link #setErrorOnInvalidExtension(boolean)} for information on this.
 * 
 */
public class LenientErrorHandler extends ParseErrorHandler implements IParserErrorHandler {

	private static final org.slf4j.Logger ourLog = org.slf4j.LoggerFactory.getLogger(LenientErrorHandler.class);
	private static final StrictErrorHandler STRICT_ERROR_HANDLER = new StrictErrorHandler();
	private boolean myErrorOnInvalidValue = true;
	private boolean myErrorOnInvalidExtension = true;
	private boolean myLogErrors;

	/**
	 * Constructor which configures this handler to log all errors
	 */
	public LenientErrorHandler() {
		myLogErrors = true;
	}

	/**
	 * Constructor
	 *
	 * @param theLogErrors
	 *           Should errors be logged?
	 * @since 1.2
	 */
	public LenientErrorHandler(boolean theLogErrors) {
		myLogErrors = theLogErrors;
	}

	@Override
	public void containedResourceWithNoId(IParseLocation theLocation) {
		if (myLogErrors) {
			ourLog.warn("Resource has contained child resource with no ID");
		}
	}

	@Override
	public void incorrectJsonType(
			IParseLocation theLocation,
			String theElementName,
			ValueType theExpected,
			ScalarType theExpectedScalarType,
			ValueType theFound,
			ScalarType theFoundScalarType) {
		if (myLogErrors) {
			if (ourLog.isWarnEnabled()) {
				String message = createIncorrectJsonTypeMessage(
						theElementName, theExpected, theExpectedScalarType, theFound, theFoundScalarType);
				ourLog.warn(message);
			}
		}
	}

	@Override
	public void invalidValue(IParseLocation theLocation, String theValue, String theError) {
		if (isBlank(theValue) || myErrorOnInvalidValue == false) {
			if (myLogErrors) {
				ourLog.warn("{}Invalid attribute value \"{}\": {}", describeLocation(theLocation), theValue, theError);
			}
		} else {
			STRICT_ERROR_HANDLER.invalidValue(theLocation, theValue, theError);
		}
	}

	/**
	 * If set to false (default is true) invalid values will be logged. By
	 * default, invalid attribute values cause this error handler to throw a {@link DataFormatException} (unlike
	 * other methods in this class which default to simply logging errors).
	 * 
	 * Note that empty values (e.g. "") will not lead to an error when this is set to
	 * true, only invalid values (e.g. a gender code of foo)
	 * 
	 *
	 * @see #setErrorOnInvalidValue(boolean)
	 */
	public boolean isErrorOnInvalidValue() {
		return myErrorOnInvalidValue;
	}

	/**
	 * If set to false (default is true) invalid extensions will be logged. By
	 * default, invalid resource extensions cause this error handler to throw a {@link DataFormatException} (unlike
	 * other methods in this class which default to simply logging errors).
	 *
	 * @see #setErrorOnInvalidExtension(boolean)
	 */
	public boolean isErrorOnInvalidExtension() {
		return myErrorOnInvalidExtension;
	}

	@Override
	public void missingRequiredElement(IParseLocation theLocation, String theElementName) {
		if (myLogErrors) {
			ourLog.warn("Resource is missing required element: {}", theElementName);
		}
	}

	/**
	 * If set to false (default is true) invalid values will be logged. By
	 * default, invalid attribute values cause this error handler to throw a {@link DataFormatException} (unlike
	 * other methods in this class which default to simply logging errors).
	 * 
	 * Note that empty values (e.g. "") will not lead to an error when this is set to
	 * true, only invalid values (e.g. a gender code of foo)
	 * 
	 *
	 * @return Returns a reference to this for easy method chaining
	 * @see #isErrorOnInvalidValue()
	 */
	public LenientErrorHandler setErrorOnInvalidValue(boolean theErrorOnInvalidValue) {
		myErrorOnInvalidValue = theErrorOnInvalidValue;
		return this;
	}

	/**
	 * If set to false (default is true) invalid extensions will be logged. By
	 * default, invalid resource extensions cause this error handler to throw a {@link DataFormatException} (unlike
	 * other methods in this class which default to simply logging errors).
	 *
	 * @return Returns a reference to this for easy method chaining
	 * @see #isErrorOnInvalidExtension()
	 */
	public LenientErrorHandler setErrorOnInvalidExtension(boolean theErrorOnInvalidExtension) {
		myErrorOnInvalidExtension = theErrorOnInvalidExtension;
		return this;
	}

	/**
	 * If this method is called, both invalid resource extensions and invalid attribute values will set to simply logging errors.
	 */
	public LenientErrorHandler disableAllErrors() {
		myErrorOnInvalidValue = false;
		myErrorOnInvalidExtension = false;
		return this;
	}

	@Override
	public void unexpectedRepeatingElement(IParseLocation theLocation, String theElementName) {
		if (myLogErrors) {
			ourLog.warn(
					"{}Multiple repetitions of non-repeatable element '{}' found while parsing",
					describeLocation(theLocation),
					theElementName);
		}
	}

	@Override
	public void unknownAttribute(IParseLocation theLocation, String theElementName) {
		if (myLogErrors) {
			ourLog.warn("{}Unknown attribute '{}' found while parsing", describeLocation(theLocation), theElementName);
		}
	}

	@Override
	public void unknownElement(IParseLocation theLocation, String theElementName) {
		if (myLogErrors) {
			ourLog.warn("{}Unknown element '{}' found while parsing", describeLocation(theLocation), theElementName);
		}
	}

	@Override
	public void unknownReference(IParseLocation theLocation, String theReference) {
		if (myLogErrors) {
			ourLog.warn("{}Resource has invalid reference: {}", describeLocation(theLocation), theReference);
		}
	}

	@Override
	public void extensionContainsValueAndNestedExtensions(IParseLocation theLocation) {
		if (myErrorOnInvalidExtension) {
			STRICT_ERROR_HANDLER.extensionContainsValueAndNestedExtensions(theLocation);
		} else if (myLogErrors) {
			ourLog.warn("{}Extension contains both a value and nested extensions", describeLocation(theLocation));
		}
	}

	public static String createIncorrectJsonTypeMessage(
			String theElementName,
			ValueType theExpected,
			ScalarType theExpectedScalarType,
			ValueType theFound,
			ScalarType theFoundScalarType) {
		StringBuilder b = new StringBuilder();
		b.append("Found incorrect type for element ");
		b.append(theElementName);
		b.append(" - Expected ");
		b.append(theExpected.name());
		if (theExpectedScalarType != null) {
			b.append(" (");
			b.append(theExpectedScalarType.name());
			b.append(")");
		}
		b.append(" and found ");
		b.append(theFound.name());
		if (theFoundScalarType != null) {
			b.append(" (");
			b.append(theFoundScalarType.name());
			b.append(")");
		}
		String message = b.toString();
		return message;
	}
}