org.fabric3.spi.discovery

Interface DiscoveryAgent

public interface DiscoveryAgent

An agent that interacts with a discovery service.

Method Summary

Modifier and Type	Method and Description
java.util.List<ChannelEntry>	getChannelEntries(java.lang.String name) Returns channel entries for a channel name.
java.util.List<ServiceEntry>	getServiceEntries(java.lang.String name) Returns service entries for a service name.
boolean	isLeader() Returns true if the runtime is leader for the current zone.
void	register(ChannelEntry entry) Registers a channel.
void	register(ServiceEntry entry) Registers a service.
void	registerChannelListener(java.lang.String name, java.util.function.BiConsumer<EntryChange,ChannelEntry> listener) Registers to receive callbacks when channel addresses change.
void	registerLeadershipListener(java.util.function.Consumer<java.lang.Boolean> consumer) Registers to receive callbacks when the runtime leadership status changes.
void	registerServiceListener(java.lang.String name, java.util.function.BiConsumer<EntryChange,ServiceEntry> listener) Registers to receive callbacks when service addresses change.
void	unregisterChannel(java.lang.String name) Removes a channel entry.
void	unregisterChannelListener(java.lang.String name, java.util.function.BiConsumer<EntryChange,ChannelEntry> listener) De-registers a listener.
void	unRegisterLeadershipListener(java.util.function.Consumer<java.lang.Boolean> consumer) Unregisters the leader election listener.
void	unregisterService(java.lang.String name) Removes a service entry.
void	unregisterServiceListener(java.lang.String name, java.util.function.BiConsumer<EntryChange,ServiceEntry> listener) De-registers a listener.

Method Detail

isLeader

boolean isLeader()

Returns true if the runtime is leader for the current zone.

Returns:

true if the runtime is the zone leader

getServiceEntries

java.util.List<ServiceEntry> getServiceEntries(java.lang.String name)

Returns service entries for a service name.

Parameters:

name - the service name

Returns:

service entries

getChannelEntries

java.util.List<ChannelEntry> getChannelEntries(java.lang.String name)

Returns channel entries for a channel name.

Parameters:

name - the channel name

Returns:

service entries

register

void register(ServiceEntry entry)

Registers a service.

Parameters:

entry - the entry

unregisterService

void unregisterService(java.lang.String name)

Removes a service entry.

Parameters:

name - the service name

register

void register(ChannelEntry entry)

Registers a channel.

Parameters:

entry - the entry

unregisterChannel

void unregisterChannel(java.lang.String name)

Removes a channel entry.

Parameters:

name - the channel name

registerLeadershipListener

void registerLeadershipListener(java.util.function.Consumer<java.lang.Boolean> consumer)

Registers to receive callbacks when the runtime leadership status changes.

Parameters:

consumer - the callback that will receive 'true' if the runtime is leader; otherwise false

unRegisterLeadershipListener

void unRegisterLeadershipListener(java.util.function.Consumer<java.lang.Boolean> consumer)

Unregisters the leader election listener.

Parameters:

consumer - the listener to unregister.

registerServiceListener

void registerServiceListener(java.lang.String name,
                             java.util.function.BiConsumer<EntryChange,ServiceEntry> listener)

Registers to receive callbacks when service addresses change.

Parameters:

name - the service name name

listener - the callback

unregisterServiceListener

void unregisterServiceListener(java.lang.String name,
                               java.util.function.BiConsumer<EntryChange,ServiceEntry> listener)

De-registers a listener.

Parameters:

name - the service address to de-register

listener - the listener

registerChannelListener

void registerChannelListener(java.lang.String name,
                             java.util.function.BiConsumer<EntryChange,ChannelEntry> listener)

Registers to receive callbacks when channel addresses change.

Parameters:

name - the channel name

listener - the callback

unregisterChannelListener

void unregisterChannelListener(java.lang.String name,
                               java.util.function.BiConsumer<EntryChange,ChannelEntry> listener)

De-registers a listener.

Parameters:

name - the channel address to de-register

listener - the listener