fix: null-check AppenderDynamicMBean setLayout instantiation#4219
Open
SebTardif wants to merge 2 commits into
Open
fix: null-check AppenderDynamicMBean setLayout instantiation#4219SebTardif wants to merge 2 commits into
SebTardif wants to merge 2 commits into
Conversation
OptionConverter.instantiateByClassName returns null when the class is missing or not a Layout. setLayout immediately called appender.setLayout and could NPE on invalid JMX setLayout class names. Log an error and skip attach instead. Sibling of the LoggerDynamicMBean.addAppender guard (apache#4185). Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Problem This Solves
AppenderDynamicMBean.invoke("setLayout")callsOptionConverter.instantiateByClassName(..., null)and immediately passes the result toappender.setLayout(...). When the class name is invalid or not aLayout, instantiation returns null and the next line NPEs. Same pattern asLoggerDynamicMBean.addAppender(#4185).Evidence
Failure scenario
Red-green / tests
PatternLayout: layout attachedSibling audit
LoggerDynamicMBean.addAppender: already guarded in fix: null-check LoggerDynamicMBean addAppender instantiation #4185registerLayoutMBean: already null-safeinstantiateByClassName+ immediate dereference inlog4j-1.2-apiJMX packageSummary
Null-check + error log on failed layout instantiation; unit tests + changelog.