Package org.jboss.logmanager.config
Interface LogContextConfiguration
- All Known Implementing Classes:
LogContextConfigurationImpl
public interface LogContextConfiguration
A log context configuration.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
The factory class for persistent configurations. -
Method Summary
Modifier and TypeMethodDescriptionaddErrorManagerConfiguration
(String moduleName, String className, String errorManagerName, String... constructorProperties) addFilterConfiguration
(String moduleName, String className, String filterName, String... constructorProperties) addFormatterConfiguration
(String moduleName, String className, String formatterName, String... constructorProperties) addHandlerConfiguration
(String moduleName, String className, String handlerName, String... constructorProperties) Add a handler configuration.addLoggerConfiguration
(String loggerName) addPojoConfiguration
(String moduleName, String className, String pojoName, String... constructorProperties) Add a POJO configuration.void
commit()
Commit the current changes into the running logging configuration.void
forget()
Clear all the current changes and restore this object to its original state.getErrorManagerConfiguration
(String errorManagerName) getFilterConfiguration
(String filterName) getFormatterConfiguration
(String formatterName) getHandlerConfiguration
(String handlerName) Get the log context being configured by this configuration object.getLoggerConfiguration
(String loggerName) getPojoConfiguration
(String pojoName) Gets the POJO configuration.A list of the POJO configuration names.void
prepare()
Prepares the current changes.boolean
removeErrorManagerConfiguration
(String errorManagerName) boolean
removeFilterConfiguration
(String filterName) boolean
removeFormatterConfiguration
(String formatterName) boolean
removeHandlerConfiguration
(String handlerName) Remove a handler configuration.boolean
removeLoggerConfiguration
(String loggerName) boolean
removePojoConfiguration
(String pojoName) Removes the POJO configuration.
-
Method Details
-
getLogContext
LogContext getLogContext()Get the log context being configured by this configuration object.- Returns:
- the log context
-
addLoggerConfiguration
-
removeLoggerConfiguration
-
getLoggerConfiguration
-
getLoggerNames
-
addHandlerConfiguration
HandlerConfiguration addHandlerConfiguration(String moduleName, String className, String handlerName, String... constructorProperties) Add a handler configuration.- Parameters:
moduleName
- the module name, ornull
to use the logmanager's class pathclassName
- the class name of the handler (must not benull
)handlerName
- the name of the handler (must be unique within this configuration and notnull
)constructorProperties
- an optional list of constructor property names- Returns:
- the new handler configuration
-
removeHandlerConfiguration
Remove a handler configuration. Also removes handler from everything it was added to.- Parameters:
handlerName
- the handler name to remove- Returns:
true
if the handler was removed,false
if the handler didn't exist
-
getHandlerConfiguration
-
getHandlerNames
-
addFormatterConfiguration
FormatterConfiguration addFormatterConfiguration(String moduleName, String className, String formatterName, String... constructorProperties) -
removeFormatterConfiguration
-
getFormatterConfiguration
-
getFormatterNames
-
addFilterConfiguration
FilterConfiguration addFilterConfiguration(String moduleName, String className, String filterName, String... constructorProperties) -
removeFilterConfiguration
-
getFilterConfiguration
-
getFilterNames
-
addErrorManagerConfiguration
ErrorManagerConfiguration addErrorManagerConfiguration(String moduleName, String className, String errorManagerName, String... constructorProperties) -
removeErrorManagerConfiguration
-
getErrorManagerConfiguration
-
getErrorManagerNames
-
prepare
void prepare() -
addPojoConfiguration
PojoConfiguration addPojoConfiguration(String moduleName, String className, String pojoName, String... constructorProperties) Add a POJO configuration.- Parameters:
moduleName
- the module name, ornull
to use the logmanager's class pathclassName
- the class name of the POJO (must not benull
)pojoName
- the name of the POJO (must be unique within this configuration and notnull
constructorProperties
- an optional list of constructor property names- Returns:
- the new handler configuration
-
removePojoConfiguration
Removes the POJO configuration.- Parameters:
pojoName
- the name of the POJO- Returns:
true
if the configuration was removed, othwerwisefalse
if the configuration did not exist or was not remove.
-
getPojoConfiguration
Gets the POJO configuration.- Parameters:
pojoName
- the name of the POJO- Returns:
- the POJO configuration if found, otherwise
null
-
getPojoNames
A list of the POJO configuration names.- Returns:
- a list of the names
-
commit
void commit()Commit the current changes into the running logging configuration. -
forget
void forget()Clear all the current changes and restore this object to its original state.
-