001/**
002 * Copyright (C) 2006-2024 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.tools.spi;
017
018import java.util.Collection;
019import java.util.List;
020
021import org.apache.xbean.finder.AnnotationFinder;
022import org.talend.sdk.component.runtime.manager.ParameterMeta;
023
024import lombok.Builder;
025import lombok.Data;
026
027public interface ValidationExtension {
028
029    /**
030     * IMPORTANT: this method must not fail but rather return the errors through the result instance.
031     *
032     * @param context the current validated context.
033     * @return the validation result, mainly errors.
034     */
035    ValidationResult validate(ValidationContext context);
036
037    interface ValidationContext {
038
039        /**
040         * @return the currently scanned module(s) finder to be able to grab custom API.
041         */
042        AnnotationFinder finder();
043
044        /**
045         * @return currently validated components - using the standard API.
046         */
047        List<Class<?>> components();
048
049        /**
050         * @param component the component type.
051         * @return the flattened list of options for that component.
052         */
053        List<ParameterMeta> parameters(final Class<?> component);
054    }
055
056    @Data
057    @Builder
058    class ValidationResult {
059
060        private Collection<String> errors;
061    }
062}