<!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://hibernate.atlassian.net">
<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: 0; mso-table-rspace: 0; background-color: #f5f5f5; border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0" bgcolor="#f5f5f5">
<!-- header here -->
<tbody>
<tr>
<td id="header-pattern-container" style="padding: 0; border-collapse: collapse; padding: 10px 20px">
<table id="header-pattern" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td id="header-avatar-image-container" valign="top" style="padding: 0; border-collapse: collapse; vertical-align: top; width: 32px; padding-right: 8px" width="32"> <img id="header-avatar-image" class="image_fix" src="https://avatar-cdn.atlassian.com/7e8682ce098fb7337d91e01bd5768adf?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F7e8682ce098fb7337d91e01bd5768adf%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" height="32" width="32" border="0" style="border-radius: 3px; vertical-align: top"> </td>
<td id="header-text-container" valign="middle" style="padding: 0; 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="rburgst" id="email_rburgst" href="https://hibernate.atlassian.net/secure/ViewProfile.jspa?name=rburgst" style="color:#6c797f;; color: #3b73af; text-decoration: none">Rainer Burgstaller</a> <strong>created</strong> an issue </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="email-content-container" style="padding: 0; 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: 0; mso-table-rspace: 0; 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: 0; 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: 0; 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: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td class="page-title-pattern-first-line " style="padding: 0; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; padding-top: 10px"> <a href="https://hibernate.atlassian.net/browse/HSEARCH" style="color: #3b73af; text-decoration: none">Hibernate Search</a> / <a href="https://hibernate.atlassian.net/browse/HSEARCH-2899" style="color: #3b73af; text-decoration: none"><img src="cid:jira-generated-image-avatar-e7450205-0baa-406b-b52c-ba0d8a4f1e97" height="16" width="16" border="0" align="absmiddle" alt="Bug" style="vertical-align: text-bottom"></a> <a href="https://hibernate.atlassian.net/browse/HSEARCH-2899" style="color: #3b73af; text-decoration: none">HSEARCH-2899</a> </td>
</tr>
<tr>
<td style="vertical-align: top;; padding: 0; 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://hibernate.atlassian.net/browse/HSEARCH-2899" style="color: #3b73af; text-decoration: none">AbstractJMSHibernateSearchController makes it very difficult to perform proper Session cleanup</a> </span> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand wrapper-special-margin" style="padding: 0; 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; padding-top: 10px; padding-bottom: 5px" bgcolor="#ffffff">
<table class="keyvalue-table" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<th style="color: #707070; font: normal 14px/20px Arial, sans-serif; text-align: left; vertical-align: top; padding: 2px 0">Issue Type:</th>
<td class="has-icon" style="padding: 0; border-collapse: collapse; font: normal 14px/20px Arial, sans-serif; padding: 2px 0 2px 5px; vertical-align: top"> <img src="cid:jira-generated-image-avatar-e7450205-0baa-406b-b52c-ba0d8a4f1e97" height="16" width="16" border="0" align="absmiddle" alt="Bug" style="vertical-align: text-bottom"> Bug </td>
</tr>
<tr>
<th style="color: #707070; font: normal 14px/20px Arial, sans-serif; text-align: left; vertical-align: top; padding: 2px 0">Affects Versions:</th>
<td style="padding: 0; border-collapse: collapse; font: normal 14px/20px Arial, sans-serif; padding: 2px 0 2px 5px; vertical-align: top"> 5.7.2.Final </td>
</tr>
<tr>
<th style="color: #707070; font: normal 14px/20px Arial, sans-serif; text-align: left; vertical-align: top; padding: 2px 0">Assignee:</th>
<td style="padding: 0; border-collapse: collapse; font: normal 14px/20px Arial, sans-serif; padding: 2px 0 2px 5px; vertical-align: top"> Unassigned </td>
</tr>
<tr>
<th style="color: #707070; font: normal 14px/20px Arial, sans-serif; text-align: left; vertical-align: top; padding: 2px 0">Created:</th>
<td style="padding: 0; border-collapse: collapse; font: normal 14px/20px Arial, sans-serif; padding: 2px 0 2px 5px; vertical-align: top"> 28/Sep/2017 06:11 AM </td>
</tr>
<tr>
<th style="color: #707070; font: normal 14px/20px Arial, sans-serif; text-align: left; vertical-align: top; padding: 2px 0">Priority:</th>
<td class="has-icon" style="padding: 0; border-collapse: collapse; font: normal 14px/20px Arial, sans-serif; padding: 2px 0 2px 5px; vertical-align: top"> <img src="cid:jira-generated-image-static-major-3e067089-660c-433b-827d-946c6c765261" height="16" width="16" border="0" align="absmiddle" alt="Major" style="vertical-align: text-bottom"> Major </td>
</tr>
<tr>
<th style="color: #707070; font: normal 14px/20px Arial, sans-serif; text-align: left; vertical-align: top; padding: 2px 0">Reporter:</th>
<td style="padding: 0; border-collapse: collapse; font: normal 14px/20px Arial, sans-serif; padding: 2px 0 2px 5px; vertical-align: top"> <a class="user-hover" rel="rburgst" id="email_rburgst" href="https://hibernate.atlassian.net/secure/ViewProfile.jspa?name=rburgst" style="color:#6c797f;; color: #3b73af; text-decoration: none">Rainer Burgstaller</a> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand issue-description-container" style="padding: 0; 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; padding-top: 5px; padding-bottom: 10px" bgcolor="#ffffff">
<table class="text-paragraph-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0; 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: 0; border-collapse: collapse; padding: 0 0 10px"> <p style="margin-top:0;margin-bottom:10px;; margin: 10px 0 0; margin-top: 0">The change <span class="jira-issue-macro resolved" data-jira-key="HSEARCH-1618">
<!-- replace the span with an AUI template --> <a href="https://hibernate.atlassian.net/browse/HSEARCH-1618" class="jira-issue-macro-key issue-link" title="AbstractJMSHibernateSearchController should not be limited to ORM users" style="color: #3b73af; text-decoration: none"> <img class="icon" src="https://hibernate.atlassian.net/secure/viewavatar?size=xsmall&avatarId=12150&avatarType=issuetype"> HSEARCH-1618 </a> <span class="aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf" style="background: #cccccc; border: 1px solid #cccccc; border-radius: 3px; color: #333333; display: inline-block; font-size: 11px; font-weight: bold; line-height: 99%; margin: 0; padding: 2px 5px; text-align: center; text-decoration: none; text-transform: uppercase; background-color: #ffffff; border-color: #cccccc; color: #333333" bgcolor="#ffffff">Closed</span> </span> forces the subclasser to jump through hoops in order to perform proper hibernate session cleanup.</p> <p style="margin-top:0;margin-bottom:10px;; margin: 10px 0 0">A typical subclass using Plain Hibernate ORM would look similar to 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; border-radius: 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
<span class="code-keyword" style="color: #000091">public</span> <span class="code-keyword" style="color: #000091">class </span>AMQJmsSearchController <span class="code-keyword" style="color: #000091">extends</span> AbstractJMSHibernateSearchController
{
<span class="code-keyword" style="color: #000091">private</span> <span class="code-keyword" style="color: #000091">static</span> <span class="code-keyword" style="color: #000091">final</span> Logger logger = LoggerFactory.getLogger(AMQJmsSearchController.class);
<span class="code-keyword" style="color: #000091">private</span> SessionFactory sessionFactory;
<span class="code-keyword" style="color: #000091">private</span> <span class="code-keyword" style="color: #000091">volatile</span> Session session;
<span class="code-keyword" style="color: #000091">public</span> SessionFactory getSessionFactory() {
<span class="code-keyword" style="color: #000091">return</span> sessionFactory;
}
@Required
<span class="code-keyword" style="color: #000091">public</span> void setSessionFactory(SessionFactory sessionFactory) {
<span class="code-keyword" style="color: #000091">this</span>.sessionFactory = sessionFactory;
}
@Override
<span class="code-keyword" style="color: #000091">protected</span> void afterMessage() {
Session tempSession = session;
session = <span class="code-keyword" style="color: #000091">null</span>;
<span class="code-keyword" style="color: #000091">if</span> ( tempSession != <span class="code-keyword" style="color: #000091">null</span> && tempSession.isOpen()) {
tempSession.close();
}
}
@Override
<span class="code-keyword" style="color: #000091">protected</span> SearchIntegrator getSearchIntegrator() {
<span class="code-comment" style="color: #808080">// http://stackoverflow.com/questions/28206502/access-directory-in-hibernate-search-5/28232872#28232872
</span> <span class="code-comment" style="color: #808080">// https://forum.hibernate.org/viewtopic.php?f=9&t=1039407&start=15
</span> session = sessionFactory.openSession();
<span class="code-keyword" style="color: #000091">final</span> FullTextSession fullTextSession = Search.getFullTextSession(session);
SearchIntegrator searchIntegrator = fullTextSession.getSearchFactory().unwrap(SearchIntegrator.class);
<span class="code-keyword" style="color: #000091">return</span> searchIntegrator;
}
}
</pre>
</div>
</div> <p style="margin-top:0;margin-bottom:10px;; margin: 10px 0 0">However this implementation has multiple problems.</p> <p style="margin-top:0;margin-bottom:10px;; margin: 10px 0 0">1. <tt>AbstractJMSHibernateSearchController.onMessage</tt> calls <tt>getSearchIntegrator()</tt> 2x (needlessly)</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; border-radius: 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
<span class="code-keyword" style="color: #000091">public</span> void onMessage(Message message) {
<span class="code-keyword" style="color: #000091">if</span> ( !( message <span class="code-keyword" style="color: #000091">instanceof</span> ObjectMessage ) ) {
log.incorrectMessageType( message.getClass() );
<span class="code-keyword" style="color: #000091">return</span>;
}
<span class="code-keyword" style="color: #000091">final</span> ObjectMessage objectMessage = (ObjectMessage) message;
<span class="code-keyword" style="color: #000091">final</span> <span class="code-object" style="color: #910091">String</span> indexName;
<span class="code-keyword" style="color: #000091">final</span> List<LuceneWork> queue;
<span class="code-keyword" style="color: #000091">final</span> IndexManager indexManager;
SearchIntegrator integrator = getSearchIntegrator();
<span class="code-keyword" style="color: #000091">try</span> {
indexName = extractIndexName( objectMessage );
<span class="code-keyword" style="color: #000091">if</span> ( log.isDebugEnabled() ) {
logMessageDetails( objectMessage, indexName );
}
indexManager = integrator.getIndexManager( indexName );
<span class="code-keyword" style="color: #000091">if</span> ( indexManager == <span class="code-keyword" style="color: #000091">null</span> ) {
log.messageReceivedForUndefinedIndex( indexName );
<span class="code-keyword" style="color: #000091">return</span>;
}
queue = getSearchIntegrator().getWorkSerializer().toLuceneWorks( (<span class="code-object" style="color: #910091">byte</span>[]) objectMessage.getObject() );
indexManager.performOperations( queue, <span class="code-keyword" style="color: #000091">null</span> );
}
<span class="code-keyword" style="color: #000091">catch</span> (JMSException e) {
log.unableToRetrieveObjectFromMessage( message.getClass(), e );
<span class="code-keyword" style="color: #000091">return</span>;
}
<span class="code-keyword" style="color: #000091">catch</span> (ClassCastException e) {
log.illegalObjectRetrievedFromMessage( e );
<span class="code-keyword" style="color: #000091">return</span>;
}
<span class="code-keyword" style="color: #000091">finally</span> {
afterMessage();
}
}
</pre>
</div>
</div> <p style="margin-top:0;margin-bottom:10px;; margin: 10px 0 0">This will cause the current subclass to leak 1 Hibernate session per message.</p> <p style="margin-top:0;margin-bottom:10px;; margin: 10px 0 0">2. Since <tt>AbstractJMSHibernateSearchController#afterMessage</tt> does not contain a reference or context object, the subclass needs to store the HibernateSession locally making it vulnerable to threading issues.</p> <p style="margin-top:0;margin-bottom:10px;; margin: 10px 0 0">The only solution is to basically ditch <tt>AbstractJMSHibernateSearchController</tt>, copy it and make sure that the session is only stored as a local variable.</p> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand " style="padding: 0; 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"> <script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "EmailMessage",
"description": "View Issue",
"potentialAction": {
"@type": "ViewAction",
"target": "https://hibernate.atlassian.net/browse/HSEARCH-2899?inbox=true&",
"name": "View Issue"
},
"publisher": {
"@type": "Organization",
"name": "Atlassian",
"url": "https://www.atlassian.com"
}
}
</script>
<table id="actions-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0; 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: 0; border-collapse: collapse; padding: 10px 0 10px 24px; vertical-align: middle; padding-left: 0">
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td class="actions-pattern-action-icon-container" style="padding: 0; 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://hibernate.atlassian.net/browse/HSEARCH-2899#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-cf3de24b-dc08-4d2e-b899-f9e6477243fb" 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: 0; 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://hibernate.atlassian.net/browse/HSEARCH-2899#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: 0; 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: 0; border-collapse: collapse; padding: 12px 20px">
<table id="footer-pattern-container" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td id="footer-pattern-mobile-separated-links" class="mobile-resize-text" width="100%" colspan="2" style="padding: 0; 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"> Get JIRA notifications on your phone! Download the JIRA Cloud app for <a href="https://play.google.com/store/apps/details?id=com.atlassian.android.jira.core&referrer=utm_source%3DNotificationLink%26utm_medium%3DEmail" style="color: #3b73af; text-decoration: none">Android</a> or <a href="https://itunes.apple.com/app/apple-store/id1006972087?pt=696495&ct=EmailNotificationLink&mt=8" style="color: #3b73af; text-decoration: none">iOS</a>
<hr> </td>
</tr>
<tr>
<td id="footer-pattern-text" class="mobile-resize-text" width="100%" style="padding: 0; 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">(v1001.0.0-SNAPSHOT#100063-<span title="5b66ec3df88e21b2aa54c823fbde3b5b251f02aa" data-commit-id="5b66ec3df88e21b2aa54c823fbde3b5b251f02aa}">sha1:5b66ec3</span>)</span> </td>
<td id="footer-pattern-logo-desktop-container" valign="top" style="padding: 0; border-collapse: collapse; padding-left: 20px; vertical-align: top">
<table style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td id="footer-pattern-logo-desktop-padding" style="padding: 0; border-collapse: collapse; padding-top: 3px; opacity: 0.150"> <img id="footer-pattern-logo-desktop" src="cid:jira-generated-image-static-footer-desktop-logo-032e2823-22d3-4608-b978-eceb834b94b0" alt="Atlassian logo" title="Atlassian logo" width="192" height="24" class="image_fix"> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table>
<img src="https://u4043402.ct.sendgrid.net/wf/open?upn=YNXLe5Uzuivj8jGpuXra04BSJ-2BS7raa1puTAtyVUP-2F0vngXMYTK-2FS3Irgj0Y-2FFD485KD-2Bf5qBkvaggXzvjO5IuVWJU3iX-2B0k3cHoEy6l6-2BGOEpM4ldNEV48MAFO7JpKyzltmWKNt-2FhxvlA7zf8YwhQq4th0yYLzIQdoMkEdhY12QdzTpZU-2B8yH8YOOCjt58lr5YJEpTBrwemu90R17yV7GlLgNlacIosyyBgHV-2Fr6GgkjsEe7Qb-2BS1Ar9dSURZ-2B0" alt="" width="1" height="1" border="0" style="height:1px !important;width:1px !important;border-width:0 !important;margin-top:0 !important;margin-bottom:0 !important;margin-right:0 !important;margin-left:0 !important;padding-top:0 !important;padding-bottom:0 !important;padding-right:0 !important;padding-left:0 !important;"/>
</body>
</html>