org.odpi.openmetadata.engineservices.assetanalysis.server.AssetAnalysisInstance Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of asset-analysis-server Show documentation

Server side implementation of the asset analysis engine services (heart of the automated metadata discovery services).

There is a newer version: 4.3

Show newest version

/* SPDX-License-Identifier: Apache 2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.engineservices.assetanalysis.server;

import org.odpi.openmetadata.commonservices.multitenant.OMESServiceInstance;
import org.odpi.openmetadata.engineservices.assetanalysis.ffdc.AssetAnalysisErrorCode;
import org.odpi.openmetadata.frameworks.auditlog.AuditLog;
import org.odpi.openmetadata.engineservices.assetanalysis.handlers.DiscoveryEngineHandler;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;

import java.util.Map;

/**
 * AssetAnalysisInstance maintains the instance information needed to execute requests on behalf of
 * a engine host server.
 */
public class AssetAnalysisInstance extends OMESServiceInstance
{
    private Map discoveryEngineInstances;


    /**
     * Constructor where REST Services used.
     *
     * @param serverName name of this server
     * @param serviceName name of this service
     * @param auditLog link to the repository responsible for servicing the REST calls.
     * @param localServerUserId userId to use for local server initiated actions
     * @param maxPageSize max number of results to return on single request.
     * @param accessServiceRootURL URL root for server platform where the access service is running.
     * @param accessServiceServerName name of the server where the access service is running.
     * @param discoveryEngineInstances active discovery engines in this server.
     */
    public AssetAnalysisInstance(String                              serverName,
                                 String                              serviceName,
                                 AuditLog                            auditLog,
                                 String                              localServerUserId,
                                 int                                 maxPageSize,
                                 String                              accessServiceRootURL,
                                 String                              accessServiceServerName,
                                 Map discoveryEngineInstances)
    {
        super(serverName, serviceName, auditLog, localServerUserId, maxPageSize, accessServiceRootURL, accessServiceServerName);

        this.discoveryEngineInstances = discoveryEngineInstances;
    }



    /**
     * Return the discovery engine instance requested on an discovery engine services request.
     *
     * @param discoveryEngineName unique name of the discovery engine
     * @return discovery engine instance.
     * @throws InvalidParameterException the discovery engine name is not recognized
     */
    synchronized DiscoveryEngineHandler getDiscoveryEngine(String   discoveryEngineName) throws InvalidParameterException
    {
        final String  methodName        = "getDiscoveryEngine";
        final String  guidParameterName = "discoveryEngineName";

        DiscoveryEngineHandler instance = discoveryEngineInstances.get(discoveryEngineName);

        if (instance == null)
        {
            throw new InvalidParameterException(AssetAnalysisErrorCode.UNKNOWN_DISCOVERY_ENGINE.getMessageDefinition(serverName,
                                                                                                                     discoveryEngineName),
                                                this.getClass().getName(),
                                                methodName,
                                                guidParameterName);
        }

        return instance;
    }
}