<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
<base href="https://issues.shibboleth.net/jira">
<title>Message Title</title>
</head>
<body class="jira" style="color: #333333; font-family: Arial, sans-serif; font-size: 14px; line-height: 1.429">
<table id="background-table" cellpadding="0" cellspacing="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5; border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt" bgcolor="#f5f5f5">
<!-- header here -->
<tbody>
<tr>
<td id="header-pattern-container" style="padding: 0px; border-collapse: collapse; padding: 10px 20px">
<table id="header-pattern" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="header-avatar-image-container" valign="top" style="padding: 0px; border-collapse: collapse; vertical-align: top; width: 32px; padding-right: 8px" width="32"> <img id="header-avatar-image" class="image_fix" src="cid:jira-generated-image-avatar-367fdc1f-36ba-48a5-af51-afdd5dd676bc" height="32" width="32" border="0" style="border-radius: 3px; vertical-align: top"> </td>
<td id="header-text-container" valign="middle" style="padding: 0px; border-collapse: collapse; vertical-align: middle; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px"> <a class="user-hover" rel="rdw@iay.org.uk" id="email_rdw@iay.org.uk" href="https://issues.shibboleth.net/jira/secure/ViewProfile.jspa?name=rdw%40iay.org.uk" style="color:#0052cc;; color: #3b73af; text-decoration: none">Rod Widdowson</a> <strong>commented</strong> on <a href="https://issues.shibboleth.net/jira/browse/IDP-1470" style="color: #3b73af; text-decoration: none"><img src="cid:jira-generated-image-avatar-8b089718-0bbf-4a92-9c7e-81cb25050a27" height="16" width="16" border="0" align="absmiddle" alt="Bug"> IDP-1470</a> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="email-content-container" style="padding: 0px; border-collapse: collapse; padding: 0 20px">
<table id="email-content-table" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-spacing: 0; border-collapse: separate">
<tbody>
<tr>
<!-- there needs to be content in the cell for it to render in some clients -->
<td class="email-content-rounded-top mobile-expand" style="padding: 0px; border-collapse: collapse; color: #ffffff; padding: 0 15px 0 16px; height: 15px; background-color: #ffffff; border-left: 1px solid #cccccc; border-top: 1px solid #cccccc; border-right: 1px solid #cccccc; border-bottom: 0; border-top-right-radius: 5px; border-top-left-radius: 5px; height: 10px; line-height: 10px; padding: 0 15px 0 16px; mso-line-height-rule: exactly" height="10" bgcolor="#ffffff"> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand " style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff" bgcolor="#ffffff">
<table class="page-title-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td style="vertical-align: top;; padding: 0px; border-collapse: collapse; padding-right: 5px; font-size: 20px; line-height: 30px; mso-line-height-rule: exactly" class="page-title-pattern-header-container"> <span class="page-title-pattern-header" style="font-family: Arial, sans-serif; padding: 0; font-size: 20px; line-height: 30px; mso-text-raise: 2px; mso-line-height-rule: exactly; vertical-align: middle"> <a href="https://issues.shibboleth.net/jira/browse/IDP-1470" style="color: #3b73af; text-decoration: none">Re: Custom Parsers appear to be provoking multiple Bean creation</a> </span> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="text-paragraph-pattern-top" class="email-content-main mobile-expand comment-top-pattern" style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff; border-bottom: none; padding-bottom: 0" bgcolor="#ffffff">
<table class="text-paragraph-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 2px">
<tbody>
<tr>
<td class="text-paragraph-pattern-container mobile-resize-text " style="padding: 0px; border-collapse: collapse; padding: 0 0 10px 0"> <p style="margin: 10px 0 0 0; margin-top: 0">I've sort of bottomed this out by code skimming and I think that it is a day 1 bug.</p> <p style="margin: 10px 0 0 0">The bottom line appears to be that many of the beans defined by mane of the custom parsers are a bit ambivalent about their child status.</p> <p style="margin: 10px 0 0 0">If you consider the case I was looking at</p>
<div class="code panel" style="border-width: 1px;; border: 1px solid #cccccc; background: #f5f5f5; font-size: 12px; line-height: 1.333; font-family: monospace; border: 1px solid #cccccc; -moz-border-radius: 3px 3px 3px 3px; border-radius: 3px 3px 3px 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
<AttributeDefinition xsi:type=<span class="code-quote" style="color: #009100">"Mapped"</span>>
<ValueMap>
<ReturnValue><span class="code-keyword" style="color: #000091">return</span></ReturnValue>
<SourceValue caseSensitive=<span class="code-quote" style="color: #009100">" "</span> partialMatch=<span class="code-quote" style="color: #009100">"<span class="code-keyword" style="color: #000091; color: #009100">true</span>"</span>>sourceValueAttributes1</SourceValue>
</ValueMap>
</AttributeDefinition>
</pre>
</div>
</div> <p style="margin: 10px 0 0 0">The Attribute Definition definitely has a child ValueMap and the ValueMap has a child SourceValue.</p> <p style="margin: 10px 0 0 0">This means that when the Attribute Definition is summoned up Spring will recursively descend into Value Map and thence SourceValue to create it.</p> <p style="margin: 10px 0 0 0"><b>BUT</b> Both SourceValue and ValueMap are also known by name in the top level context. So when the context refreshes an AttributeDefintion, a ValueMap, & SourceValue are created. As Attribute Map is created a new ValueMap is created (so we get two of them in total). As each ValueMap is created a SourceValue is created (making three SourceValues in total - one for each layer of nesting).</p> <p style="margin: 10px 0 0 0">The native bean equivalent would be to have the source value appearing (via some twist in the time-space fabric) both as a direct child of the ValueMap but also as a bean of its own.</p> <p style="margin: 10px 0 0 0">Because the key method has zero documentation, I looked at the dynamics of the native parser in the two cases (child beans and reference + external beans) and I determined empirically that the problem lies in our SpringSupport functions which return a BeanDefinition (suitable for injecting as a child), but which <b>also</b> put the bean into the parser context.</p> <p style="margin: 10px 0 0 0">If I change (for example) the ValueMap parse from</p>
<div class="code panel" style="border-width: 1px;; border: 1px solid #cccccc; background: #f5f5f5; font-size: 12px; line-height: 1.333; font-family: monospace; border: 1px solid #cccccc; -moz-border-radius: 3px 3px 3px 3px; border-radius: 3px 3px 3px 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
<span class="code-keyword" style="color: #000091">final</span> ManagedList<BeanDefinition> sourceValues = SpringSupport.parseCustomElements(sourceValueElements, parserContext);
builder.addPropertyValue(<span class="code-quote" style="color: #009100">"sourceValues"</span>, sourceValues);
</pre>
</div>
</div> <p style="margin: 10px 0 0 0">to</p>
<div class="code panel" style="border-width: 1px;; border: 1px solid #cccccc; background: #f5f5f5; font-size: 12px; line-height: 1.333; font-family: monospace; border: 1px solid #cccccc; -moz-border-radius: 3px 3px 3px 3px; border-radius: 3px 3px 3px 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
<span class="code-keyword" style="color: #000091">final</span> ManagedList<BeanDefinition> sourceValues = SpringSupport.parseCustomElements(sourceValueElements, parserContext, builder);
builder.addPropertyValue(<span class="code-quote" style="color: #009100">"sourceValues"</span>, sourceValues);
</pre>
</div>
</div> <p style="margin: 10px 0 0 0">Where the new version of parseCustomElements ends up calling</p>
<div class="code panel" style="border-width: 1px;; border: 1px solid #cccccc; background: #f5f5f5; font-size: 12px; line-height: 1.333; font-family: monospace; border: 1px solid #cccccc; -moz-border-radius: 3px 3px 3px 3px; border-radius: 3px 3px 3px 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
@Nullable <span class="code-keyword" style="color: #000091">public</span> <span class="code-keyword" style="color: #000091">static</span> BeanDefinition parseCustomElement(@Nullable <span class="code-keyword" style="color: #000091">final</span> Element element,
@Nonnull <span class="code-keyword" style="color: #000091">final</span> ParserContext parserContext, <span class="code-keyword" style="color: #000091">final</span> BeanDefinitionBuilder parentBuilder) {
<span class="code-keyword" style="color: #000091">if</span> (element == <span class="code-keyword" style="color: #000091">null</span>) {
<span class="code-keyword" style="color: #000091">return</span> <span class="code-keyword" style="color: #000091">null</span>;
}
<span class="code-keyword" style="color: #000091">return</span> parserContext.getDelegate().parseCustomElement(element, parentBuilder.getRawBeanDefinition());
}
</pre>
</div>
</div> <p style="margin: 10px 0 0 0">(Which is to say call the version of the undocumented <tt>org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.parseCustomElement</tt> with a non null <tt>BeanDefinition containingBd</tt>.)</p> <p style="margin: 10px 0 0 0">Then "the right thing happens"</p> <p style="margin: 10px 0 0 0">"The Right thing" is a two edged sword:</p>
<ul>
<li>The constructor is only called once but</li>
<li>The SourceValue is now not directly visible in the application context at the end - you need to navigate down to it from the AttibuteDefinition. This is <b>only</b> important in the tests, many of which assume that everything will be available in the application context at the end.</li>
</ul> <p style="margin: 10px 0 0 0">I think it is pretty important to fix this, particularly when one realizes that beans are not only summoned up, but also initialized - so if this should hit a heavyweight bean (like a metadata resolver) things could get pretty mucky - indeed I am not sure why that is not already the case. But even if that doesn't happen, I need to be able to add logging to the setters for <a href="https://issues.shibboleth.net/jira/browse/IDP-1450" title="Tighten up null attributes in our custom schema" class="issue-link" data-issue-key="IDP-1450" style="color: #3b73af; text-decoration: none">IDP-1450</a> and as thing currently stand one risks getting the warning in triplicate.</p> <p style="margin: 10px 0 0 0">The code change will involve a bit of a rototill in SpringSupport - the variant with three parameters has to return a value and the variant with two shouldn't = this so we don't accidentally reintroduce this bug. Otherwise it is 'just' a matter of 'just' writing the code and fixing the tests.</p> <p style="margin: 10px 0 0 0">For completeness I should mention that there is a potential for this to break existing configurations, but it would rely on someone thinking very hard about spring wiring (and also getting quite lucky). Something like this</p>
<div class="code panel" style="border-width: 1px;; border: 1px solid #cccccc; background: #f5f5f5; font-size: 12px; line-height: 1.333; font-family: monospace; border: 1px solid #cccccc; -moz-border-radius: 3px 3px 3px 3px; border-radius: 3px 3px 3px 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
<Outer>
<Parent>
<Child Id=<span class="code-quote" style="color: #009100">"foo"</span> .../>
<Parent/>
<Parent childRef=<span class="code-quote" style="color: #009100">"foo"</span> />
</Outer>
</pre>
</div>
</div> <p style="margin: 10px 0 0 0">Won't work any more (because "foo" won't be visible). But we never documented that this was even possible, and I cannot imagine anyone thinking that it might be. So I can live with that.</p> <p style="margin: 10px 0 0 0">Unless anyone demurs I'll get on to this next week.</p> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand " style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff" bgcolor="#ffffff">
<table id="actions-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px">
<tbody>
<tr>
<td id="actions-pattern-container" valign="middle" style="padding: 0px; border-collapse: collapse; padding: 10px 0 10px 24px; vertical-align: middle; padding-left: 0">
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 0; vertical-align: middle"> <a href="https://issues.shibboleth.net/jira/browse/IDP-1470#add-comment" target="_blank" title="Add Comment" style="color: #3b73af; text-decoration: none"> <img class="actions-pattern-action-icon-image" src="cid:jira-generated-image-static-comment-icon-f09c1cba-95cb-4d96-90d5-fcd920516253" alt="Add Comment" title="Add Comment" height="16" width="16" border="0" style="vertical-align: middle"> </a> </td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 4px; padding-left: 5px"> <a href="https://issues.shibboleth.net/jira/browse/IDP-1470#add-comment" target="_blank" title="Add Comment" style="color: #3b73af; text-decoration: none">Add Comment</a> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table> </td>
</tr>
<!-- there needs to be content in the cell for it to render in some clients -->
<tr>
<td class="email-content-rounded-bottom mobile-expand" style="padding: 0px; border-collapse: collapse; color: #ffffff; padding: 0 15px 0 16px; height: 5px; line-height: 5px; background-color: #ffffff; border-top: 0; border-left: 1px solid #cccccc; border-bottom: 1px solid #cccccc; border-right: 1px solid #cccccc; border-bottom-right-radius: 5px; border-bottom-left-radius: 5px; mso-line-height-rule: exactly" height="5" bgcolor="#ffffff"> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="footer-pattern" style="padding: 0px; border-collapse: collapse; padding: 12px 20px">
<table id="footer-pattern-container" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="footer-pattern-text" class="mobile-resize-text" width="100%" style="padding: 0px; border-collapse: collapse; color: #999999; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule: exactly; mso-text-raise: 2px"> This message was sent by Atlassian Jira <span id="footer-build-information">(v7.12.2#712003-<span title="61a922d5458c2b34faa51a4f8074da7e37e442eb" data-commit-id="61a922d5458c2b34faa51a4f8074da7e37e442eb}">sha1:61a922d</span>)</span> </td>
<td id="footer-pattern-logo-desktop-container" valign="top" style="padding: 0px; border-collapse: collapse; padding-left: 20px; vertical-align: top">
<table style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="footer-pattern-logo-desktop-padding" style="padding: 0px; border-collapse: collapse; padding-top: 3px"> <img id="footer-pattern-logo-desktop" src="https://issues.shibboleth.net/jira/images/mail/atlassian-email-logo.png" alt="Atlassian logo" title="Atlassian logo" width="191" height="24" class="image_fix"> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table>
</body>
</html>