org.jboss.as.jdr.logger

Interface JdrLogger

All Superinterfaces:

org.jboss.logging.BasicLogger

@MessageLogger(projectCode="WFLYJDR",
               length=4)
public interface JdrLogger
extends org.jboss.logging.BasicLogger

JBoss Diagnostic Reporter (JDR) logger.

Author:

Mike M. Clark, David M. Lloyd

Field Summary

Fields

Modifier and Type	Field and Description
static JdrLogger	ROOT_LOGGER A logger with the category of the default jdr package.

Method Summary

Modifier and Type	Method and Description
void	contribNotADirectory() JDR plugin location is not a directory as expected.
String	couldNotConfigureJDR() One of the configuration steps in JDR threw an exception.
String	couldNotCreateZipfile() JDR could not create a zipfile to store the report.
void	endingCollection() Indicates that a JDR report has completed
void	jbossHomeNotSet() Indicates that the JBoss home directory was not set.
String	jdrHelpMessage()
String	jdrHostnameMessage()
String	jdrPortMessage()
String	jdrProtocolMessage()
String	noCommandsToRun() No Commands to run, probably no valid plugin loaded
void	pythonExceptionEncountered(Throwable cause) The sosreport python library threw an exception
void	startingCollection() Indicates that a JDR report has been initiated.
void	urlDecodeExceptionEncountered(Throwable cause) JDR was unable to decode a path URL for standardization across platforms.
IllegalArgumentException	varNull(String var) Indicates an invalid, null argument was passed into a method.

Methods inherited from interface org.jboss.logging.BasicLogger

debug, debug, debug, debug, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugv, debugv, debugv, debugv, debugv, debugv, debugv, debugv, error, error, error, error, errorf, errorf, errorf, errorf, errorf, errorf, errorf, errorf, errorv, errorv, errorv, errorv, errorv, errorv, errorv, errorv, fatal, fatal, fatal, fatal, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, info, info, info, info, infof, infof, infof, infof, infof, infof, infof, infof, infov, infov, infov, infov, infov, infov, infov, infov, isDebugEnabled, isEnabled, isInfoEnabled, isTraceEnabled, log, log, log, log, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, trace, trace, trace, trace, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracev, tracev, tracev, tracev, tracev, tracev, tracev, tracev, warn, warn, warn, warn, warnf, warnf, warnf, warnf, warnf, warnf, warnf, warnf, warnv, warnv, warnv, warnv, warnv, warnv, warnv, warnv

Field Detail

ROOT_LOGGER

static final JdrLogger ROOT_LOGGER

A logger with the category of the default jdr package.

Method Detail

startingCollection

@LogMessage(level=INFO)
 @Message(id=1,
         value="Starting creation of a JBoss Diagnostic Report (JDR).")
void startingCollection()

Indicates that a JDR report has been initiated.

endingCollection

@LogMessage(level=INFO)
 @Message(id=2,
         value="Completed creation of a JBoss Diagnostic Report (JDR).")
void endingCollection()

Indicates that a JDR report has completed

jbossHomeNotSet

@LogMessage(level=ERROR)
 @Message(id=3,
         value="Unable to create JDR report, JBoss Home directory cannot be determined.")
void jbossHomeNotSet()

Indicates that the JBoss home directory was not set.

pythonExceptionEncountered

@LogMessage(level=WARN)
 @Message(id=4,
         value="JDR python interpreter encountered an exception.")
void pythonExceptionEncountered(@Cause
                                                                                                                                           Throwable cause)

The sosreport python library threw an exception

urlDecodeExceptionEncountered

@LogMessage(level=WARN)
 @Message(id=5,
         value="Unable to decode a url while creating JDR report.")
void urlDecodeExceptionEncountered(@Cause
                                                                                                                                               Throwable cause)

JDR was unable to decode a path URL for standardization across platforms.

contribNotADirectory

@LogMessage(level=WARN)
 @Message(id=6,
         value="Plugin contrib location is not a directory.  Ignoring.")
void contribNotADirectory()

JDR plugin location is not a directory as expected.

couldNotCreateZipfile

@Message(id=7,
         value="Could not create zipfile.")
String couldNotCreateZipfile()

JDR could not create a zipfile to store the report.

couldNotConfigureJDR

@Message(id=8,
         value="Could not configure JDR. At least one configuration step failed.")
String couldNotConfigureJDR()

One of the configuration steps in JDR threw an exception.

noCommandsToRun

@Message(id=9,
         value="No JDR commands were loaded. Be sure that a valid Plugin class is specified in plugins.properties.")
String noCommandsToRun()

No Commands to run, probably no valid plugin loaded

varNull

@Message(id=10,
         value="Parameter %s may not be null.")
IllegalArgumentException varNull(String var)

Indicates an invalid, null argument was passed into a method.

Parameters:

var - method variable that was null

Returns:

Exception describing the invalid parameter.

jdrHelpMessage

@Message(id=0,
         value="Display this message and exit")
String jdrHelpMessage()

jdrHostnameMessage

@Message(id=0,
         value="hostname that the management api is bound to. (default: localhost)")
String jdrHostnameMessage()

jdrPortMessage

@Message(id=0,
         value="port that the management api is bound to. (default: 9990)")
String jdrPortMessage()

jdrProtocolMessage

@Message(id=0,
         value="Protocol that is used to connect. Can be remote, http or https (default: http)")
String jdrProtocolMessage()