Package io.micronaut.openapi.visitor

Class ConfigUtils

java.lang.Object

io.micronaut.openapi.visitor.ConfigUtils

@Internal
public final class ConfigUtils
extends Object

Configuration utilities methods.

Since:

4.10.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ConfigUtils.AdditionalFilesProperties	Additional files properties.
static final record	ConfigUtils.CustomSchema	Custom schema class.
static enum	ConfigUtils.DuplicateResolution	Duplicate schema resolution mode.
static enum	ConfigUtils.MergeMode	Merge mode for additional OpenAPI specification files.
static enum	ConfigUtils.PatternStyle	Merge mode for additional OpenAPI specification files.
static final class	ConfigUtils.SchemaDecorator	Information about decorator.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_ENDPOINTS_NAME
static final String	ALL_SPRING_ACTUATOR_ENDPOINTS_NAME

Method Summary

Modifier and Type	Method	Description
static Map<String,EndpointProperties>	endpointsProperties(io.micronaut.inject.visitor.VisitorContext context)
static List<String>	getActiveEnvs(io.micronaut.inject.visitor.VisitorContext context)
static ConfigUtils.AdditionalFilesProperties	getAdditionalFilesProperties(io.micronaut.inject.visitor.VisitorContext context)
static Map<String,String>	getAdocProperties(OpenApiInfo openApiInfo, boolean isSingleGroup, io.micronaut.inject.visitor.VisitorContext context)
static boolean	getBooleanProperty(String property, boolean defaultValue, io.micronaut.inject.visitor.VisitorContext context)
static String	getConfigProperty(String key, io.micronaut.inject.visitor.VisitorContext context)
static io.micronaut.inject.ast.ClassElement	getCustomSchema(String className, Map<String,io.micronaut.inject.ast.ClassElement> typeArgs, io.micronaut.inject.visitor.VisitorContext context)
static DocsFormat	getDocsFormat(@Nullable io.micronaut.inject.visitor.VisitorContext context)
static EndpointsConfig	getEndpointsConfig(io.micronaut.inject.visitor.VisitorContext context)	Returns the EndpointsConfiguration.
static @Nullable io.micronaut.context.env.Environment	getEnv(io.micronaut.inject.visitor.VisitorContext context)
static List<Pair<String,String>>	getExpandableProperties(io.micronaut.inject.visitor.VisitorContext context)
static String	getGenericSeparator(io.micronaut.inject.visitor.VisitorContext context)
static GroupProperties	getGroupProperties(String groupName, io.micronaut.inject.visitor.VisitorContext context)
static Map<String,GroupProperties>	getGroupsPropertiesMap(io.micronaut.inject.visitor.VisitorContext context)
static IncludeExcludeProperties	getIncludeExcludeProperties(io.micronaut.inject.visitor.VisitorContext context)
static String	getInnerClassSeparator(io.micronaut.inject.visitor.VisitorContext context)
static com.fasterxml.jackson.annotation.JsonInclude.Include	getJacksonIncludeMode(io.micronaut.inject.visitor.VisitorContext context)
static String	getJsonSchemaDialect(io.micronaut.inject.visitor.VisitorContext context)
static List<String>	getListStringsProperty(String property, List<String> defaultValue, io.micronaut.inject.visitor.VisitorContext context)
static @Nullable Path	getProjectPath(io.micronaut.inject.visitor.VisitorContext context)
static com.fasterxml.jackson.databind.PropertyNamingStrategies.NamingBase	getPropertyNamingStrategy(io.micronaut.inject.visitor.VisitorContext context)
static RouterVersioningProperties	getRouterVersioningProperties(io.micronaut.inject.visitor.VisitorContext context)
static ConfigUtils.SchemaDecorator	getSchemaDecoration(String packageName, io.micronaut.inject.visitor.VisitorContext context)
static ConfigUtils.DuplicateResolution	getSchemaDuplicateResolution(io.micronaut.inject.visitor.VisitorContext context)
static SecurityProperties	getSecurityProperties(io.micronaut.inject.visitor.VisitorContext context)
static @NonNull String	getServerContextPath(io.micronaut.inject.visitor.VisitorContext context)
static int	getTagGenerationDescriptionMaxLength(io.micronaut.inject.visitor.VisitorContext context)
static com.fasterxml.jackson.databind.PropertyNamingStrategies.NamingBase	getTagGenerationNamingStrategy(io.micronaut.inject.visitor.VisitorContext context)
static List<String>	getTagGenerationRemovePostfixes(io.micronaut.inject.visitor.VisitorContext context)
static List<String>	getTagGenerationRemovePrefixes(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isAdocEnabled(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isConstructorArgumentsAsRequired(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isEndpointsEnabled(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isExtraSchemasEnabled(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isGeneratorExtensionsEnabled(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isJsonViewDefaultInclusion(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isJsonViewEnabled(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isOpenApiEnabled(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isResponseReadSuccessfulFromCode(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isSchemaNameSeparatorEmpty(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isSpecGenerationEnabled(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isTagGenerationByClassEnabled(io.micronaut.inject.visitor.VisitorContext context)
static boolean	isTagGenerationByPackageEnabled(io.micronaut.inject.visitor.VisitorContext context)
static Map<String,Object>	parseExtensions(String value, io.micronaut.inject.visitor.VisitorContext context)
static List<io.swagger.v3.oas.models.security.SecurityRequirement>	parseSecurityRequirements(String securityRequirements, io.micronaut.inject.visitor.VisitorContext context)
static List<io.swagger.v3.oas.models.servers.Server>	parseServers(String servers, io.micronaut.inject.visitor.VisitorContext context)
static List<io.swagger.v3.oas.models.tags.Tag>	parseTags(String stringTagsStr)
static Properties	readOpenApiConfigFile(io.micronaut.inject.visitor.VisitorContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ALL_ENDPOINTS_NAME

public static final String ALL_ENDPOINTS_NAME

See Also:

• Constant Field Values

ALL_SPRING_ACTUATOR_ENDPOINTS_NAME

public static final String ALL_SPRING_ACTUATOR_ENDPOINTS_NAME

See Also:

• Constant Field Values

Method Details

getSchemaDecoration

public static ConfigUtils.SchemaDecorator getSchemaDecoration(String packageName,
 io.micronaut.inject.visitor.VisitorContext context)

getCustomSchema

public static io.micronaut.inject.ast.ClassElement getCustomSchema(String className,
 Map<String,io.micronaut.inject.ast.ClassElement> typeArgs,
 io.micronaut.inject.visitor.VisitorContext context)

getServerContextPath

@NonNull
public static @NonNull String getServerContextPath(io.micronaut.inject.visitor.VisitorContext context)

getSchemaDuplicateResolution

public static ConfigUtils.DuplicateResolution getSchemaDuplicateResolution(io.micronaut.inject.visitor.VisitorContext context)

isConstructorArgumentsAsRequired

public static boolean isConstructorArgumentsAsRequired(io.micronaut.inject.visitor.VisitorContext context)

isResponseReadSuccessfulFromCode

public static boolean isResponseReadSuccessfulFromCode(io.micronaut.inject.visitor.VisitorContext context)

isOpenApiEnabled

public static boolean isOpenApiEnabled(io.micronaut.inject.visitor.VisitorContext context)

isSchemaNameSeparatorEmpty

public static boolean isSchemaNameSeparatorEmpty(io.micronaut.inject.visitor.VisitorContext context)

getGenericSeparator

public static String getGenericSeparator(io.micronaut.inject.visitor.VisitorContext context)

getInnerClassSeparator

public static String getInnerClassSeparator(io.micronaut.inject.visitor.VisitorContext context)

getJsonSchemaDialect

public static String getJsonSchemaDialect(io.micronaut.inject.visitor.VisitorContext context)

isSpecGenerationEnabled

public static boolean isSpecGenerationEnabled(io.micronaut.inject.visitor.VisitorContext context)

isTagGenerationByClassEnabled

public static boolean isTagGenerationByClassEnabled(io.micronaut.inject.visitor.VisitorContext context)

isTagGenerationByPackageEnabled

public static boolean isTagGenerationByPackageEnabled(io.micronaut.inject.visitor.VisitorContext context)

getTagGenerationDescriptionMaxLength

public static int getTagGenerationDescriptionMaxLength(io.micronaut.inject.visitor.VisitorContext context)

getTagGenerationNamingStrategy

public static com.fasterxml.jackson.databind.PropertyNamingStrategies.NamingBase getTagGenerationNamingStrategy(io.micronaut.inject.visitor.VisitorContext context)

getTagGenerationRemovePrefixes

public static List<String> getTagGenerationRemovePrefixes(io.micronaut.inject.visitor.VisitorContext context)

getTagGenerationRemovePostfixes

public static List<String> getTagGenerationRemovePostfixes(io.micronaut.inject.visitor.VisitorContext context)

isExtraSchemasEnabled

public static boolean isExtraSchemasEnabled(io.micronaut.inject.visitor.VisitorContext context)

isJsonViewDefaultInclusion

public static boolean isJsonViewDefaultInclusion(io.micronaut.inject.visitor.VisitorContext context)

isGeneratorExtensionsEnabled

public static boolean isGeneratorExtensionsEnabled(io.micronaut.inject.visitor.VisitorContext context)

isAdocEnabled

public static boolean isAdocEnabled(io.micronaut.inject.visitor.VisitorContext context)

isJsonViewEnabled

public static boolean isJsonViewEnabled(io.micronaut.inject.visitor.VisitorContext context)

isEndpointsEnabled

public static boolean isEndpointsEnabled(io.micronaut.inject.visitor.VisitorContext context)

getExpandableProperties

public static List<Pair<String,String>> getExpandableProperties(io.micronaut.inject.visitor.VisitorContext context)

getAdocProperties

public static Map<String,String> getAdocProperties(OpenApiInfo openApiInfo,
 boolean isSingleGroup,
 io.micronaut.inject.visitor.VisitorContext context)

getSecurityProperties

public static SecurityProperties getSecurityProperties(io.micronaut.inject.visitor.VisitorContext context)

getRouterVersioningProperties

public static RouterVersioningProperties getRouterVersioningProperties(io.micronaut.inject.visitor.VisitorContext context)

getListStringsProperty

public static List<String> getListStringsProperty(String property,
 List<String> defaultValue,
 io.micronaut.inject.visitor.VisitorContext context)

getGroupProperties

public static GroupProperties getGroupProperties(String groupName,
 io.micronaut.inject.visitor.VisitorContext context)

getGroupsPropertiesMap

public static Map<String,GroupProperties> getGroupsPropertiesMap(io.micronaut.inject.visitor.VisitorContext context)

getEndpointsConfig

public static EndpointsConfig getEndpointsConfig(io.micronaut.inject.visitor.VisitorContext context)

Returns the EndpointsConfiguration.

Parameters:

context - The context.

Returns:

The EndpointsConfiguration.

endpointsProperties

public static Map<String,EndpointProperties> endpointsProperties(io.micronaut.inject.visitor.VisitorContext context)

parseExtensions

public static Map<String,Object> parseExtensions(String value,
 io.micronaut.inject.visitor.VisitorContext context)

parseServers

public static List<io.swagger.v3.oas.models.servers.Server> parseServers(String servers,
 io.micronaut.inject.visitor.VisitorContext context)

parseSecurityRequirements

public static List<io.swagger.v3.oas.models.security.SecurityRequirement> parseSecurityRequirements(String securityRequirements,
 io.micronaut.inject.visitor.VisitorContext context)

parseTags

public static List<io.swagger.v3.oas.models.tags.Tag> parseTags(String stringTagsStr)

getProjectPath

@Nullable
public static @Nullable Path getProjectPath(io.micronaut.inject.visitor.VisitorContext context)

getPropertyNamingStrategy

public static com.fasterxml.jackson.databind.PropertyNamingStrategies.NamingBase getPropertyNamingStrategy(io.micronaut.inject.visitor.VisitorContext context)

getJacksonIncludeMode

public static com.fasterxml.jackson.annotation.JsonInclude.Include getJacksonIncludeMode(io.micronaut.inject.visitor.VisitorContext context)

getConfigProperty

public static String getConfigProperty(String key,
 io.micronaut.inject.visitor.VisitorContext context)

getAdditionalFilesProperties

public static ConfigUtils.AdditionalFilesProperties getAdditionalFilesProperties(io.micronaut.inject.visitor.VisitorContext context)

getBooleanProperty

public static boolean getBooleanProperty(String property,
 boolean defaultValue,
 io.micronaut.inject.visitor.VisitorContext context)

readOpenApiConfigFile

public static Properties readOpenApiConfigFile(io.micronaut.inject.visitor.VisitorContext context)

getEnv

@Nullable
public static @Nullable io.micronaut.context.env.Environment getEnv(io.micronaut.inject.visitor.VisitorContext context)

getActiveEnvs

public static List<String> getActiveEnvs(io.micronaut.inject.visitor.VisitorContext context)

getIncludeExcludeProperties

public static IncludeExcludeProperties getIncludeExcludeProperties(io.micronaut.inject.visitor.VisitorContext context)

getDocsFormat

public static DocsFormat getDocsFormat(@Nullable
 @Nullable io.micronaut.inject.visitor.VisitorContext context)