Package org.wildfly.extension.microprofile.openapi.deployment

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 Type	Method	Description
String	getHostName()	Returns the name of the Undertow host to which this application is deployed.
io.smallrye.openapi.api.OpenApiConfig	getOpenApiConfig()	Returns the OpenAPI configuration for this deployment.
String	getPath()	Returns the URL path of the OpenAPI endpoint.
String	getServerName()	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>	getStaticFile()	Returns a tuple containing the static file and its format, or null, if the deployment does not define a static file.
boolean	isEnabled()	Indicates whether or not an OpenAPI endpoint is enabled for this deployment.
boolean	useRelativeServerURLs()	Indicates whether or not the OpenAPI document should use relative URLs.

Methods inherited from class java.lang.Object

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

Method Details

isEnabled

public boolean isEnabled()

Description copied from interface: OpenAPIModelConfiguration

Indicates whether or not an OpenAPI endpoint is enabled for this deployment.

Specified by:

isEnabled in interface OpenAPIModelConfiguration

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: OpenAPIModelConfiguration

Returns the OpenAPI configuration for this deployment.

Specified by:

getOpenApiConfig in interface OpenAPIModelConfiguration

Returns:

the OpenAPI configuration for this deployment.

getStaticFile

public Map.Entry<org.jboss.vfs.VirtualFile,io.smallrye.openapi.runtime.io.Format> getStaticFile()

Description copied from interface: OpenAPIModelConfiguration

Returns a tuple containing the static file and its format, or null, if the deployment does not define a static file.

Specified by:

getStaticFile in interface OpenAPIModelConfiguration

Returns:

a tuple containing the static file and its format, or null, if the deployment does not define a static file.

getServerName

public String getServerName()

Description copied from interface: OpenAPIEndpointConfiguration

Returns the name of the Undertow server to which this application is deployed.

Specified by:

getServerName in interface OpenAPIEndpointConfiguration

Returns:

the name of an Undertow server

getHostName

public String getHostName()

Description copied from interface: OpenAPIEndpointConfiguration

Returns the name of the Undertow host to which this application is deployed.

Specified by:

getHostName in interface OpenAPIEndpointConfiguration

Returns:

the name of an Undertow server

getPath

public String getPath()

Description copied from interface: OpenAPIEndpointConfiguration

Returns the URL path of the OpenAPI endpoint.

Specified by:

getPath in interface OpenAPIEndpointConfiguration

Returns:

an endpoint path

useRelativeServerURLs

public boolean useRelativeServerURLs()

Description copied from interface: OpenAPIModelConfiguration

Indicates whether or not the OpenAPI document should use relative URLs.

Specified by:

useRelativeServerURLs in interface OpenAPIModelConfiguration

Returns:

true, if the OpenAPI document for this deployment should use relative URLs, false otherwise.