Package org.eclipse.jetty.util.component

Interface Dumpable

All Known Subinterfaces:

Dumpable.DumpableContainer

All Known Implementing Classes:

AbstractConnectionFactory, AbstractConnectionPool, AbstractConnector, AbstractConnectorHttpClientTransport, AbstractConnectorHttpClientTransport.ClientSelectorManager, AbstractFlowControlStrategy, AbstractHandler, AbstractHandler.ErrorDispatchHandler, AbstractHandlerContainer, AbstractHTTP2ServerConnectionFactory, AbstractHTTP2ServerConnectionFactory.HTTP2SessionContainer, AbstractHttpClientTransport, AbstractLoginService, AbstractNCSARequestLog, AbstractNetworkConnector, AbstractSessionCache, AbstractSessionDataStore, AbstractWebSocketConnection, ALPNServerConnectionFactory, AntWebAppContext, AntWebAppContext.AntServletHandler, AntWebAppContext.AntServletHolder, ArrayByteBufferPool, AsyncDelayHandler, AsyncNCSARequestLog, AttributeContainerMap, AttributesMap, BaseHolder, BufferedResponseHandler, BufferingFlowControlStrategy, CachingSessionDataStore, ClassLoaderDump, ClientContainer, ConfigurableSpnegoLoginService, ConnectHandler, ConnectHandler.ConnectManager, ConnectionManager, ConnectionStatistics, ConnectionStatistics.Stats, ConnectorStatistics, ConstraintSecurityHandler, ContainerLifeCycle, ContextHandler, ContextHandler.Context, ContextHandler.StaticContext, ContextHandlerCollection, CustomRequestLog, DataSourceLoginService, DebugHandler, DefaultHandler, DefaultSessionCache, DefaultSessionIdManager, DelegatingThreadPool, DeploymentManager, DetectorConnectionFactory, DumpableCollection, DuplexConnectionPool, EatWhatYouKill, ErrorHandler, ErrorPageErrorHandler, ExecutorSizedThreadPool, ExecutorThreadPool, ExtensionStack, FileBufferedResponseHandler, FileSessionDataStore, FilterHolder, FilterMapping, GCloudSessionDataStore, GzipHandler, HandlerCollection, HandlerList, HandlerWrapper, HashLoginService, HazelcastSessionDataStore, HelloHandler, HelloWorld, Holder, HotSwapHandler, HTTP2Client, HTTP2ClientSession, HTTP2CServerConnectionFactory, HTTP2Flusher, HTTP2ServerConnectionFactory, HTTP2ServerSession, HTTP2Session, HTTP2Stream, HttpClient, HttpClientTransportOverFCGI, HttpClientTransportOverHTTP, HttpClientTransportOverHTTP2, HttpClientTransportOverUnixSockets, HttpClientTransportOverUnixSockets.UnixSocketSelectorManager, HttpConfiguration, HttpConnectionFactory, HttpConversation, HttpDestination, HttpDestinationOverFCGI, HttpDestinationOverHTTP, HttpDestinationOverHTTP2, HttpServiceErrorPageErrorHandler, HttpSpiContextHandler, IdleTimeoutHandler, IncludeExcludeConnectionStatistics, InetAccessHandler, InfinispanSessionDataStore, IPAccessHandler, JAASLoginService, JDBCLoginService, JDBCSessionDataStore, JettyWebAppContext, JsrSession, JsrSessionTracker, KeyStoreScanner, LeakTrackingByteBufferPool, LeakTrackingConnectionPool, ListenerHolder, LocalConnector, LogarithmicArrayByteBufferPool, LowResourceMonitor, ManagedSelector, ManyHandlers.ParamHandler, ManyHandlers.WelcomeWrapHandler, MappedByteBufferPool, MappedByteBufferPool.Tagged, MavenServerConnector, MBeanContainer, MongoSessionDataStore, MonitoredQueuedThreadPool, MovedContextHandler, MultiplexConnectionPool, MultiplexHttpDestination, MultiplexHttpDestinationOverFCGI, NamingContext, NamingDump, NativeWebSocketConfiguration, NCSARequestLog, NegotiatingServerConnectionFactory, NetworkTrafficSelectChannelConnector, NetworkTrafficServerConnector, NoSqlSessionDataStore, NullSessionCache, NullSessionDataStore, OpenIdConfiguration, OpenIdLoginService, OptionalSslConnectionFactory, PathMappings, Pool, PoolingHttpDestination, ProtocolHandlers, ProxyConnectionFactory, ProxyConnectionFactory.ProxyEndPoint, QueuedThreadPool, QuickStartWebApp, RandomConnectionPool, RawHTTP2ServerConnectionFactory, RequestLogHandler, ReservedThreadExecutor, ResourceHandler, RewriteCustomizer, RewriteHandler, RoundRobinConnectionPool, RuleContainer, ScheduledExecutorScheduler, ScopedHandler, SecuredRedirectHandler, SecurityHandler, SelectorManager, Server, ServerConnectionStatistics, ServerConnector, ServerConnector.ServerConnectorManager, ServerContainer, ServerFCGIConnectionFactory, ServletContextHandler, ServletContextHandler.Context, ServletHandler, ServletHolder, SessionHandler, SessionTracker, ShutdownHandler, SimpleContainerScope, SimpleFlowControlStrategy, SizeLimitHandler, Slf4jRequestLog, SslConnectionFactory, SslContextFactory, SslContextFactory.Client, SslContextFactory.Server, StatisticsHandler, ThreadLimitHandler, UnixSocketConnector, UnixSocketConnector.UnixSocketConnectorManager, ValidatingConnectionPool, VirtualHostRuleContainer, WebAppContext, WebAppContext.Context, WebSocketClient, WebSocketClientConnection, WebSocketExtensionFactory, WebSocketHandler, WebSocketHandler.Simple, WebSocketServerConnection, WebSocketServerFactory, WebSocketSession, WebSocketUpgradeFilter, WebSocketUpgradeHandlerWrapper

