com.sap.tc.logging
Class Category

java.lang.Object
  |
  +--com.sap.tc.logging.ExceptionHandling
        |
        +--com.sap.tc.logging.LogController
              |
              +--com.sap.tc.logging.Category

All Implemented Interfaces:

IObjectInfo

public class Category

extends LogController

Describes messages specific to distinguished problem areas and is above all used to emit log messages. Typical problem areas are databases, networking, security auditing and others. Messages related to problem areas are classical log messages, and hence messages emitted to categories are classical log messages. Therefore, if you are above all interested in writing logs, please read this introduction thoroughly.

The class Category is a subclass of LogController, so you can, with the corresponding calls, emit log messages and have the output of those messages to attachable logs controlled via the severities of the categories and optional filters assigned to them. We recommend to use the constants provided in the class Severity to specify message severities.

Categories are named according to the hierarchical structure known from file systems. This name structure is mirrored in the hierarchical order of the categories named. For example, you could decide to group together all the categories of log messages concerned with system issues, such as database or networking problems, and name them /System/Database and /System/Network, respectively. The category /System is then the parent of the former two and therefore passes on its settings and attached logs to both of them. This has the benefit that, for example, if you would like to have all system messages written to the same log, you do not have to attach it to both the database and networking categories but simply to the common parent. The hierarchical components of the name have to be compliant with Java identifier syntax, but you can use illegal characters bracketing a component with single quotes. For example, to use a name with a space, write /System/'Other Database'.

Categories are accessed via the static method Category.getCategory. Although the lookup done in this method is quite efficient, it should not be called each time a message is to be generated. Instead, each class should define static fields to hold all the needed categories, and use these fields to call logging methods.

Messages in a category are always written with respect to a source code area, or location, such as a component, a package, a class or a method. As a location is itself a log controller, the same method call can write a message simultaneously to, for example, the database log as well as to the location trace responsible for that part of the source code, save for the location having an appropriate severity setting. Both messages get the same identification in order to facilitate cross-referencing among location and category logs. At the same time, the location provides a location description, that is a string, to the log message written to the database log. This might get tedious when a class implements a large number of methods. Therefore, as described below in more detail, for each logging method there is a version which takes in an additional parameter called subloc a string that serves as suffix to the name of the used location, thus providing you with the option to give a complete location name whilst avoiding clutter.

Before we take a closer look at an example, a few remarks on output methods and a short word of warning: do not let the sheer number of methods overwhelm you. There are two families of methods and the large number stems above all from the different parameters of these families, and the resulting combinations. There are methods for emitting clear text messages and methods for emitting language-independent messages via a message code, called logT and log, respectively. The message code is a name looked up in a resource bundle at the time of viewing the log. Both methods come in flavors that take an array of object arguments. When using these flavors, the message is expected to take parameters specified as placeholders of the form "{<number>}" which are then replaced with the argument having the same number, or rather with the result of its method toString. This format is known from the class java.text.MessageFormat. If the result of toString is unsuitable for an argument, an arbitrary string can be passed instead. Note that to output "{" or "}" you have to put them into single quotes, that is write "'{'" or "'}'". To print single quotes, double them in your message.

All the above methods take a first argument that specifies the severities of the messages. It is recommended to use one of the constants defined in the class Severity here, for example Severity.WARNING or Severity.ERROR. However, there are also dedicated methods without that additional argument for all of the severities starting with Severity.INFO, with names of the form <severity>T and <severity>, which are provided in the same flavors as logT and log.

To sum up the above, including optional arguments an output call has the following general form:

<severity>T(	<location>,
	[<sublocation>,]
	<message>
	[,<arguments>])

or

<severity>(	<location>,
	[<sublocation>,]
	<message code>
	[,<arguments>]
	[,<clear message>]).

The optional argument <sublocation> is for a parameter called subloc in the actual methods. This argument is appended to the name of the location itself. It is intended for completing the location name if a method is not represented via its own location because the corresponding fine control of output is not needed, as described above. The optional argument <clear message> of the second method version is for a parameter called msgClear in the actual methods. This argument is a fallback that is used to show the message if the code could not be found in the specified resource bundle. Of course, all these optional arguments are also possible for the two basic calls logT and log.

Let us take a closer look at an example. Due to the suffix option described above, the message uses the location name com.sap.tc.monitoring.Node.store(). Appropriate severity settings assumed, it would be written to both the logs associated with the category cat as well as those attached to the location loc.

package com.sap.tc.monitoring;

import com.sap.tc.logging.*;

public class Node {

  private static final Location loc = Location.getLocation(Node.class);
  private static final Category cat = Category.getCategory("/System/Database");

  public void store() {
    final String method = "store()";

    try {
      // Write object data to database ...
    }
    catch (DatabaseException e) {
      cat.errorT(loc,
                 method,
                 "Error storing tree with root {0} in database.",
                 new Object[] {this});
    }
  }
}

