Package org.apache.hadoop.ipc

Class RefreshRegistry

java.lang.Object

org.apache.hadoop.ipc.RefreshRegistry

@Unstable
public class RefreshRegistry
extends java.lang.Object

Used to registry custom methods to refresh at runtime. Each identifier maps to one or more RefreshHandlers.

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
RefreshRegistry()

Method Summary

Modifier and Type	Method	Description
static RefreshRegistry	defaultRegistry()
java.util.Collection<RefreshResponse>	dispatch(java.lang.String identifier, java.lang.String[] args)	Lookup the responsible handler and return its result.
void	register(java.lang.String identifier, RefreshHandler handler)	Registers an object as a handler for a given identity.
boolean	unregister(java.lang.String identifier, RefreshHandler handler)	Remove the registered object for a given identity.
void	unregisterAll(java.lang.String identifier)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

RefreshRegistry

public RefreshRegistry()

Method Detail

defaultRegistry

public static RefreshRegistry defaultRegistry()

register

public void register(java.lang.String identifier,
                     RefreshHandler handler)

Registers an object as a handler for a given identity. Note: will prevent handler from being GC'd, object should unregister itself when done

Parameters:

identifier - a unique identifier for this resource, such as org.apache.hadoop.blacklist

handler - the object to register

unregister

public boolean unregister(java.lang.String identifier,
                          RefreshHandler handler)

Remove the registered object for a given identity.

Parameters:

identifier - the resource to unregister

handler - input handler.

Returns:

the true if removed

unregisterAll

public void unregisterAll(java.lang.String identifier)

dispatch

public java.util.Collection<RefreshResponse> dispatch(java.lang.String identifier,
                                                      java.lang.String[] args)

Lookup the responsible handler and return its result. This should be called by the RPC server when it gets a refresh request.

Parameters:

identifier - the resource to refresh

args - the arguments to pass on, not including the program name

Returns:

the response from the appropriate handler

Throws:

java.lang.IllegalArgumentException - on invalid identifier