/*-
 * ~~~~~~licensing~~~~~~
 * atlasmap-entaxy-services
 * ==========
 * Copyright (C) 2020 - 2024 EmDev LLC
 * ==========
 * You may not use this file except in accordance with the License Terms of the Copyright
 * Holder located at: https://entaxy.ru/eula . All copyrights, all intellectual property
 * rights to the Software and any copies are the property of the Copyright Holder. Unless
 * it is explicitly allowed the Copyright Holder, the User is prohibited from using the
 * Software for commercial purposes to provide services to third parties.
 * 
 * The Copyright Holder hereby declares that the Software is provided on an "AS IS".
 * Under no circumstances does the Copyright Holder guarantee or promise that the
 * Software provided by him will be suitable or not suitable for the specific purposes
 * of the User, that the Software will meet all commercial and personal subjective
 * expectations of the User, that the Software will work properly, without technical
 * errors, quickly and uninterruptedly.
 * 
 * Under no circumstances shall the Copyright Holder or its Affiliates is not liable
 * to the User for any direct or indirect losses of the User, his expenses or actual
 * damage, including, downtime; loss of bussines; lost profit; lost earnings; loss
 * or damage to data, property, etc.
 * ~~~~~~/licensing~~~~~~
 */
/*
 * Copyright (C) 2017 Red Hat, 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.
 */
package io.atlasmap.spi;

import java.util.List;
import java.util.Map;

import io.atlasmap.api.AtlasException;
import io.atlasmap.v2.DataSourceMetadata;
import io.atlasmap.v2.Field;

/**
 * A SPI contract between AtlasMap core and modules. AtlasMap core engine invokes those
 * methods while processing mappings.
 */
public interface AtlasModule {

    void init() throws AtlasException;

    void destroy() throws AtlasException;

    void setClassLoader(ClassLoader classLoader);

    ClassLoader getClassLoader();

    void processPreValidation(AtlasInternalSession session) throws AtlasException;

    void processPreSourceExecution(AtlasInternalSession session) throws AtlasException;

    void processPreTargetExecution(AtlasInternalSession session) throws AtlasException;

    /**
     * Read source field value from source document and store into source field object.
     *
     * @param session current session
     * @throws AtlasException failed to read source value
     */
    void readSourceValue(AtlasInternalSession session) throws AtlasException;

    /**
     * Populate target field value, usually by just copy from source field value.
     * Also apply type converters where it's needed.
     *
     * @param session current session
     * @throws AtlasException failed to populate target field value
     */
    void populateTargetField(AtlasInternalSession session) throws AtlasException;

    /**
     * Write target field value into target document.
     *
     * @param session current session
     * @throws AtlasException faield to write target field value
     */
    void writeTargetValue(AtlasInternalSession session) throws AtlasException;

    void processPostSourceExecution(AtlasInternalSession session) throws AtlasException;

    void processPostTargetExecution(AtlasInternalSession session) throws AtlasException;

    void processPostValidation(AtlasInternalSession session) throws AtlasException;

    AtlasModuleMode getMode();

    void setMode(AtlasModuleMode atlasModuleMode);

    AtlasConversionService getConversionService();

    void setConversionService(AtlasConversionService atlasConversionService);

    AtlasFieldActionService getFieldActionService();

    void setFieldActionService(AtlasFieldActionService atlasFieldActionService);

    AtlasCollectionHelper getCollectionHelper();

    List<AtlasModuleMode> listSupportedModes();

    String getDocId();

    void setDocId(String docId);

    String getDocName();

    void setDocName(String docName);

    String getUri();

    void setUri(String uri);

    String getUriDataType();

    Map<String, String> getUriParameters();

    Boolean isStatisticsSupported();

    Boolean isStatisticsEnabled();

    Boolean isSupportedField(Field field);

    Field cloneField(Field field) throws AtlasException;

    void setDataSourceMetadata(DataSourceMetadata meta);

    DataSourceMetadata getDataSourceMetadata();

    Field createField();

}