Note that for the message to be written to a log attached to the category, its severtiy must have been set at least with

cat.setEffectiveSevertiy(Severity.ERROR);

or with

cat.setEffectiveSevertiy(loc,
                         Severity.ERROR);

specifically for the location, for example during component initialization. Vice versa, for the message to be written to a log attached to the location, its severity must have been set with

loc.setEffectiveSevertiy(Severity.ERROR);

or with

loc.setEffectiveSevertiy(cat,
                         Severity.ERROR);

specifically for messages of the database problem category. For the example at hand, it would have been alright to format the message prior to the call using string concatenation, but in case of several arguments it is more efficient and for language-independent messages even necessary to use separate arguments.

Above, we described how identifications are used to link the same message in traces and logs. You can also establish custom links among messages. Output methods return the corresponding log record if a message was written to at least one log. The identification can be obtained from the log record via the method LogRecord.getId() and then written as an argument to another message. In the same way, groups can be linked to messages using the identification of the log record group from LogRecord.getGroupId(). Depending on the case at hand, other information in the log record and its groups is also useful.

Often, it is useful to put several related messages together into one context. A typical example are all trace messages stemming from one method call. In case of a database log, another example would be the messages representing the different database operations together forming one logical transaction. A formatter or log viewer can utilize this context information to visualize relations using indentation or tree controls. Groups are the means to express such context information.

You begin a group with a call to openGroup. This call is based on the same conditions as output calls, that is the group is opened depending on a severity and optional categories. After generating some output you end the group calling closeGroup. Note that there must be a balancing call of closeGroup for any call of openGroup. Even if an openGroup call did not open the group, closeGroup is matched with the call to openGroup. In case of success, in between the two calls all output calls are assigned to the group. You can even generate messages with the same condition as the group via the groupT and group output calls. These calls are also used to emit the opening and closing messages of a group, which are the first such messages emitted after the openGroup and closeGroup calls, respectively. If you forget to write opening and closing messages implicit messages are generated.

In the method above, for example, you could write the following piece of code. The message right after the openGroup call is the opening message of the group, the message after closeGroup its closing message. Note that the groupT calls do not need a severity, a location or a method name, as these are fetched from the active group.

cat.openGroup(Severity.INFO,
              loc,
              method);
cat.groupT("Start storing tree with root {0}.",
           new Object[] {this});
...
cat.groupT("Storing subnode {0}.",
           new Object[] {node});
...
cat.closeGroup();
cat.groupT("Finished storing tree.");

Please find fundamental information about the principles of error handling in the package description. For this class, there are three cases where the methods ExceptionHandling.getException() and ExceptionHandling.throwException() are served. First, methods dealing with severities pass over a java.lang.IllegalArgumentException if a value is out of range. Second, the same exception with a different message is handed over if you forget to provide a location when needed, which is the case for the calls setting relative severities as well as for all methods emitting messages. However, all defective calls of the latter, for example when not providing a resource bundle or a clear text version in case of a language-independent message, still write the message in order to facilitate discovering the site of the call. Third, java.util.NoSuchElementException is returned if a call to closeGroup does not match an openGroup call.

See Also:

Location, Severity, LogRecord, Group

Field Summary

static Category	APPLICATION Deprecated. Use APPLICATIONS
static Category	APPLICATIONS
static Category	APPS_COMMON
static Category	APPS_COMMON_ARCHIVING
static Category	APPS_COMMON_BACKUP
static Category	APPS_COMMON_CONFIGURATION
static Category	APPS_COMMON_FAILOVER
static Category	APPS_COMMON_INFRASTRUCTURE
static Category	APPS_COMMON_RESOURCES
static Category	APPS_COMMON_SECURITY
static Category	PERFORMANCE
static java.util.HashMap	PREDEF_CATEGORIES
static java.lang.String	ROOT_NAME
static char	SEPARATOR
static Category	SYS_CONFIGURATION
static Category	SYS_DATABASE
static Category	SYS_ENTERPRISE_SERVICES
static Category	SYS_LOGGING
static Category	SYS_NETWORK
static Category	SYS_SECURITY
static Category	SYS_SERVER
static Category	SYS_USER_INTERFACE
static Category	SYSTEM

Method Summary

