org.springframework.cloud.client.serviceregistry

Interface ServiceRegistry<R extends Registration>

public interface ServiceRegistry<R extends Registration>

Contract to register and deregister instances with a Service Registry.

Since:

1.2.0

Author:

Spencer Gibb

Method Summary

Modifier and Type	Method and Description
void	close() Closes the ServiceRegistry.
void	deregister(R registration) Deregisters the registration.
<T> T	getStatus(R registration) Gets the status of a particular registration.
void	register(R registration) Registers the registration.
void	setStatus(R registration, String status) Sets the status of the registration.

Method Detail

register

void register(R registration)

Registers the registration. A registration typically has information about an instance, such as its hostname and port.

Parameters:

registration - The registration.

deregister

void deregister(R registration)

Deregisters the registration.

Parameters:

registration -

close

void close()

Closes the ServiceRegistry. This is a lifecycle method.

setStatus

void setStatus(R registration,
               String status)

Sets the status of the registration. The status values are determined by the individual implementations.

Parameters:

registration - The registration to update.

status - The status to set.

See Also:

ServiceRegistryEndpoint

getStatus

<T> T getStatus(R registration)

Gets the status of a particular registration.

Type Parameters:

T - The type of the status.

Parameters:

registration - The registration to query.

Returns:

The status of the registration.

See Also:

ServiceRegistryEndpoint