Class DeploymentUnitOpenAPIModelConfiguration
java.lang.Object
org.wildfly.extension.microprofile.openapi.deployment.DeploymentUnitOpenAPIModelConfiguration
- All Implemented Interfaces:
OpenAPIEndpointConfiguration,OpenAPIModelConfiguration
public class DeploymentUnitOpenAPIModelConfiguration
extends Object
implements OpenAPIModelConfiguration
Encapsulates the
OpenAPIModelConfiguration for a deployment.- Author:
- Paul Ferraro
-
Field Summary
Fields inherited from interface org.wildfly.extension.microprofile.openapi.deployment.OpenAPIModelConfiguration
SERVICE_DESCRIPTOR -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the Undertow host to which this application is deployed.io.smallrye.openapi.api.OpenApiConfigReturns the OpenAPI configuration for this deployment.getPath()Returns the URL path of the OpenAPI endpoint.Returns the name of the Undertow server to which this application is deployed.Map.Entry<org.jboss.vfs.VirtualFile,io.smallrye.openapi.runtime.io.Format> Returns a tuple containing the static file and its format, or null, if the deployment does not define a static file.booleanIndicates whether or not an OpenAPI endpoint is enabled for this deployment.booleanIndicates whether or not the OpenAPI document should use relative URLs.
-
Method Details
-
isEnabled
public boolean isEnabled()Description copied from interface:OpenAPIModelConfigurationIndicates whether or not an OpenAPI endpoint is enabled for this deployment.- Specified by:
isEnabledin interfaceOpenAPIModelConfiguration- Returns:
- true, if an OpenAPI endpoint is enabled for this deployment, false otherwise.
-
getOpenApiConfig
public io.smallrye.openapi.api.OpenApiConfig getOpenApiConfig()Description copied from interface:OpenAPIModelConfigurationReturns the OpenAPI configuration for this deployment.- Specified by:
getOpenApiConfigin interfaceOpenAPIModelConfiguration- Returns:
- the OpenAPI configuration for this deployment.
-
getStaticFile
Description copied from interface:OpenAPIModelConfigurationReturns a tuple containing the static file and its format, or null, if the deployment does not define a static file.- Specified by:
getStaticFilein interfaceOpenAPIModelConfiguration- Returns:
- a tuple containing the static file and its format, or null, if the deployment does not define a static file.
-
getServerName
Description copied from interface:OpenAPIEndpointConfigurationReturns the name of the Undertow server to which this application is deployed.- Specified by:
getServerNamein interfaceOpenAPIEndpointConfiguration- Returns:
- the name of an Undertow server
-
getHostName
Description copied from interface:OpenAPIEndpointConfigurationReturns the name of the Undertow host to which this application is deployed.- Specified by:
getHostNamein interfaceOpenAPIEndpointConfiguration- Returns:
- the name of an Undertow server
-
getPath
Description copied from interface:OpenAPIEndpointConfigurationReturns the URL path of the OpenAPI endpoint.- Specified by:
getPathin interfaceOpenAPIEndpointConfiguration- Returns:
- an endpoint path
-
useRelativeServerURLs
public boolean useRelativeServerURLs()Description copied from interface:OpenAPIModelConfigurationIndicates whether or not the OpenAPI document should use relative URLs.- Specified by:
useRelativeServerURLsin interfaceOpenAPIModelConfiguration- Returns:
- true, if the OpenAPI document for this deployment should use relative URLs, false otherwise.
-