LogRecord	error(Location loc, java.lang.Object msgCode) Same as log(int, Location, java.lang.Object) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	error(Location loc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.Object, java.lang.Object[]) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	error(Location loc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	error(Location loc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	error(Location loc, java.lang.String subloc, java.lang.Object msgCode) Same as log(int, Location, java.lang.String, java.lang.Object) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	error(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[]) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	error(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[], java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	error(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	errorT(Location loc, java.lang.String msg) Same as logT(int, Location, java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	errorT(Location loc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.Object[]) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	errorT(Location loc, java.lang.String subloc, java.lang.String msg) Same as logT(int, Location, java.lang.String, java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	errorT(Location loc, java.lang.String subloc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.String, java.lang.Object[]) but always emits an error message, that is a message of severity Severity.ERROR.
LogRecord	fatal(Location loc, java.lang.Object msgCode) Same as log(int, Location, java.lang.Object) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatal(Location loc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.Object, java.lang.Object[]) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatal(Location loc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatal(Location loc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatal(Location loc, java.lang.String subloc, java.lang.Object msgCode) Same as log(int, Location, java.lang.String, java.lang.Object) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatal(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[]) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatal(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[], java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatal(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatalT(Location loc, java.lang.String msg) Same as logT(int, Location, java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatalT(Location loc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.Object[]) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatalT(Location loc, java.lang.String subloc, java.lang.String msg) Same as logT(int, Location, java.lang.String, java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.
LogRecord	fatalT(Location loc, java.lang.String subloc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.String, java.lang.Object[]) but always emits a fatal error message, that is a message of severity Severity.FATAL.
static Category	getCategory(Category category, java.lang.String name) Gets the category with the specified name relative to another category.
static Category	getCategory(java.lang.String name) Deprecated. Parent (relative) category must be specified.
Category	getParent() Gets the parent category of this category.
static Category	getRoot() Gets the root category.
LogRecord	info(Location loc, java.lang.Object msgCode) Same as log(int, Location, java.lang.Object) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	info(Location loc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.Object, java.lang.Object[]) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	info(Location loc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	info(Location loc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	info(Location loc, java.lang.String subloc, java.lang.Object msgCode) Same as log(int, Location, java.lang.String, java.lang.Object) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	info(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[]) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	info(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[], java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	info(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	infoT(Location loc, java.lang.String msg) Same as logT(int, Location, java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	infoT(Location loc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.Object[]) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	infoT(Location loc, java.lang.String subloc, java.lang.String msg) Same as logT(int, Location, java.lang.String, java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	infoT(Location loc, java.lang.String subloc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.String, java.lang.Object[]) but always emits an informational message, that is a message of severity Severity.INFO.
LogRecord	log(int severity, Location loc, java.lang.Object msgCode) Logs message, specified as a resource name, from the given location into this category.
LogRecord	log(int severity, Location loc, java.lang.Object msgCode, java.lang.Object[] args) Logs message, specified as a resource name, with parameters from the given location into this category.
LogRecord	log(int severity, Location loc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Logs message, specified as a resource name, with parameters from the given location into this category.
LogRecord	log(int severity, Location loc, java.lang.Object msgCode, java.lang.String msgClear) Logs message, specified as a resource name, from the given location into this category.
LogRecord	log(int severity, Location loc, java.lang.String subloc, java.lang.Object msgCode) Same as log(int, Location, java.lang.Object) but appends a string denoting a sublocation to the name of the location.
LogRecord	log(int severity, Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.Object, java.lang.Object[]) but appends a string denoting a sublocation to the name of the location.
LogRecord	log(int severity, Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but appends a string denoting a sublocation to the name of the location.
LogRecord	log(int severity, Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.String) but appends a string denoting a sublocation to the name of the location.
LogRecord	logT(int severity, Location loc, java.lang.String msg) Logs simple message from the given location into this category.
LogRecord	logT(int severity, Location loc, java.lang.String msg, java.lang.Object[] args) Logs message with parameters from the given location into this category.
LogRecord	logT(int severity, Location loc, java.lang.String subloc, java.lang.String msg) Same as logT(int, Location, java.lang.String) but appends a string denoting a sublocation to the name of the location.
LogRecord	logT(int severity, Location loc, java.lang.String subloc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.Object[]) but appends a string denoting a sublocation to the name of the location.
LogRecord	logThrowable(int severity, Location loc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear, java.lang.Throwable exc) Logs message with stack trace of given exception, from the given location into this category.
LogRecord	logThrowable(int severity, Location loc, java.lang.Object msgCode, java.lang.String msgClear, java.lang.Throwable exc) Logs message with stack trace of given exception, from the given location into this category.
LogRecord	logThrowable(int severity, Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear, java.lang.Throwable exc) Logs message with stack trace of given exception, from the given location into this category.
LogRecord	logThrowable(int severity, Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.String msgClear, java.lang.Throwable exc) Logs message with stack trace of given exception, from the given location into this category.
LogRecord	logThrowableT(int severity, Location loc, java.lang.String msg, java.lang.Object[] args, java.lang.Throwable exc) Logs message with stack trace of given exception, from the given location into this category.
LogRecord	logThrowableT(int severity, Location loc, java.lang.String subloc, java.lang.String msg, java.lang.Object[] args, java.lang.Throwable exc) Logs message with stack trace of given exception, from the given location into this category.
LogRecord	logThrowableT(int severity, Location loc, java.lang.String subloc, java.lang.String msg, java.lang.Throwable exc) Logs message with stack trace of given exception, from the given location into this category.
LogRecord	logThrowableT(int severity, Location loc, java.lang.String msg, java.lang.Throwable exc) Logs message with stack trace of given exception, from the given location into this category.
void	openGroup(int severity, Location loc) Opens a message group from the given location on this category.
void	openGroup(int severity, Location loc, java.lang.String subloc) Same as openGroup(int, Location) but appends a string denoting a sublocation to the name of the location.
void	setEffectiveSeverity(Location relative) Resets the effective severity of this category with respect to a location.
void	setEffectiveSeverity(Location relative, int severity) Sets the effective severity of this category with respect to a location.
void	setMaximumSeverity(Location relative) Resets the maximum severity of this category with respect to a location.
void	setMaximumSeverity(Location relative, int severity) Sets the maximum severity of this category with respect to a location.
void	setMinimumSeverity(Location relative) Resets the minimum severity of this category with respect to a location.
void	setMinimumSeverity(Location relative, int severity) Sets the minimum severity of this category with respect to a location.
LogRecord	warning(Location loc, java.lang.Object msgCode) Same as log(int, Location, java.lang.Object) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warning(Location loc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.Object, java.lang.Object[]) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warning(Location loc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warning(Location loc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.Object, java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warning(Location loc, java.lang.String subloc, java.lang.Object msgCode) Same as log(int, Location, java.lang.String, java.lang.Object) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warning(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[]) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warning(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.Object[] args, java.lang.String msgClear) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[], java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warning(Location loc, java.lang.String subloc, java.lang.Object msgCode, java.lang.String msgClear) Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warningT(Location loc, java.lang.String msg) Same as logT(int, Location, java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warningT(Location loc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.Object[]) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warningT(Location loc, java.lang.String subloc, java.lang.String msg) Same as logT(int, Location, java.lang.String, java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.
LogRecord	warningT(Location loc, java.lang.String subloc, java.lang.String msg, java.lang.Object[] args) Same as logT(int, Location, java.lang.String, java.lang.String, java.lang.Object[]) but always emits a warning message, that is a message of severity Severity.WARNING.

Methods inherited from class com.sap.tc.logging.LogController

addFilter, addLocalLog, addLog, addPrivateLog, beDebug, beDebug, beDebug, beError, beError, beError, beFatal, beFatal, beFatal, beGroup, beInfo, beInfo, beInfo, beLogged, beLogged, beLogged, bePath, bePath, bePath, beWarning, beWarning, beWarning, closeGroup, getAllLogs, getChildren, getClassLoader, getDescription, getEffectiveSeverity, getEffectiveSeverity, getEffectiveSeverity, getFilters, getGroupSize, getLocalLogs, getLoggedCnt, getLoggedCount, getLogs, getMaximumSeverity, getMaximumSeverity, getMaximumSeverity, getMinimumSeverity, getMinimumSeverity, getMinimumSeverity, getName, getPrivateLogs, getRecord, getRelatives, getResourceBundleName, getVerInUse, group, group, group, group, group, group, group, group, groupT, groupT, groupT, groupT, isActivityTracking, isFiltersAgreeing, release, removeFilter, removeFilters, removeLog, removeLogs, reset, resetAll, resetLoggedCount, setActivityTracking, setClassLoader, setClassLoader, setDescription, setEffectiveSeverity, setEffectiveSeverity, setGroupSize, setMaximumSeverity, setMaximumSeverity, setMinimumSeverity, setMinimumSeverity, setName, setResourceBundleName, setResourceBundleName

Methods inherited from class com.sap.tc.logging.ExceptionHandling

getException, getExceptions, handleException, handleException, resetException, throwException

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROOT_NAME

public static final java.lang.String ROOT_NAME

SEPARATOR

public static final char SEPARATOR

SYSTEM

public static final Category SYSTEM

APPLICATION

public static Category APPLICATION

Deprecated. Use APPLICATIONS

APPLICATIONS

public static Category APPLICATIONS

APPS_COMMON

public static Category APPS_COMMON

APPS_COMMON_SECURITY

public static Category APPS_COMMON_SECURITY

APPS_COMMON_BACKUP

public static Category APPS_COMMON_BACKUP

APPS_COMMON_ARCHIVING

public static Category APPS_COMMON_ARCHIVING

APPS_COMMON_RESOURCES

public static Category APPS_COMMON_RESOURCES

APPS_COMMON_CONFIGURATION

public static Category APPS_COMMON_CONFIGURATION

APPS_COMMON_FAILOVER

public static Category APPS_COMMON_FAILOVER

APPS_COMMON_INFRASTRUCTURE

public static Category APPS_COMMON_INFRASTRUCTURE

PERFORMANCE

public static Category PERFORMANCE

SYS_DATABASE

public static Category SYS_DATABASE

SYS_NETWORK

public static Category SYS_NETWORK

SYS_SERVER

public static Category SYS_SERVER

SYS_SECURITY

public static Category SYS_SECURITY

SYS_USER_INTERFACE

public static Category SYS_USER_INTERFACE

SYS_CONFIGURATION

public static Category SYS_CONFIGURATION

SYS_LOGGING

public static Category SYS_LOGGING

SYS_ENTERPRISE_SERVICES

public static Category SYS_ENTERPRISE_SERVICES

PREDEF_CATEGORIES

public static java.util.HashMap PREDEF_CATEGORIES

Method Detail

getRoot

public static Category getRoot()

Gets the root category.

Returns:

Root category

getParent

public Category getParent()

Gets the parent category of this category.

Returns:

Parent category

getCategory

public static Category getCategory(Category category,
                                   java.lang.String name)

Gets the category with the specified name relative to another category. Save for the root category, this method is a shorthand for the call Category.getCategory(category.getName() + "/" + name).

Parameters:

category - Parent category

name - Structured name of category

Returns:

Category identified by relative name

Throws:

java.lang.IllegalArgumentException - Wrong location name syntax

logT

public LogRecord logT(int severity,
                      Location loc,
                      java.lang.String msg)

Logs simple message from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

msg - Message text

Returns:

Log record if written via a log of this log controller or null

logT

public LogRecord logT(int severity,
                      Location loc,
                      java.lang.String subloc,
                      java.lang.String msg)

Same as logT(int, Location, java.lang.String) but appends a string denoting a sublocation to the name of the location.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msg - Message text

Returns:

Log record if written via a log of this log controller or null

logT

public LogRecord logT(int severity,
                      Location loc,
                      java.lang.String msg,
                      java.lang.Object[] args)

Logs message with parameters from the given location into this category. The objects handed over as arguments are written using the method toString.

Parameters:

severity - Severity of message

loc - Location message stems from

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

logT

public LogRecord logT(int severity,
                      Location loc,
                      java.lang.String subloc,
                      java.lang.String msg,
                      java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.Object[]) but appends a string denoting a sublocation to the name of the location.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

log

public LogRecord log(int severity,
                     Location loc,
                     java.lang.Object msgCode)

Logs message, specified as a resource name, from the given location into this category. If Location has defined resource name then that resorce name is taken, otherwise Category resource name is taken. This method also stores a clear text version of the message, taken from the resource bundle for language code en and country code US, which is displayed whenever a log viewer cannot resolve a message code.

Parameters:

severity - Severity of message

loc - Location message stems from

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

log

public LogRecord log(int severity,
                     Location loc,
                     java.lang.String subloc,
                     java.lang.Object msgCode)

Same as log(int, Location, java.lang.Object) but appends a string denoting a sublocation to the name of the location.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

log

public LogRecord log(int severity,
                     Location loc,
                     java.lang.Object msgCode,
                     java.lang.Object[] args)

Logs message, specified as a resource name, with parameters from the given location into this category. If Location has defined resource name then that resorce name is taken, otherwise Category resource name is taken. The objects handed over as arguments are written using the method toString. This method also stores a clear text version of the message, taken from the resource bundle for language code en and country code US, which is displayed whenever a log viewer cannot resolve a message code.

Parameters:

severity - Severity of message

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

log

public LogRecord log(int severity,
                     Location loc,
                     java.lang.String subloc,
                     java.lang.Object msgCode,
                     java.lang.Object[] args)

Same as log(int, Location, java.lang.Object, java.lang.Object[]) but appends a string denoting a sublocation to the name of the location.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

log

public LogRecord log(int severity,
                     Location loc,
                     java.lang.Object msgCode,
                     java.lang.String msgClear)

Logs message, specified as a resource name, from the given location into this category. If Location has defined resource name then that resorce name is taken, otherwise Category resource name is taken. This method also stores a clear text version of the message which is displayed whenever a log viewer cannot resolve a message code.

Parameters:

severity - Severity of message

loc - Location message stems from

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

log

public LogRecord log(int severity,
                     Location loc,
                     java.lang.String subloc,
                     java.lang.Object msgCode,
                     java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.String) but appends a string denoting a sublocation to the name of the location.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

log

public LogRecord log(int severity,
                     Location loc,
                     java.lang.Object msgCode,
                     java.lang.Object[] args,
                     java.lang.String msgClear)

Logs message, specified as a resource name, with parameters from the given location into this category. If Location has defined resource name then that resorce name is taken, otherwise Category resource name is taken. The objects handed over as arguments are written using the method toString. This method also stores a clear text version of the message which is displayed whenever a log viewer cannot resolve a message code.

Parameters:

severity - Severity of message

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

log

public LogRecord log(int severity,
                     Location loc,
                     java.lang.String subloc,
                     java.lang.Object msgCode,
                     java.lang.Object[] args,
                     java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but appends a string denoting a sublocation to the name of the location.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

infoT

public LogRecord infoT(Location loc,
                       java.lang.String msg)

Same as logT(int, Location, java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

msg - Message text

Returns:

Log record if written via a log of this log controller or null

infoT

public LogRecord infoT(Location loc,
                       java.lang.String subloc,
                       java.lang.String msg)

Same as logT(int, Location, java.lang.String, java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msg - Message text

Returns:

Log record if written via a log of this log controller or null

infoT

public LogRecord infoT(Location loc,
                       java.lang.String msg,
                       java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.Object[]) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

infoT

public LogRecord infoT(Location loc,
                       java.lang.String subloc,
                       java.lang.String msg,
                       java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.String, java.lang.Object[]) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

info

public LogRecord info(Location loc,
                      java.lang.Object msgCode)

Same as log(int, Location, java.lang.Object) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

info

public LogRecord info(Location loc,
                      java.lang.String subloc,
                      java.lang.Object msgCode)

Same as log(int, Location, java.lang.String, java.lang.Object) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

info

public LogRecord info(Location loc,
                      java.lang.Object msgCode,
                      java.lang.Object[] args)

Same as log(int, Location, java.lang.Object, java.lang.Object[]) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

info

public LogRecord info(Location loc,
                      java.lang.String subloc,
                      java.lang.Object msgCode,
                      java.lang.Object[] args)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[]) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

info

public LogRecord info(Location loc,
                      java.lang.Object msgCode,
                      java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

info

public LogRecord info(Location loc,
                      java.lang.String subloc,
                      java.lang.Object msgCode,
                      java.lang.String msgClear)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

info

public LogRecord info(Location loc,
                      java.lang.Object msgCode,
                      java.lang.Object[] args,
                      java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

info

public LogRecord info(Location loc,
                      java.lang.String subloc,
                      java.lang.Object msgCode,
                      java.lang.Object[] args,
                      java.lang.String msgClear)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[], java.lang.String) but always emits an informational message, that is a message of severity Severity.INFO.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

warningT

public LogRecord warningT(Location loc,
                          java.lang.String msg)

Same as logT(int, Location, java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

msg - Message text

Returns:

Log record if written via a log of this log controller or null

warningT

public LogRecord warningT(Location loc,
                          java.lang.String subloc,
                          java.lang.String msg)

Same as logT(int, Location, java.lang.String, java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msg - Message text

Returns:

Log record if written via a log of this log controller or null

warningT

public LogRecord warningT(Location loc,
                          java.lang.String msg,
                          java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.Object[]) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

warningT

public LogRecord warningT(Location loc,
                          java.lang.String subloc,
                          java.lang.String msg,
                          java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.String, java.lang.Object[]) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

warning

public LogRecord warning(Location loc,
                         java.lang.Object msgCode)

Same as log(int, Location, java.lang.Object) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

warning

public LogRecord warning(Location loc,
                         java.lang.String subloc,
                         java.lang.Object msgCode)

Same as log(int, Location, java.lang.String, java.lang.Object) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

warning

public LogRecord warning(Location loc,
                         java.lang.Object msgCode,
                         java.lang.Object[] args)

Same as log(int, Location, java.lang.Object, java.lang.Object[]) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

warning

public LogRecord warning(Location loc,
                         java.lang.String subloc,
                         java.lang.Object msgCode,
                         java.lang.Object[] args)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[]) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

warning

public LogRecord warning(Location loc,
                         java.lang.Object msgCode,
                         java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

warning

public LogRecord warning(Location loc,
                         java.lang.String subloc,
                         java.lang.Object msgCode,
                         java.lang.String msgClear)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

warning

public LogRecord warning(Location loc,
                         java.lang.Object msgCode,
                         java.lang.Object[] args,
                         java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

warning

public LogRecord warning(Location loc,
                         java.lang.String subloc,
                         java.lang.Object msgCode,
                         java.lang.Object[] args,
                         java.lang.String msgClear)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[], java.lang.String) but always emits a warning message, that is a message of severity Severity.WARNING.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

errorT

public LogRecord errorT(Location loc,
                        java.lang.String msg)

Same as logT(int, Location, java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

msg - Message text

Returns:

Log record if written via a log of this log controller or null

errorT

public LogRecord errorT(Location loc,
                        java.lang.String subloc,
                        java.lang.String msg)

Same as logT(int, Location, java.lang.String, java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msg - Message text

Returns:

Log record if written via a log of this log controller or null

errorT

public LogRecord errorT(Location loc,
                        java.lang.String msg,
                        java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.Object[]) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

errorT

public LogRecord errorT(Location loc,
                        java.lang.String subloc,
                        java.lang.String msg,
                        java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.String, java.lang.Object[]) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

error

public LogRecord error(Location loc,
                       java.lang.Object msgCode)

Same as log(int, Location, java.lang.Object) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

error

public LogRecord error(Location loc,
                       java.lang.String subloc,
                       java.lang.Object msgCode)

Same as log(int, Location, java.lang.String, java.lang.Object) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

error

public LogRecord error(Location loc,
                       java.lang.Object msgCode,
                       java.lang.Object[] args)

Same as log(int, Location, java.lang.Object, java.lang.Object[]) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

error

public LogRecord error(Location loc,
                       java.lang.String subloc,
                       java.lang.Object msgCode,
                       java.lang.Object[] args)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[]) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

error

public LogRecord error(Location loc,
                       java.lang.Object msgCode,
                       java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

error

public LogRecord error(Location loc,
                       java.lang.String subloc,
                       java.lang.Object msgCode,
                       java.lang.String msgClear)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

error

public LogRecord error(Location loc,
                       java.lang.Object msgCode,
                       java.lang.Object[] args,
                       java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

error

public LogRecord error(Location loc,
                       java.lang.String subloc,
                       java.lang.Object msgCode,
                       java.lang.Object[] args,
                       java.lang.String msgClear)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[], java.lang.String) but always emits an error message, that is a message of severity Severity.ERROR.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

fatalT

public LogRecord fatalT(Location loc,
                        java.lang.String msg)

Same as logT(int, Location, java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

msg - Message text

Returns:

Log record if written via a log of this log controller or null

fatalT

public LogRecord fatalT(Location loc,
                        java.lang.String subloc,
                        java.lang.String msg)

Same as logT(int, Location, java.lang.String, java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msg - Message text

Returns:

Log record if written via a log of this log controller or null

fatalT

public LogRecord fatalT(Location loc,
                        java.lang.String msg,
                        java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.Object[]) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

fatalT

public LogRecord fatalT(Location loc,
                        java.lang.String subloc,
                        java.lang.String msg,
                        java.lang.Object[] args)

Same as logT(int, Location, java.lang.String, java.lang.String, java.lang.Object[]) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msg - Message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

fatal

public LogRecord fatal(Location loc,
                       java.lang.Object msgCode)

Same as log(int, Location, java.lang.Object) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

fatal

public LogRecord fatal(Location loc,
                       java.lang.String subloc,
                       java.lang.Object msgCode)

Same as log(int, Location, java.lang.String, java.lang.Object) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

fatal

public LogRecord fatal(Location loc,
                       java.lang.Object msgCode,
                       java.lang.Object[] args)

Same as log(int, Location, java.lang.Object, java.lang.Object[]) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

fatal

public LogRecord fatal(Location loc,
                       java.lang.String subloc,
                       java.lang.Object msgCode,
                       java.lang.Object[] args)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[]) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

fatal

public LogRecord fatal(Location loc,
                       java.lang.Object msgCode,
                       java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

fatal

public LogRecord fatal(Location loc,
                       java.lang.String subloc,
                       java.lang.Object msgCode,
                       java.lang.String msgClear)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

fatal

public LogRecord fatal(Location loc,
                       java.lang.Object msgCode,
                       java.lang.Object[] args,
                       java.lang.String msgClear)

Same as log(int, Location, java.lang.Object, java.lang.Object[], java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

fatal

public LogRecord fatal(Location loc,
                       java.lang.String subloc,
                       java.lang.Object msgCode,
                       java.lang.Object[] args,
                       java.lang.String msgClear)

Same as log(int, Location, java.lang.String, java.lang.Object, java.lang.Object[], java.lang.String) but always emits a fatal error message, that is a message of severity Severity.FATAL.

Parameters:

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

logThrowableT

public LogRecord logThrowableT(int severity,
                               Location loc,
                               java.lang.String msg,
                               java.lang.Throwable exc)

Logs message with stack trace of given exception, from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

msg - Message template

exc - Throwable, the superclass of all errors and exceptions

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

logThrowableT

public LogRecord logThrowableT(int severity,
                               Location loc,
                               java.lang.String subloc,
                               java.lang.String msg,
                               java.lang.Throwable exc)

Logs message with stack trace of given exception, from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msg - Message template

exc - Throwable, the superclass of all errors and exceptions

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

logThrowableT

public LogRecord logThrowableT(int severity,
                               Location loc,
                               java.lang.String msg,
                               java.lang.Object[] args,
                               java.lang.Throwable exc)

Logs message with stack trace of given exception, from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

msg - Message template

args - Arguments as object references

exc - Throwable, the superclass of all errors and exceptions

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

logThrowableT

public LogRecord logThrowableT(int severity,
                               Location loc,
                               java.lang.String subloc,
                               java.lang.String msg,
                               java.lang.Object[] args,
                               java.lang.Throwable exc)

Logs message with stack trace of given exception, from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msg - Message template

args - Arguments as object references

exc - Throwable, the superclass of all errors and exceptions

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

logThrowable

public LogRecord logThrowable(int severity,
                              Location loc,
                              java.lang.Object msgCode,
                              java.lang.String msgClear,
                              java.lang.Throwable exc)

Logs message with stack trace of given exception, from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

msgCode - Resource name of message template

msgClear - Clear text version of message

exc - Throwable, the superclass of all errors and exceptions

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

logThrowable

public LogRecord logThrowable(int severity,
                              Location loc,
                              java.lang.String subloc,
                              java.lang.Object msgCode,
                              java.lang.String msgClear,
                              java.lang.Throwable exc)

Logs message with stack trace of given exception, from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

msgClear - Clear text version of message

exc - Throwable, the superclass of all errors and exceptions

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

logThrowable

public LogRecord logThrowable(int severity,
                              Location loc,
                              java.lang.Object msgCode,
                              java.lang.Object[] args,
                              java.lang.String msgClear,
                              java.lang.Throwable exc)

Logs message with stack trace of given exception, from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

exc - Throwable, the superclass of all errors and exceptions

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

logThrowable

public LogRecord logThrowable(int severity,
                              Location loc,
                              java.lang.String subloc,
                              java.lang.Object msgCode,
                              java.lang.Object[] args,
                              java.lang.String msgClear,
                              java.lang.Throwable exc)

Logs message with stack trace of given exception, from the given location into this category.

Parameters:

severity - Severity of message

loc - Location message stems from

subloc - Name of sublocation

msgCode - Resource name of message template

args - Arguments as object references

msgClear - Clear text version of message

exc - Throwable, the superclass of all errors and exceptions

Returns:

Log record if written via a log of this log controller or null

See Also:

LogController.setResourceBundleName(java.lang.String)

openGroup

public void openGroup(int severity,
                      Location loc)

Opens a message group from the given location on this category. After a call to this method a group message should be emitted, which becomes the opening message of this group. A group opened via this method must be closed again via LogController#closeGroup().

Parameters:

severity - Severity of message group

loc - Location message group stems from

See Also:

LogController.closeGroup()

openGroup

public void openGroup(int severity,
                      Location loc,
                      java.lang.String subloc)

Same as openGroup(int, Location) but appends a string denoting a sublocation to the name of the location. A group opened via this method must be closed again via LogController#closeGroup().

Parameters:

severity - Severity of message group

loc - Location message group stems from

subloc - Name of sublocation

See Also:

LogController.closeGroup()

setMinimumSeverity

public void setMinimumSeverity(Location relative,
                               int severity)

Sets the minimum severity of this category with respect to a location. If its current maximum severity is lower than the argument, the former is set to the argument. If it is the root category, this method has the same effect as a call to setEffectiveSeverity(Location, int).

Parameters:

severity - New minimum severity

setMinimumSeverity

public void setMinimumSeverity(Location relative)

Resets the minimum severity of this category with respect to a location. If it is the root category this method has no effect, otherwise it has the same effect as a call to setMinimumSeverity(Location, int) with Severity.ALL.

setEffectiveSeverity

public void setEffectiveSeverity(Location relative,
                                 int severity)

Sets the effective severity of this category with respect to a location. If it is the root category, this method sets the effective severity to its argument, otherwise it has the same effect as calls with its argument to both setMinimumSeverity(Location, int) and setMaximumSeverity(Location, int).

Parameters:

severity - New effective severity

setEffectiveSeverity

public void setEffectiveSeverity(Location relative)

Resets the effective severity of this category with respect to a location. If it is the root category this method has no effect, otherwise it has the same effect as two calls to setMinimumSeverity(Location) and setMaximumSeverity(Location).

setMaximumSeverity

public void setMaximumSeverity(Location relative,
                               int severity)

Sets the maximum severity of this category with respect to a location. If its current minimum severity is higher than the argument, the former is set to the argument. If it is the root category, this method has the same effect as a call to setEffectiveSeverity(Location, int).

Parameters:

severity - New maximum severity

setMaximumSeverity

public void setMaximumSeverity(Location relative)

Resets the maximum severity of this category with respect to a location. If it is the root category this method has no effect, otherwise it has the same effect as a call to setMaximumSeverity(Location, int) with Severity.ALL.

getCategory

public static Category getCategory(java.lang.String name)

Deprecated. Parent (relative) category must be specified.

Gets the category with the specified name. If the category with this name does not exist yet it is instantiated. Inheritance refers to the formal hierarchy given by the name structure and therefore even works when parent objects had not been instantiated up to now, either.

Parameters:

name - Structured name of category

Returns:

Category identified by name

Throws:

java.lang.IllegalArgumentException - Wrong location name syntax