<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<body link="#355491" alink="#4262a1" vlink="#355491" style="background: #e2e2e2; margin: 0; padding: 20px;">
<div>
<table cellpadding="0" bgcolor="#FFFFFF" border="0" cellspacing="0" style="border: 1px solid #dadada; margin-bottom: 30px; width: 100%; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tbody>
<tr>
<td>
<table border="0" cellpadding="0" cellspacing="0" bgcolor="#FFFFFF" style="border: solid 2px #ccc; background: #dadada; width: 100%; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tbody>
<tr>
<td bgcolor="#000000" valign="middle" height="58px" style="border-bottom: 1px solid #ccc; padding: 20px; -moz-border-radius-topleft: 3px; -moz-border-radius-topright: 3px; -webkit-border-top-right-radius: 5px; -webkit-border-top-left-radius: 5px;">
<h1 style="color: #333333; font: bold 22px Arial, Helvetica, sans-serif; margin: 0; display: block !important;">
<!-- To have a header image/logo replace the name below with your img tag -->
<!-- Email clients will render the images when the message is read so any image -->
<!-- must be made available on a public server, so that all recipients can load the image. -->
<a href="http://community.jboss.org/index.jspa" style="text-decoration: none; color: #E1E1E1">JBoss Community</a></h1>
</td>
</tr>
<tr>
<td bgcolor="#FFFFFF" style="font: normal 12px Arial, Helvetica, sans-serif; color:#333333; padding: 20px; -moz-border-radius-bottomleft: 4px; -moz-border-radius-bottomright: 4px; -webkit-border-bottom-right-radius: 5px; -webkit-border-bottom-left-radius: 5px;"><h3 style="margin: 10px 0 5px; font-size: 17px; font-weight: normal;">
Logging in Core JBoss Application Server 7
</h3>
<span style="margin-bottom: 10px;">
modified by <a href="http://community.jboss.org/people/jamezp">James Perkins</a> in <i>JBoss AS7 Development</i> - <a href="http://community.jboss.org/docs/DOC-17334">View the full document</a>
</span>
<hr style="margin: 20px 0; border: none; background-color: #dadada; height: 1px;">
<div class="jive-rendered-content"><h3><strong>General Rules:</strong></h3><ul><li style="text-align: start;">All exceptions and messages require a translation method in the @MessageBundle.</li><li style="text-align: start;">All info and higher messages being logged require a translation method in the @MessageLogger.</li><li style="text-align: start;">Messages in both the @MessageBundle and @MessageLogger should have an id<strong>*</strong>.  Note though there are cases, specifically some methods in the @MessageBundle, that do not need id's. These typically include messages that are not being used in exceptions.</li><li style="text-align: start;">All logged messages should use a static logger from the @MessageLogger interface. This includes debug and trace messages.</li></ul><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><strong>*</strong><span> A list of id's can be found here </span><a class="jive-link-wiki-small" href="http://community.jboss.org/docs/DOC-16810" target="_blank">http://community.jboss.org/wiki/LoggingIds</a></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><h3>Passing the cause:</h3><p>Both @MessageLogger's and @MessageBundle's can except a java.lang.Throwable type as a parameter to either log the exception or intialize the exception return types cause. This is done by annotating the parameter with @Cause.</p><pre class="jive-pre"><code class="jive-code jive-java">StartException unableToStart(@Cause Throwable cause);
</code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><h3>Creating Exception Return Types:</h3><p>Most @MessageBundle's methods will be returing exceptions. Some exceptions require a special constructor to be used or require a property/field to be set on the exception. JBoss Logging has 3 separate annotations for these requirements.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p style="text-align: start;">@Param - Is used for exception constructor.</p><pre class="jive-pre"><code class="jive-code jive-java">SAXParseException invalidAttribute(@Param Locator locator, String attributeName, String tagName);
</code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p style="text-align: start;">@Field({name=fieldName}) - Is used to set an instance variable.</p><pre class="jive-pre"><code class="jive-code jive-java">XAException invalidTransaction(@Field Integer errorCode);
</code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>@Propert({name=propertyName}) - Is used to set a property via it's setter method.</p><pre class="jive-pre"><code class="jive-code jive-java">Exception createException(@Property StackTrace[] stackTrace);
</code></pre><h3></h3><h3><strong>Examples:</strong></h3><p><strong><br/></strong></p><p><strong>Before:</strong></p><pre class="jive-pre"><code class="jive-code jive-java">@Override
<font color="navy"><b>public</b></font> <font color="navy"><b>void</b></font> start(StartContext context) <font color="navy"><b>throws</b></font> StartException <font color="navy">{</font>
    <font color="navy"><b>try</b></font> <font color="navy">{</font>
        <font color="navy"><b>final</b></font> JBossThreadFactory threadFactory = <font color="navy"><b>new</b></font> JBossThreadFactory(<font color="navy"><b>new</b></font> ThreadGroup(<font color="red">"ServerDeploymentRepository-temp-threads"</font>), Boolean.FALSE, null, <font color="red">"%G - %t"</font>, null, null, AccessController.getContext());
        tempFileProvider = TempFileProvider.create(<font color="red">"temp"</font>, Executors.newScheduledThreadPool(2, threadFactory));
    <font color="navy">}</font> <font color="navy"><b>catch</b></font> (IOException e) <font color="navy">{</font>
        <font color="navy"><b>throw</b></font> <font color="navy"><b>new</b></font> StartException(<font color="red">"Failed to create temp file provider"</font>);
    <font color="navy">}</font>
    log.debugf(<font color="red">"%s started"</font>, ServerDeploymentRepository.class.getSimpleName());
<font color="navy">}</font>
</code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><strong>Methods added to DeploymentRepositoryMessages:</strong></p><pre class="jive-pre"><code class="jive-code jive-java"><font color="darkgreen">/**
* Creates an exception indicating a failure to create a temp file provider.
*
* @return a {@link StartException} for the error.
*/</font>
@Message(id = 14900, value = <font color="red">"Failed to create temp file provider"</font>)
StartException failedCreatingTempProvider();
</code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p><strong>After:</strong></p><pre class="jive-pre"><code class="jive-code jive-java">@Override
<font color="navy"><b>public</b></font> <font color="navy"><b>void</b></font> start(StartContext context) <font color="navy"><b>throws</b></font> StartException <font color="navy">{</font>
    <font color="navy"><b>try</b></font> <font color="navy">{</font>
        <font color="navy"><b>final</b></font> JBossThreadFactory threadFactory = <font color="navy"><b>new</b></font> JBossThreadFactory(<font color="navy"><b>new</b></font> ThreadGroup(<font color="red">"ServerDeploymentRepository-temp-threads"</font>), Boolean.FALSE, null, <font color="red">"%G - %t"</font>, null, null, AccessController.getContext());
        tempFileProvider = TempFileProvider.create(<font color="red">"temp"</font>, Executors.newScheduledThreadPool(2, threadFactory));
    <font color="navy">}</font> <font color="navy"><b>catch</b></font> (IOException e) <font color="navy">{</font>
        <font color="navy"><b>throw</b></font> MESSAGES.failedCreatingTempProvider();
    <font color="navy">}</font>
    ROOT_LOGGER.debugf(<font color="red">"%s started"</font>, ServerDeploymentRepository.class.getSimpleName());
<font color="navy">}</font>
</code></pre></div>
<div style="background-color: #f4f4f4; padding: 10px; margin-top: 20px;">
<p style="margin: 0;">Comment by <a href="http://community.jboss.org/docs/DOC-17334">going to Community</a></p>
<p style="margin: 0;">Create a new document in JBoss AS7 Development at <a href="http://community.jboss.org/choose-container!input.jspa?contentType=102&containerType=14&container=2225">Community</a></p>
</div></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>