Package org.apache.juneau.bean.openapi3

Class Server

java.lang.Object
org.apache.juneau.bean.openapi3.OpenApiElement
org.apache.juneau.bean.openapi3.Server
public class Server extends OpenApiElement
An object representing a Server.

The Server Object represents a server that provides connectivity information to a target server. This can be used to specify different servers for different environments (e.g., development, staging, production) or to provide server-specific configuration such as variables for templating.

OpenAPI Specification:

The Server Object is composed of the following fields:

  • url (string, REQUIRED) - A URL to the target host. This URL supports Server Variables and may be relative
  • description (string) - An optional string describing the host designated by the URL (CommonMark syntax may be used)
  • variables (map of ServerVariable) - A map between a variable name and its value
Example:

// Create a server with variables Server server = new Server() .setUrl("https://{username}.gigantic-server.com:{port}/{basePath}") .setDescription("The production API server") .setVariables( JsonMap.of( "username", new ServerVariable() .setDefault("demo") .setDescription("this value is assigned by the service provider"), "port", new ServerVariable() .setDefault("8443") .setEnum("8443", "443"), "basePath", new ServerVariable() .setDefault("v2") ) );

See Also:

  • Constructor Details

    • Server

      public Server()
      Default constructor.

    • Server

      public Server(Server copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The object to copy.

  • Method Details

    • addVariable

      public Server addVariable(String key, ServerVariable value)
      Adds one or more values to the variables property.
      Parameters:
      key - The mapping key. Must not be null.
      value - The values to add to this property.
      Must not be null.
      Ignored if null.
      Returns:
      This object

    • copy

      public Server copy()
      Make a deep copy of this object.
      Returns:
      A deep copy of this object.

    • get

      public <T> T get(String property, Class<T> type)
      Description copied from class: OpenApiElement
      Generic property getter.

      Can be used to retrieve non-standard Swagger fields such as "$ref".

      Overrides:
      get in class OpenApiElement
      Type Parameters:
      T - The datatype to cast the value to.
      Parameters:
      property - The property name to retrieve.
      type - The datatype to cast the value to.
      Returns:
      The property value, or null if the property does not exist or is not set.

    • getDescription

      public String getDescription()
      Bean property getter: description.
      Returns:
      The property value, or null if it is not set.

    • getUrl

      public URI getUrl()
      Bean property getter: url.

      The URL pointing to the contact information.

      Returns:
      The property value, or null if it is not set.

    • getVariables

      public Map<String,ServerVariable> getVariables()
      Bean property getter: variables.
      Returns:
      The property value, or null if it is not set.

    • keySet

      public Set<String> keySet()
      Description copied from class: OpenApiElement
      Returns all the keys on this element.
      Overrides:
      keySet in class OpenApiElement
      Returns:
      All the keys on this element.
      Never null.

    • set

      public Server set(String property, Object value)
      Description copied from class: OpenApiElement
      Generic property setter.

      Can be used to set non-standard Swagger fields such as "$ref".

      Overrides:
      set in class OpenApiElement
      Parameters:
      property - The property name to set. Must not be null.
      value - The new value for the property.
      Returns:
      This object

    • setDescription

      public Server setDescription(String value)
      Bean property setter: description.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setUrl

      public Server setUrl(URI value)
      Bean property setter: url.

      The value can be of any of the following types: URI, URL, String.
      Strings must be valid URIs.

      URIs defined by UriResolver can be used for values.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setVariables

      public Server setVariables(Map<String,ServerVariable> value)
      Bean property setter: variables.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • strict

      public Server strict(Object value)
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Parameters:
      value - The new value for this property.
      Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
      Can be null (interpreted as false).
      Returns:
      This object

    • strict

      protected Server strict()
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Returns:
      This object