Package org.apache.juneau.rest.server.ops

Class AdminMixin.Builder

java.lang.Object

org.apache.juneau.rest.server.ops.AdminMixin.Builder

Enclosing class:

AdminMixin

public static class AdminMixin.Builder
extends Object

Builder for AdminMixin instances.

Mirrors AdminProvider.Builder's configuration methods on the mixin's own surface and forwards each call to an underlying AdminProvider.Builder, which builds the shared worker the mixin delegates to.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor — package access for AdminMixin.create().

Method Summary

Modifier and Type	Method	Description
AdminMixin	build()	Builds an AdminMixin instance.
AdminMixin.Builder	cacheFlush(String name, Runnable hook)	Registers a cache-flush hook under a name.
AdminMixin.Builder	cacheFlushAll(Map<String,Runnable> hooks)	Registers multiple cache-flush hooks at once.
AdminMixin.Builder	threadNamePrefixExclude(String... values)	Replaces the thread-name-prefix exclude list.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor — package access for AdminMixin.create().

Method Details

cacheFlush

public AdminMixin.Builder cacheFlush(String name,
 Runnable hook)

Registers a cache-flush hook under a name.

The hook is invoked synchronously when POST /admin/cache/flush is called (with no names parameter, or with a names parameter that includes this name).

Parameters:

name - The hook name. Must not be null or blank.

hook - The hook. Must not be null.

Returns:

This object.

cacheFlushAll

public AdminMixin.Builder cacheFlushAll(Map<String,Runnable> hooks)

Registers multiple cache-flush hooks at once.

Parameters:

hooks - The hooks, keyed by registration name. Can be null (no-op).

Returns:

This object.

threadNamePrefixExclude

public AdminMixin.Builder threadNamePrefixExclude(String... values)

Replaces the thread-name-prefix exclude list.

Threads whose name starts with any of the supplied prefixes are omitted from the /admin/threads output. Pass an empty array to disable filtering entirely.

Parameters:

values - The thread-name prefixes to exclude. Can be null (equivalent to an empty array — disables filtering); null or empty elements are skipped.

Returns:

This object.

build

public AdminMixin build()

Builds an AdminMixin instance.

Returns:

A configured instance.