@ManagedObject("Dumpable Object")
public interface Dumpable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Dumpable.DumpableContainer	DumpableContainer A Dumpable that is a container of beans can implement this interface to allow it to refine which of its beans can be dumped.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	KEY

Method Summary

Modifier and Type	Method	Description
default java.lang.String	dump()
void	dump(java.lang.Appendable out, java.lang.String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
static java.lang.String	dump(Dumpable dumpable)	Utility method to implement dump() by calling dump(Appendable, String)
static void	dumpContainer(java.lang.Appendable out, java.lang.String indent, Container object, boolean last)
static void	dumpIterable(java.lang.Appendable out, java.lang.String indent, java.lang.Iterable<?> iterable, boolean last)
static void	dumpMapEntries(java.lang.Appendable out, java.lang.String indent, java.util.Map<?,?> map, boolean last)
static void	dumpObject(java.lang.Appendable out, java.lang.Object o)	Dump just an Object (but not it's contained items) to an Appendable.
static void	dumpObjects(java.lang.Appendable out, java.lang.String indent, java.lang.Object object, java.lang.Object... extraChildren)	Dump an Object, it's contained items and additional items to an Appendable.
default java.lang.String	dumpSelf()	The description of this/self found in the dump.
static Dumpable	named(java.lang.String name, java.lang.Object object)

Field Detail

KEY

static final java.lang.String KEY

See Also:

Constant Field Values

Method Detail

dump

@ManagedOperation(value="Dump the nested Object state as a String",
                  impact="INFO")
default java.lang.String dump()

dump

void dump(java.lang.Appendable out,
          java.lang.String indent)
   throws java.io.IOException

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

java.io.IOException - if unable to write to Appendable

dump

static java.lang.String dump(Dumpable dumpable)

Utility method to implement dump() by calling dump(Appendable, String)

Parameters:

dumpable - The dumpable to dump

Returns:

The dumped string

dumpSelf

default java.lang.String dumpSelf()

The description of this/self found in the dump. Allows for alternative representation of Object other then .toString() where the long form output of toString() is represented in a cleaner way within the dump infrastructure.

Returns:

the representation of self

dumpObject

static void dumpObject(java.lang.Appendable out,
                       java.lang.Object o)
                throws java.io.IOException

Dump just an Object (but not it's contained items) to an Appendable.

Parameters:

out - The Appendable to dump to

o - The object to dump.

Throws:

java.io.IOException - May be thrown by the Appendable

dumpObjects

static void dumpObjects(java.lang.Appendable out,
                        java.lang.String indent,
                        java.lang.Object object,
                        java.lang.Object... extraChildren)
                 throws java.io.IOException

Dump an Object, it's contained items and additional items to an Appendable. If the object in an Iterable or an Array, then its contained items are also dumped.

Parameters:

out - the Appendable to dump to

indent - The indent to apply after any new lines

object - The object to dump. If the object is an instance of Container, Stream, Iterable, Array or Map, then children of the object a recursively dumped.

extraChildren - Items to be dumped as children of the object, in addition to any discovered children of object

Throws:

java.io.IOException - May be thrown by the Appendable

dumpContainer

static void dumpContainer(java.lang.Appendable out,
                          java.lang.String indent,
                          Container object,
                          boolean last)
                   throws java.io.IOException

Throws:

java.io.IOException

dumpIterable

static void dumpIterable(java.lang.Appendable out,
                         java.lang.String indent,
                         java.lang.Iterable<?> iterable,
                         boolean last)
                  throws java.io.IOException

Throws:

java.io.IOException

dumpMapEntries

static void dumpMapEntries(java.lang.Appendable out,
                           java.lang.String indent,
                           java.util.Map<?,?> map,
                           boolean last)
                    throws java.io.IOException

Throws:

java.io.IOException

named

static Dumpable named(java.lang.String name,
                      java.lang.Object object)