Module io.helidon.integrations.eureka
Package io.helidon.integrations.eureka

Interface InstanceInfoConfig

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
InstanceInfoConfig.BuilderBase.InstanceInfoConfigImpl
public interface InstanceInfoConfig extends Prototype.Api
A prototype describing initial Eureka Server service instance registration details.

This interface is deliberately modeled to closely resemble the com.netflix.appinfo.InstanceInfo class for familiarity.

Its configuration is deliberately modeled to closely resemble that expressed by the com.netflix.appinfo.PropertiesInstanceConfig class and its supertypes for user familiarity.

See Also:

  • Method Details

    • builder

      static InstanceInfoConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static InstanceInfoConfig.Builder builder(InstanceInfoConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static InstanceInfoConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static InstanceInfoConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • instanceId

      String instanceId(int actualPort)
      Returns the prototype's instance ID or a default value.
      Parameters:
      actualPort - the actual port; used when computing default value
      Returns:
      the instance ID

    • port

      int port(int actualPort, boolean tls)
      Returns the prototype's effective port, taking into account what the actual port is and whether TLS is in effect or not.
      Parameters:
      actualPort - the actual port
      tls - whether or not tls is in effect
      Returns:
      the appropriate port

    • portEnabled

      boolean portEnabled(boolean tls)
      Returns whether the effective port is enabled.
      Parameters:
      tls - whether or not TLS is in effect
      Returns:
      whether the effective port is enabled

    • securePort

      int securePort(int actualPort, boolean tls)
      Returns the prototype's effective secure port, taking into account what the actual port is and whether TLS is in effect or not.
      Parameters:
      actualPort - the actual port
      tls - whether or not tls is in effect
      Returns:
      the appropriate secure port

    • securePortEnabled

      boolean securePortEnabled(boolean tls)
      Returns whether the effective secure port is enabled.
      Parameters:
      tls - whether or not TLS is in effect
      Returns:
      whether the effective secure port is enabled

    • appName

      String appName()
      The app name.
      Returns:
      the app name

    • appGroupName

      String appGroupName()
      The app group name.
      Returns:
      the app group name

    • asgName

      Optional<String> asgName()
      The ASG name.

      ASG stands for Auto Scaling Group.

      Returns:
      the ASG name

    • healthCheckUrl

      Optional<URI> healthCheckUrl()
      The health check URL.
      Returns:
      the health check URL

    • healthCheckUrlPath

      String healthCheckUrlPath()
      The health check URL path (used if any health check URL is not explicitly set).
      Returns:
      the health check URL path

    • homePageUrl

      Optional<URI> homePageUrl()
      The home page URL.
      Returns:
      the home page URL

    • homePageUrlPath

      String homePageUrlPath()
      The home page URL path (used if the homepage URL is not explicitly set).
      Returns:
      the home page URL path

    • hostName

      String hostName()
      The hostname.
      Returns:
      the hostname

    • instanceId

      Optional<String> instanceId()
      The instance id.
      Returns:
      the instance id

    • ipAddr

      String ipAddr()
      The IP address.
      Returns:
      the IP address

    • jsonBuilderFactory

      JsonBuilderFactory jsonBuilderFactory()
      A JsonBuilderFactory.
      Returns:
      the JsonBuilderFactory

    • leaseInfo

      LeaseInfoConfig leaseInfo()
      The LeaseInfoConfig.
      Returns:
      the LeaseInfoConfig
      See Also:

    • metadata

      Map<String,String> metadata()
      Metadata.
      Returns:
      the metadata

    • port

      default int port()
      Port.
      Returns:
      the port

    • portInfo

      PortInfoConfig portInfo()
      (Non-secure) port information.
      Returns:
      PortInfoConfig

    • secureHealthCheckUrl

      Optional<URI> secureHealthCheckUrl()
      The secure health check URL.
      Returns:
      the secure health check URL

    • securePort

      default int securePort()
      Secure port.
      Returns:
      the secure port

    • securePortInfo

      PortInfoConfig securePortInfo()
      Secure port information.
      Returns:
      PortInfoConfig

    • statusPageUrl

      Optional<URI> statusPageUrl()
      The status page URL.
      Returns:
      the status page URL

    • statusPageUrlPath

      String statusPageUrlPath()
      The status page URL path (used if status page URL is not explicitly set).
      Returns:
      the status page URL path

    • trafficEnabled

      boolean trafficEnabled()
      Whether traffic is enabled on startup (normally true).
      Returns:
      whether traffic is enabled on startup

    • vipAddress

      Optional<String> vipAddress()
      The VIP address.

      VIP stands for Virtual IP.

      Returns:
      the VIP address

    • secureVipAddress

      Optional<String> secureVipAddress()
      The secure VIP address.

      VIP stands for Virtual IP.

      Returns:
      the secure VIP address