io.smallrye.stork.api.ServiceDiscovery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stork-api Show documentation

Main Stork API classes. You are likely to need `smallrye-stork-core` and not this module.

The newest version!

package io.smallrye.stork.api;

import java.util.List;

import io.smallrye.mutiny.Uni;

/**
 * Interface to retrieve the list of all available service instances for a given service.
 */
public interface ServiceDiscovery {
    /**
     * Retrieves the service instances.
     * 
     * This retrieval is an asynchronous action, thus, the method returns a {@link Uni}
     *
     * @return all `ServiceInstance`'s for the service
     */
    Uni> getServiceInstances();

    /**
     * Optional initialization.
     * This method will be invoked after all service discoveries and load balancers are registered in Stork
     *
     * @param stork the stork instance managing the service.
     */
    default void initialize(StorkServiceRegistry stork) {
    }
}