org.apache.bookkeeper.common.component

Class ComponentInfoPublisher

java.lang.Object

org.apache.bookkeeper.common.component.ComponentInfoPublisher

public class ComponentInfoPublisher
extends java.lang.Object

Allows a component to publish information about the services it implements, the endpoints it exposes and other useful information for management tools and client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComponentInfoPublisher.EndpointInfo Endpoint information.

Constructor Summary

Constructors

Constructor and Description
ComponentInfoPublisher()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,ComponentInfoPublisher.EndpointInfo>	getEndpoints()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
void	publishEndpoint(ComponentInfoPublisher.EndpointInfo endpoint)
void	publishProperty(java.lang.String key, java.lang.String value) Publish an information about the system, like an endpoint address.
void	startupFinished() Called by the framework to signal that preparation of startup is done, so we have gathered all of the available information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentInfoPublisher

public ComponentInfoPublisher()

Method Detail

publishProperty

public void publishProperty(java.lang.String key,
                            java.lang.String value)

Publish an information about the system, like an endpoint address.

Parameters:

key - the key

value - the value, null values are not allowed.

publishEndpoint

public void publishEndpoint(ComponentInfoPublisher.EndpointInfo endpoint)

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

getEndpoints

public java.util.Map<java.lang.String,ComponentInfoPublisher.EndpointInfo> getEndpoints()

startupFinished

public void startupFinished()

Called by the framework to signal that preparation of startup is done, so we have gathered all of the available information.