Top Description Inners Fields Constructors Methods

io.undertow.server

public Class ListenerRegistry

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.ListenerRegistry

Imports

java.net.InetSocketAddress, java.util.Collection, .Collections, .Map, .Set, java.util.concurrent.ConcurrentMap, .CopyOnWriteArraySet, io.undertow.UndertowMessages, io.undertow.util.CopyOnWriteMap

A registry of listeners, and the services that are exposed via these listeners. This is not used directly by Undertow, but can be used by embedding applications to track listener metadata.

Author: Stuart Douglas

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ListenerRegistry.HttpUpgradeMetadata
public static class	ListenerRegistry.Listener

Field Summary

Modifier and Type	Field and Description
private final ConcurrentMap<String, ListenerRegistry.Listener>	listeners

Constructor Summary

Access	Constructor and Description
public	ListenerRegistry()

Method Summary

Modifier and Type	Method and Description
public void	addListener(final ListenerRegistry.Listener listener)
public ListenerRegistry.Listener	getListener(final String name)
public void	removeListener(final String name)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

listeners	back to summary
private final ConcurrentMap<String, ListenerRegistry.Listener> listeners

Constructor Detail

ListenerRegistry	back to summary
public ListenerRegistry()

Method Detail

addListener	back to summary
public void addListener(final ListenerRegistry.Listener listener)

getListener	back to summary
public ListenerRegistry.Listener getListener(final String name)

removeListener	back to summary
public void removeListener(final String name)

io.undertow.server back to summary

public final Class ListenerRegistry.HttpUpgradeMetadata

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.ListenerRegistry.HttpUpgradeMetadata

Field Summary

Modifier and Type	Field and Description
private final Map<String, Object>	contextInformation
private final String	protocol
private final String	subProtocol

Constructor Summary

Access	Constructor and Description
public	HttpUpgradeMetadata(final String protocol, final String subProtocol)

Method Summary

Modifier and Type	Method and Description
public Object	getContextInformation(final String key)
public Collection<String>	getContextKeys()
public String	getProtocol()
public String	getSubProtocol()
public Object	removeContextInformation(final String key)
public Object	setContextInformation(final String key, final Object value)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

contextInformation	back to summary
private final Map<String, Object> contextInformation

protocol	back to summary
private final String protocol

subProtocol	back to summary
private final String subProtocol

Constructor Detail

HttpUpgradeMetadata	back to summary
public HttpUpgradeMetadata(final String protocol, final String subProtocol)

Method Detail

getContextInformation	back to summary
public Object getContextInformation(final String key)

getContextKeys	back to summary
public Collection<String> getContextKeys()

getProtocol	back to summary
public String getProtocol()

getSubProtocol	back to summary
public String getSubProtocol()

removeContextInformation	back to summary
public Object removeContextInformation(final String key)

setContextInformation	back to summary
public Object setContextInformation(final String key, final Object value)

io.undertow.server back to summary

public final Class ListenerRegistry.Listener

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.ListenerRegistry.Listener

Field Summary

Modifier and Type	Field and Description
private final InetSocketAddress	bindAddress
private final Map<String, Object>	contextInformation Map that can be used to store additional listener metadata
private final Set<ListenerRegistry.HttpUpgradeMetadata>	httpUpgradeMetadata Information about any HTTP upgrade handlers that are registered on this handler.
private final String	name
private final String	protocol
private final String	serverName

Constructor Summary

Access	Constructor and Description
public	Listener(final String protocol, final String name, final String serverName, final InetSocketAddress bindAddress)

Method Summary

Modifier and Type	Method and Description
public void	addHttpUpgradeMetadata(final ListenerRegistry.HttpUpgradeMetadata upgradeMetadata)
public InetSocketAddress	getBindAddress() The address that this listener is bound to
public Object	getContextInformation(final String key)
public Collection<String>	getContextKeys()
public Set<ListenerRegistry.HttpUpgradeMetadata>	getHttpUpgradeMetadata()
public String	getName() The optional listener name;
public String	getProtocol() The protocol that this listener is using
public String	getServerName() The server name
public Object	removeContextInformation(final String key)
public void	removeHttpUpgradeMetadata(final ListenerRegistry.HttpUpgradeMetadata upgradeMetadata)
public Object	setContextInformation(final String key, final Object value)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bindAddress	back to summary
private final InetSocketAddress bindAddress

contextInformation	back to summary
private final Map<String, Object> contextInformation Map that can be used to store additional listener metadata

httpUpgradeMetadata	back to summary
private final Set<ListenerRegistry.HttpUpgradeMetadata> httpUpgradeMetadata Information about any HTTP upgrade handlers that are registered on this handler.

name	back to summary
private final String name

protocol	back to summary
private final String protocol

serverName	back to summary
private final String serverName

Constructor Detail

Listener	back to summary
public Listener(final String protocol, final String name, final String serverName, final InetSocketAddress bindAddress)

Method Detail

addHttpUpgradeMetadata	back to summary
public void addHttpUpgradeMetadata(final ListenerRegistry.HttpUpgradeMetadata upgradeMetadata)

getBindAddress	back to summary
public InetSocketAddress getBindAddress() The address that this listener is bound to

getContextInformation	back to summary
public Object getContextInformation(final String key)

getContextKeys	back to summary
public Collection<String> getContextKeys()

getHttpUpgradeMetadata	back to summary
public Set<ListenerRegistry.HttpUpgradeMetadata> getHttpUpgradeMetadata()

getName	back to summary
public String getName() The optional listener name;

getProtocol	back to summary
public String getProtocol() The protocol that this listener is using

getServerName	back to summary
public String getServerName() The server name

removeContextInformation	back to summary
public Object removeContextInformation(final String key)

removeHttpUpgradeMetadata	back to summary
public void removeHttpUpgradeMetadata(final ListenerRegistry.HttpUpgradeMetadata upgradeMetadata)

setContextInformation	back to summary
public Object setContextInformation(final String key, final Object value)