Package org.kiwiproject.registry.server
Interface RegistryService
-
- All Known Implementing Classes:
ConsulRegistryService,EurekaRegistryService,NoopRegistryService
public interface RegistryServiceContract for implementations of a service registry.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ServiceInstancecreateCandidateFrom(ServiceInfo serviceInfo)Creates a newServiceInstanceinstance from aServiceInfothat can be registered with the registry server.ServiceInstanceregister(ServiceInstance serviceToRegister)Registers aServiceInstancewith the registry server and returns a new instance containing information about the registered instance.voidunregister()Unregisters any registrations that were previously registered.ServiceInstanceupdateStatus(ServiceInstance.Status newStatus)Sends an update to the registry server to inform of a service status change
-
-
-
Method Detail
-
createCandidateFrom
ServiceInstance createCandidateFrom(ServiceInfo serviceInfo)
Creates a newServiceInstanceinstance from aServiceInfothat can be registered with the registry server.- Parameters:
serviceInfo- Service information that will be used to setup a new instance to be registered.- Returns:
- The
ServiceInstanceobject that was created
-
register
ServiceInstance register(ServiceInstance serviceToRegister)
Registers aServiceInstancewith the registry server and returns a new instance containing information about the registered instance.- Parameters:
serviceToRegister- The service information to register- Returns:
- The service instance that was registered
-
updateStatus
ServiceInstance updateStatus(ServiceInstance.Status newStatus)
Sends an update to the registry server to inform of a service status change- Parameters:
newStatus- The new status that will be sent- Returns:
- a copy of the original
ServiceInstancewith the new status set
-
unregister
void unregister()
Unregisters any registrations that were previously registered. This should be a NO-OP if nothing has ever been registered.
-
-