Package com.microservices.starter.core.environment

Interface Identifiable

All Superinterfaces:
EnabledAware
All Known Subinterfaces:
Routed
All Known Implementing Classes:
Component, FlexComponent, LibraryComponent, OtherComponent
public interface Identifiable extends EnabledAware
Indicates the type of Component that exposes Port information.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAltName()
    An alternative name used to identify the component.
    Domain
    getDomain()
    Domain (DNS) information used at runtime for dynamic application configuration to negotiate gateway routing and interservice communication appropriately based on the deployed environment.
    Boolean
    getEnabled()
    Whether or not the component is enabled.
    String
    getName()
    The name used to identify the component.
    List<Port>
    getPorts()
    The ports exposed and supported by the component.

    Methods inherited from interface com.microservices.starter.core.environment.EnabledAware

    setEnabled

  • Method Details

    • getPorts

      List<Port> getPorts()
      The ports exposed and supported by the component. Required.

    • getName

      String getName()
      The name used to identify the component. Required.
      Specified by:
      getName in interface EnabledAware

    • getAltName

      String getAltName()
      An alternative name used to identify the component. Generally the longer version of the name for those components with long or descriptive names. Optional.

    • getDomain

      Domain getDomain()
      Domain (DNS) information used at runtime for dynamic application configuration to negotiate gateway routing and interservice communication appropriately based on the deployed environment. Required.

    • getEnabled

      Boolean getEnabled()
      Whether or not the component is enabled. Disabled flexpackage components are not included in docker-compose and are not included in generated project structure, disabled service library components are not included in generated project structure (in which case it is assumed Broadleaf's out-of-the-box version is used), and disabled "other" components are not included in docker-compose. Required.
      Specified by:
      getEnabled in interface EnabledAware