Package org.kiwiproject.registry.config

Interface ServiceInfo

  • public interface ServiceInfo
    Interface to assist in providing information about a service for registering.

    • Method Detail

      • getName

        String getName()
        Returns a name for the service. This name will be used when registering the service.
        Returns:
        The name for the service.

      • humanReadableName

        default String humanReadableName()
        Returns a human-readable version of the service name. Defaults to getName().
        Returns:
        A human-readable version of the name or the name itself by default

      • getHostname

        String getHostname()
        Returns the hostname that the service is running on.
        Returns:
        The hostname for the service

      • getIp

        String getIp()
        Returns the IP Address that the service is running on.
        Returns:
        The ip address for the service

      • getPorts

        List<Port> getPorts()
        Returns a list of port definitions that are being used by the service
        Returns:
        a list of ports
        See Also:
        Port

      • getPaths

        default ServicePaths getPaths()
        Returns the various paths common paths needed for service management. Defaults to standard paths.
        Returns:
        The paths defined in the service for management purposes
        See Also:
        ServicePaths

      • getDescription

        default String getDescription()
        Returns the description of the service. Defaults to empty string.
        Returns:
        A human-readable description of the service

      • getVersion

        String getVersion()
        Returns the version of the running service.
        Returns:
        the service version

      • getCommitRef

        default String getCommitRef()
        Returns the commit reference of the service. This can be used to know exactly what point in the source control a running service is running.
        Returns:
        The commit point of the running service

      • getMetadata

        default Map<String,​String> getMetadata()
        Returns metadata for the service. This is generally used to supply custom information about a service to a service registry.
        Returns:
        a map containing custom metadata. This default implementation returns an empty map.