com.ibm.fhir.server.operation.FHIROperationRegistry Maven / Gradle / Ivy

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

package com.ibm.fhir.server.operation;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.ServiceConfigurationError;
import java.util.ServiceLoader;
import java.util.TreeMap;
import java.util.logging.Level;
import java.util.logging.Logger;

import com.ibm.fhir.exception.FHIROperationException;
import com.ibm.fhir.model.resource.OperationDefinition;
import com.ibm.fhir.model.resource.OperationOutcome.Issue;
import com.ibm.fhir.model.type.Boolean;
import com.ibm.fhir.model.type.code.IssueSeverity;
import com.ibm.fhir.model.type.code.IssueType;
import com.ibm.fhir.model.type.code.ResourceType;
import com.ibm.fhir.model.util.FHIRUtil;
import com.ibm.fhir.server.spi.operation.FHIROperation;
import com.ibm.fhir.validation.FHIRValidator;
import com.ibm.fhir.validation.exception.FHIRValidationException;

public class FHIROperationRegistry {
    private final Logger log = Logger.getLogger(FHIROperationRegistry.class.getName());
    private static final FHIROperationRegistry INSTANCE = new FHIROperationRegistry();
    // Key format: operation name[:resource type]
    // Sample keys: validate:Resource, export:Patient, export
    private Map operationMap = null;

    private FHIROperationRegistry() {
        operationMap = new TreeMap();
        ServiceLoader operations = ServiceLoader.load(FHIROperation.class);
        // https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html#iterator--
        Iterator iterator = operations.iterator();
        while (iterator.hasNext()) {
            String operationCode = "unknown code";
            try {
                FHIROperation operation = iterator.next();
                log.fine(() -> "Found FHIROperation implementation class: " + operation.getClass().getName());
                // This is actually the code.
                operationCode = operation.getName();
                if (!isValid(operation)) {
                    log.severe("Operation $" + operationCode + " has failed validation and will be skipped.");
                    continue;
                }

                // Some OperationDefinitions use System, Type and Instance, so we want to set this independently.
                boolean isSet = false;
                if (Boolean.TRUE.equals(operation.getDefinition().getSystem())) {
                    if (operationMap.putIfAbsent(operationCode, operation) != null) {
                        throw new IllegalStateException("Found duplicated operation code: " + operationCode);
                    }
                    isSet = true;
                }

                List operationResourceTypes = operation.getDefinition().getResource();
                if (operationResourceTypes == null || operationResourceTypes.isEmpty()) {
                    if (!isSet && operationMap.putIfAbsent(operationCode, operation) != null) {
                        throw new IllegalStateException("Found duplicated operation code: " + operationCode);
                    }
                } else {
                    // First, check if there is already an operation defined for all resource types.
                    String tmpKey = operationCode + ":" + "Resource";
                    if (operationMap.containsKey(tmpKey)) {
                        throw new IllegalStateException("There is already operation defined for all resource types: "
                            + operation.getName() + "; Conflict Operations: " + operation.getDefinition().getName()
                            + " <--> " + operationMap.get(tmpKey).getDefinition().getName());
                    }
                    // Then check if there is already operation defined for the required resource types.
                    for (ResourceType operationResourceType : operationResourceTypes) {
                        tmpKey = operationCode + ":" + operationResourceType.getValue();
                        if (operationMap.putIfAbsent(tmpKey, operation) != null) {
                            throw new IllegalStateException("Found duplicated operation name plus resource type: "
                                + operation.getName() + "-" + operationResourceType.getValue()
                                + "; Conflict Operations: " + operation.getDefinition().getName()
                                + " <--> " + operationMap.get(tmpKey).getDefinition().getName());
                        }
                    }
                }
            } catch (ServiceConfigurationError | FHIRValidationException e) {
                log.log(Level.SEVERE, "Unable to validate operation $" + operationCode + ". This operation will be skipped.", e);
            }
        }

        if (log.isLoggable(Level.FINE)) {
            log.fine("Discovered " + operationMap.size() + " custom operation implementations:");
            log.fine(operationMap.toString());
        }
    }

    private boolean isValid(FHIROperation operation) throws FHIRValidationException, FHIRValidationException {
        OperationDefinition opDef = operation.getDefinition();
        List issues = FHIRValidator.validator().validate(opDef);
        if (!issues.isEmpty()) {
            for (Issue issue : issues) {
                if (log.isLoggable(Level.FINE)) {
                    log.fine("Issue: " + issue.getCode().getValue() + ":"
                            + issue.getSeverity().getValue() + ":" + issue.getDetails().getText().getValue());
                }
                if (issue.getSeverity().equals(IssueSeverity.ERROR)
                        || issue.getSeverity().equals(IssueSeverity.FATAL)) {
                    return false;
                }
            }
        }
        if (operation.getName() == null || !operation.getName().equals(opDef.getCode().getValue())) {
            log.info("Name mismatch: the operation '" + operation.getName() + "' must match the OperationDefinition code '" +
                    opDef.getCode() + "'");
            return false;
        }
        if (opDef.getUrl() == null) {
            log.info("Operation " + operation.getName() + " is missing a 'url'; this field is required by the IBM FHIR Server");
            return false;
        }
        return true;
    }

    public List getOperationNames() {
        return Collections.unmodifiableList(new ArrayList(operationMap.keySet()));
    }

    public static FHIROperationRegistry getInstance() {
        return INSTANCE;
    }

    public FHIROperation getOperation(String code) throws FHIROperationException {
        FHIROperation operation = operationMap.get(code);
        if (operation == null) {
            // Check if there is an operation defined for all resource types.
            operation = operationMap.get(code.split(":")[0] + ":" + "Resource");
            if (operation == null) {
                String msg = "Operation with code: '" + code + "' was not found";
                throw new FHIROperationException(msg)
                    .withIssue(FHIRUtil.buildOperationOutcomeIssue(IssueSeverity.FATAL, IssueType.NOT_SUPPORTED, msg));
            }
        }
        return operation;
    }
}