Package org.apache.camel.console
Interface DevConsoleRegistry
- All Superinterfaces:
AutoCloseable
,CamelContextAware
,HasCamelContext
,HasId
,IdAware
,Service
,StaticService
A registry for dev console.
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DevConsoleRegistry
get
(CamelContext context) Returns an optionalDevConsoleRegistry
, 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 givenid
if available.default Collection<String>
A collection of dev console IDs.boolean
Whether dev console is enabled globallyvoid
Loads custom dev consoles by scanning classpath.void
loadDevConsoles
(boolean force) Loads custom dev consoles by scanning classpath.boolean
register
(DevConsole console) Registers aDevConsole
.resolveById
(String id) ResolvesDevConsole
by id.void
setEnabled
(boolean enabled) Whether dev console is enabled globallystream()
Returns a sequentialStream
with the knownDevConsole
as its source.boolean
unregister
(DevConsole console) Unregisters aDevConsole
.Methods inherited from interface org.apache.camel.CamelContextAware
setCamelContext
Methods inherited from interface org.apache.camel.spi.HasCamelContext
getCamelContext
Methods inherited from interface org.apache.camel.spi.IdAware
setGeneratedId, setId
-
Field Details
-
NAME
Service factory name.- See Also:
-
FACTORY
Service factory key.- See Also:
-
-
Method Details
-
isEnabled
boolean isEnabled()Whether dev console is enabled globally -
setEnabled
void setEnabled(boolean enabled) Whether dev console is enabled globally -
resolveById
ResolvesDevConsole
by id. Will first lookup in thisDevConsoleRegistry
and thenRegistry
, and lastly do classpath scanning viaServiceFactory
.- Returns:
- either
DevConsole
, or null if none found.
-
register
Registers aDevConsole
. -
unregister
Unregisters aDevConsole
. -
getConsoleIDs
A collection of dev console IDs. -
getConsole
Returns the dev console identified by the givenid
if available. -
get
Returns an optionalDevConsoleRegistry
, 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 sequentialStream
with the knownDevConsole
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
-