Package com.microservices.starter.core.environment

Class LibraryComponent

java.lang.Object
com.microservices.starter.core.environment.Component
com.microservices.starter.core.environment.LibraryComponent
All Implemented Interfaces:
DomainAware, EnabledAware, Identifiable, Routed, Serializable
public class LibraryComponent extends Component implements Routed
Type of component that relates to microservice source code. This is different than a FlexComponent whose purpose is to simply expose the application runtime and Docker image for the microservice. LibraryComponents are where code and extensions are introduced to modify the behavior of the microservice.
See Also:

  • Constructor Details

    • LibraryComponent

      public LibraryComponent()

  • Method Details

    • getSampleCode

      public Boolean getSampleCode()
      Whether or not to include sample code (autoconfiguration, sample domain, and test) for an enabled service library component during project structure generation. Optional. False by default.

    • getRouted

      public Boolean getRouted()
      Description copied from interface: Routed
      Whether or not this service is included in the routing configuration supplied to the gateway service. Optional. True by default.
      Specified by:
      getRouted in interface Routed

    • getAltRoute

      public String getAltRoute()
      Description copied from interface: Routed
      An additional route this component is known by in the gateway service. This is rarely used and is primarily leveraged by auth. Optional.
      Specified by:
      getAltRoute in interface Routed

    • getProfiles

      public Set<String> getProfiles()
      Override the default configuration profiles associated with the component. These profiles drive the properties that are included in the generated project config directories for each flex package. A library component is a member of a flex package, and the properties generated for the flex package are a union of all the properties associated with profiles for all the library components. See EnvironmentReportContributor#profiles(String, Set) for more details.

    • setSampleCode

      public void setSampleCode(Boolean sampleCode)
      Whether or not to include sample code (autoconfiguration, sample domain, and test) for an enabled service library component during project structure generation. Optional. False by default.

    • setRouted

      public void setRouted(Boolean routed)

    • setAltRoute

      public void setAltRoute(String altRoute)

    • setProfiles

      public void setProfiles(Set<String> profiles)
      Override the default configuration profiles associated with the component. These profiles drive the properties that are included in the generated project config directories for each flex package. A library component is a member of a flex package, and the properties generated for the flex package are a union of all the properties associated with profiles for all the library components. See EnvironmentReportContributor#profiles(String, Set) for more details.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Component

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Component

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Component

    • toString

      public String toString()
      Overrides:
      toString in class Component