org.kiwiproject.registry.model.ServiceInstance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of service-discovery-client Show documentation
Abstract service discovery API for service registration and lookup
There is a newer version: 2.1.4
Show newest version
package org.kiwiproject.registry.model;

import static java.util.Objects.isNull;

import lombok.Builder;
import lombok.Value;
import lombok.With;
import org.kiwiproject.registry.config.ServiceInfo;
import org.kiwiproject.registry.model.Port.PortType;
import org.kiwiproject.registry.util.Ports;

import java.time.Instant;
import java.util.List;
import java.util.Map;

/**
 * Model containing information about a running service
 */
@Value
@Builder(toBuilder = true)
public class ServiceInstance {

    /**
     * The status of a service
     */
    public enum Status {
        UP,
        DOWN,
        STARTING
    }

    @With
    String instanceId;

    @With
    Status status;

    String serviceName;

    @With
    String hostName;

    String ip;
    List ports;
    ServicePaths paths;
    String commitRef;
    String description;
    String version;
    Instant upSince;

    /**
     * Used to store extra data in a discovery service for this instance
     */
    @With
    Map metadata;

    /**
     * Used to store native registry data that includes data mapped into {@link ServiceInstance} as well as any
     * additional information that is not mapped. This will only be populated if the registry configuration
     * specifies to include native data.
     */
    @With
    Map nativeRegistryData;

    /**
     * Returns a new {@code ServiceInstanceBuilder} built from a given {@link ServiceInfo}.
     * 
     * Note that a copy of {@link ServiceInfo#getMetadata()} is made using {@link Map#copyOf(Map)}, so the metadata
     * is unmodifiable.
     *
     * @param serviceInfo The information about the service used to initialize the {@code ServiceInstanceBuilder}
     * @return a {@code ServiceInstanceBuilder} with values copied from the given {@link ServiceInfo}
     */
    public static ServiceInstance fromServiceInfo(ServiceInfo serviceInfo) {
        return ServiceInstance.builder()
                .serviceName(serviceInfo.getName())
                .hostName(serviceInfo.getHostname())
                .ip(serviceInfo.getIp())
                .ports(serviceInfo.getPorts())
                .paths(serviceInfo.getPaths())
                .commitRef(serviceInfo.getCommitRef())
                .description(serviceInfo.getDescription())
                .version(serviceInfo.getVersion())
                .metadata(Map.copyOf(serviceInfo.getMetadata()))
                .build();
    }

    /**
     * Returns the Instant this service has been up since, or {@link Instant#EPOCH} if no value was provided
     * when this instance was created.
     *
     * @return a non-null Instant representing the instant this service was started, or the epoch if no value provided
     */
    public Instant getUpSince() {
        return isNull(upSince) ? Instant.EPOCH : upSince;
    }

    /**
     * Returns the time since the epoch this service has been up since, or zero (the epoch), if no value
     * was provided when this instance was created.
     *
     * @return the number of milliseconds since the epoch that this service was started, or zero if no value provided
     */
    public long getUpSinceMillis() {
        return getUpSince().toEpochMilli();
    }

    /**
     * Returns the application port of this instance, preferring the secure port (if both secure and insecure exist).
     *
     * @return the application port
     * @see Ports#findFirstPortPreferSecure(List, PortType)
     */
    public Port getApplicationPort() {
        return Ports.findFirstPortPreferSecure(ports, PortType.APPLICATION);
    }

    /**
     * Returns the admin port of this instance, preferring the secure port (if both secure and insecure exist).
     *
     * @return the admin port
     * @see Ports#findFirstPortPreferSecure(List, PortType)
     */
    public Port getAdminPort() {
        return Ports.findFirstPortPreferSecure(ports, PortType.ADMIN);
    }
}