org.iris_events.asyncapi.api.AsyncApiConfig Maven / Gradle / Ivy
/**
* Copyright 2019 Red Hat, Inc, and individual contributors.
*
* 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 org.iris_events.asyncapi.api;
import java.util.Collections;
import java.util.Set;
import java.util.regex.Pattern;
/**
* Accessor to AsyncAPI configuration options.
*
* mp.asyncapi.model.reader : Configuration property to specify the fully qualified name of the AAIModelReader implementation.
* mp.asyncapi.filter : Configuration property to specify the fully qualified name of the AAIFilter implementation.
* mp.asyncapi.scan.disable : Configuration property to disable annotation scanning. Default value is false.
* mp.asyncapi.scan.packages : Configuration property to specify the list of packages to scan.
* mp.asyncapi.scan.classes : Configuration property to specify the list of classes to scan.
* mp.asyncapi.scan.exclude.packages : Configuration property to specify the list of packages to exclude from scans.
* mp.asyncapi.scan.exclude.classes : Configuration property to specify the list of classes to exclude from scans.
* mp.asyncapi.servers : Configuration property to specify the list of global servers that provide connectivity information.
*
* @author [email protected]
*/
public interface AsyncApiConfig {
default String modelReader() {
return null;
}
default String filter() {
return null;
};
default boolean scanDisable() {
return false;
}
default Set scanPackages() {
return Collections.emptySet();
};
default Pattern scanPackagesPattern() {
return null;
}
default Set scanClasses() {
return Collections.emptySet();
}
default Pattern scanClassesPattern() {
return null;
}
default Set scanExcludePackages() {
return Collections.emptySet();
}
default Pattern scanExcludePackagesPattern() {
return null;
}
default Set scanExcludeClasses() {
return Collections.emptySet();
}
default Pattern scanExcludeClassesPattern() {
return null;
}
default Set servers() {
return Collections.emptySet();
}
default boolean scanDependenciesDisable() {
return false;
}
default Set scanDependenciesJars() {
return Collections.emptySet();
}
default boolean schemaReferencesEnable() {
return true;
}
default String customSchemaRegistryClass() {
return null;
}
default Set excludeFromSchemas() {
return Collections.emptySet();
}
default String projectVersion() {
return null;
}
}