ConfigDescriptorValidator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 org.apache.deltaspike.core.spi.config.view;

import org.apache.deltaspike.core.api.config.view.metadata.ConfigDescriptor;

/**
 * Allows to validate the final view-config descriptors before they get deployed.
 * Since the config-descriptor contains e.g. the final path,
 * it's also possible to validate if the corresponding file exists.
 * Use {@link ViewConfigRoot} to configure 1-n validators.
 */
public interface ConfigDescriptorValidator
{
    /**
     * Validates the given config-descriptor
     * @param configDescriptor (merged) config-descriptor directly before it gets deployed
     * @return true if the descriptor is valid, false otherwise
     */
    boolean isValid(ConfigDescriptor configDescriptor);
}