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

Interface DeploymentConfiguration

public interface DeploymentConfiguration
The configuration of an OpenAPI deployment.
Author:
Paul Ferraro

  • 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.
    <T> T
    getProperty(String name, T defaultValue)
    Returns the config property with the specified name, or the provided default value, if unspecified.
    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.

  • Method Details

    • getProperty

      <T> T getProperty(String name, T defaultValue)
      Returns the config property with the specified name, or the provided default value, if unspecified.
      Returns:
      the config property with the specified name, or the provided default value, if unspecified.

    • getOpenApiConfig

      io.smallrye.openapi.api.OpenApiConfig getOpenApiConfig()
      Returns the OpenAPI configuration for this deployment.
      Returns:
      the OpenAPI configuration for this deployment.

    • getStaticFile

      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.
      Returns:
      a tuple containing the static file and its format, or null, if the deployment does not define a static file.

    • getServerName

      String getServerName()
      Returns the name of the Undertow server to which this application is deployed.
      Returns:
      the name of an Undertow server

    • getHostName

      String getHostName()
      Returns the name of the Undertow host to which this application is deployed.
      Returns:
      the name of an Undertow server