Interface DevConsoleRegistry

All Superinterfaces:

AutoCloseable, CamelContextAware, HasCamelContext, HasId, IdAware, Service, StaticService

public interface DevConsoleRegistry
extends CamelContextAware, StaticService, IdAware

A registry for dev console.

Since:

3.15

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FACTORY	Service factory key.
static final String	NAME	Service factory name.

Method Summary

Modifier and Type	Method	Description
static @Nullable DevConsoleRegistry	get(CamelContext context)	Returns an optional DevConsoleRegistry, by default no registry is present, and it must be explicit activated.
default Optional<DevConsole>	getConsole(String id)	Returns the dev console identified by the given id if available.
default Collection<String>	getConsoleIDs()	A collection of dev console IDs.
boolean	isEnabled()	Whether dev console is enabled globally
void	loadDevConsoles()	Loads custom dev consoles by scanning classpath.
void	loadDevConsoles(boolean force)	Loads custom dev consoles by scanning classpath.
boolean	register(DevConsole console)	Registers a DevConsole.
@Nullable DevConsole	resolveById(String id)	Resolves DevConsole by id.
void	setEnabled(boolean enabled)	Whether dev console is enabled globally
Stream<DevConsole>	stream()	Returns a sequential Stream with the known DevConsole as its source.
boolean	unregister(DevConsole console)	Unregisters a DevConsole.

Methods inherited from interface CamelContextAware

setCamelContext

Methods inherited from interface HasCamelContext

getCamelContext

Methods inherited from interface HasId

getId

Methods inherited from interface IdAware

setGeneratedId, setId

Methods inherited from interface Service

build, close, init, start, stop

Field Details

NAME

static final String NAME

Service factory name.

See Also:

• Constant Field Values

FACTORY

static final String FACTORY

Service factory key.

See Also:

• Constant Field Values

Method Details

isEnabled

boolean isEnabled()

Whether dev console is enabled globally

setEnabled

void setEnabled(boolean enabled)

Whether dev console is enabled globally

resolveById

@Nullable DevConsole resolveById(String id)

Resolves DevConsole by id. Will first lookup in this DevConsoleRegistry and then Registry, and lastly do classpath scanning via ServiceFactory.

Returns:

either DevConsole, or null if none found.

register

boolean register(DevConsole console)

Registers a DevConsole.

unregister

boolean unregister(DevConsole console)

Unregisters a DevConsole.

getConsoleIDs

default Collection<String> getConsoleIDs()

A collection of dev console IDs.

getConsole

default Optional<DevConsole> getConsole(String id)

Returns the dev console identified by the given id if available.

get

static @Nullable DevConsoleRegistry get(CamelContext context)

Returns an optional DevConsoleRegistry, by default no registry is present, and it must be explicit activated. Components can register/unregister dev consoles in response to life-cycle events (i.e. start/stop). This registry is not used by the camel context, but it is up to the implementation to properly use it.

stream

Stream<DevConsole> stream()

Returns a sequential Stream with the known DevConsole as its source.

loadDevConsoles

void loadDevConsoles()

Loads custom dev consoles by scanning classpath.

loadDevConsoles

void loadDevConsoles(boolean force)

Loads custom dev consoles by scanning classpath.

Parameters:

force - force re-scanning such as when additional JARs has been added to the classpath that can include custom dev consoles