This package contains the legacy interaces for the OpenLog framework. It is being maintained only for backward compatability. The prefered interfaces may be found in com.plumtree.openkernel.log
The use OpenLog, a single file should be declared within the project that will initialize and define OpenLog parts. Let us call this class Log.
The OpenLogService object manages use of OpenLog. The first step in using OpenLog is to initialize it. This should be done from a static constructor in the Logging class. From there the OpenLog class should be used to defined components and groups -- also within the Log class.
A component is defined as a logically-related group of code. This can be anything from a single class to a collection of packages. For example, one component might be named "Plumtree.OpenLog" that reflects the entire OpenLog project. It is recommended that the component names use the <company>.<project>.<subcomponent>... naming convention to make it clearer where the code is located. Each component must belong to at least one group.
A group is a logical collection of components all related to the same thing. A group is therefore similar to a component, but whereas a component defines one area of code, a group defines mutiple areas of code all of which interact to form some software function (i.e. multiple components). For example, the Plumtree portlet stack could have many components within it such as OpenHttp, Portlets, and OpenFoundation. In this example the one group would be comprised of three components -- which could be used by multiple services such as OpenFoundation which is used in almost all groups. The advantage is the filters can be turned on and off by group. Therefore to analyze problems in the portlet stack, Info-severity tracing could be enabled on it which would propogate to all three components.
Components and groups are managed by OpenLogComponent and OpenLogGroup respectively. They should all be defined as public static final variables within the Logging class.
Log messages are actually sent by using the OpenLogger class. Each class which wants to log should create its own OpenLogger instance as a static final variable using the OpenLogService.GetLogger() factory method.