|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.iplanet.am.util.Debug
Allows a uniform interface to file debug and exception information in a
uniform format. Debug
supports different levels/states of
filing debug information (in the ascending order): OFF
,
ERROR
, WARNING
, MESSAGE
and
ON
. A given debug level/state is enabled if the debug
state/level is set to at least that state/level. For example, if the debug
state is ERROR
, only errors will be filed. If the debug state is
WARNING
, only errors and warnings will be filed. If the debug
state is MESSAGE
, everything will be filed.
MESSAGE
and ON
are of the same levels;
the difference between them being MESSAGE
writes to a file,
whereas ON
writes to System.out.
Debug service uses the property file, AMConfig.properties
, to
set the default debug level and the output directory where the debug files
will be placed. The properties file is located (using
ResourceBundle
semantics) from one of the directories
in the CLASSPATH.
The following keys are used to configure the Debug service. Possible values for the key 'com.iplanet.services.debug.level' are: off | error | warning | message. The key 'com.iplanet.services.debug.directory' specifies the output directory where the debug files will be created. Optionally, the key 'com.sun.identity.util.debug.provider' may be used to plugin a non-default implementation of the debug service where necessary.
If there is an error reading or loading the properties, Debug service will redirect all debug information tocom.iplanet.services.debug.level com.iplanet.services.debug.directory com.sun.identity.util.debug.provider
System.out
If these properties are changed, the server must be restarted for the
changes to take effect.
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. Particularly, note that Java evaluates
the arguments to message()
and warning()
even
when debugging is turned off.
It is recommended that the debug state be checked before invoking any
message()
or warning()
methods to avoid unnecessary
argument evaluation and to maximize application performance.
Field Summary | |
static int |
ERROR
flags the state where error debugging is enabled. |
static int |
MESSAGE
This state enables debugging of messages, warnings and errors. |
static int |
OFF
flags the disabled debug state. |
static int |
ON
flags the enabled debug state for warnings, errors and messages. |
static java.lang.String |
STR_ERROR
flags the state where error debugging is enabled. |
static java.lang.String |
STR_MESSAGE
This state enables debugging of messages, warnings and errors. |
static java.lang.String |
STR_OFF
flags the disabled debug state. |
static java.lang.String |
STR_ON
flags the enables debug state for warnings, errors and messages. |
static java.lang.String |
STR_WARNING
flags the state where warning debugging is enabled, but message debugging is disabled. |
static int |
WARNING
flags the state where warning debugging is enabled, but message debugging is disabled. |
Method Summary | |
void |
destroy()
Destroys the debug object, closes the debug file and releases any system resources. |
void |
error(java.lang.String msg)
Prints error messages only when debug level is greater than DEBUG.OFF. |
void |
error(java.lang.String msg,
java.lang.Throwable t)
Prints error messages only if debug state is greater than Debug.OFF. |
boolean |
errorEnabled()
Checks if error debugging is enabled. |
static Debug |
getInstance(java.lang.String debugName)
Gets an existing instance of Debug for the specified debug name or a new one if no such instance already exists. |
static java.util.Collection |
getInstances()
Returns a collection of all Debug instances that exist in the system at the current instance. |
java.lang.String |
getName()
Convinience method to query the name being used for this Debug instance. |
int |
getState()
Returns one of the five possible values: Debug.OFF Debug.ERROR Debug.WARNING Debug.MESSAGE Debug.ON |
void |
message(java.lang.String msg)
Prints messages only when the debug state is either Debug.MESSAGE or Debug.ON. |
void |
message(java.lang.String msg,
java.lang.Throwable t)
Prints debug and exception messages only when the debug state is either Debug.MESSAGE or Debug.ON. |
boolean |
messageEnabled()
Checks if message debugging is enabled. |
void |
setDebug(int debugType)
Sets the debug capabilities based on the values of the debugType argument. |
void |
setDebug(java.lang.String debugType)
Sets the debug capabilities based on the values of the debugType argument. |
void |
warning(java.lang.String msg)
Prints warning messages only when debug level is greater than Debug.ERROR. |
void |
warning(java.lang.String msg,
java.lang.Throwable t)
Prints warning messages only when debug level is greater than Debug.ERROR. |
boolean |
warningEnabled()
Checks if warning debugging is enabled. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int OFF
public static final int ERROR
ERROR
, error debugging is also disabled.public static final int WARNING
WARNING
, warning debugging is also disabled.public static final int MESSAGE
public static final int ON
public static final java.lang.String STR_OFF
public static final java.lang.String STR_ERROR
ERROR
, error debugging is also disabled.public static final java.lang.String STR_WARNING
WARNING
, warning debugging is also disabled.public static final java.lang.String STR_MESSAGE
public static final java.lang.String STR_ON
Method Detail |
public static Debug getInstance(java.lang.String debugName)
AMConfig.properties
file. The level can be changed later
by using setDebug(int)
or setDebug(String)
methods.debugName
- name of the debug instances to be createdpublic static java.util.Collection getInstances()
ConcurrentModificationException
if during the process of
iteration, the collection is modified by the system.public java.lang.String getName()
public boolean messageEnabled()
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. Particularly, note that Java
evaluates arguments to message()
even when
debugging is turned off. It is recommended that
messageEnabled()
be called to check the debug state
before invoking any message()
methods to avoid
unnecessary argument evaluation and maximize application performance.
true
if message debugging is enabled
false
if message debugging is disabledpublic boolean warningEnabled()
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. Particularly, note that Java
evaluates arguments to warning()
even when
warning debugging is turned off. It is recommended that
warningEnabled()
be called to check the debug state
before invoking any warning()
methods to avoid
unnecessary argument evaluation and maximize application performance.
true
if warning debugging is enabled
false
if warning debugging is disabledpublic boolean errorEnabled()
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. Particularly, note that Java
evaluates arguments to error()
even when
error debugging is turned off. It is recommended that
errorEnabled()
be called to check the debug state
before invoking any error()
methods to avoid
unnecessary argument evaluation and maximize application performance.
true
if error debugging is enabled
false
if error debugging is disabledpublic int getState()
public void message(java.lang.String msg)
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. Particularly, note that Java
evaluates arguments to message()
even when
debugging is turned off. So when the argument to this method involves
the String concatenation operator '+' or any other method invocation,
messageEnabled
MUST be used. It is recommended that
the debug state be checked by invoking messageEnabled()
before invoking any message()
methods to avoid
unnecessary argument evaluation and maximize application performance.
msg
- debug message.message(String, Throwable)
public void message(java.lang.String msg, java.lang.Throwable t)
Prints debug and exception messages only when the debug
state is either Debug.MESSAGE or Debug.ON. If the debug file is not
accessible and debugging is enabled, the message along with a time stamp
and thread info will be printed on System.out
.
This method creates the debug file if does not exist; otherwise it starts appending to the existing debug file. When invoked for the first time on this object, the method writes a line delimiter of '*'s.
Note that the debug file will remain open until destroy()
is invoked. To conserve file resources, you should invoke
destroy()
explicitly rather than wait for the garbage
collector to clean up.
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. Particularly, note that
Java evaluates arguments to message()
even when
debugging is turned off. It is recommended that the debug state be
checked by invoking messageEnabled()
before invoking any
message()
methods to avoid unnecessary argument evaluation
and to maximize application performance.
msg
- message to be printed. A newline will be appended to the
message before printing either to System.out
or to the debug file. If msg
is null, it is
ignored.t
- Throwable
, on which printStackTrace
will be invoked to print the stack trace. If t
is
null, it is ignored.error(String, Throwable)
public void warning(java.lang.String msg)
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. Particularly, note that
Java evaluates arguments to warning()
even when
debugging is turned off. So when the argument to this method involves
the String concatenation operator '+' or any other method invocation,
warningEnabled
MUST be used. It is recommended that
the debug state be checked by invoking warningEnabled()
before invoking any warning()
methods to avoid
unnecessary argument evaluation and to maximize application
performance.
msg
- message to be printed. A newline will be appended to the
message before printing either to System.out
or to the debug file. If msg
is null, it is
ignored.warning(String, Throwable)
public void warning(java.lang.String msg, java.lang.Throwable t)
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. Particularly, note that
Java evaluates arguments to warning()
even when
debugging is turned off. It is recommended that the debug state be
checked by invoking warningEnabled()
before invoking any
warning()
methods to avoid unnecessary argument evaluation
and to maximize application performance.
If the debug file is not accessible and debugging is enabled, the
message along with a time stamp and thread info will be printed on
System.out
.
This method creates the debug file if does not exist; otherwise it starts appending to the existing debug file. When invoked for the first time on this object, the method writes a line delimiter of '*'s.
Note that the debug file will remain open until destroy()
is invoked. To conserve file resources, you should invoke
destroy()
explicitly rather than wait for the garbage
collector to clean up.
msg
- message to be printed. A newline will be appended to the
message before printing either to System.out
or to the debug file. If msg
is null, it is
ignored.t
- Throwable
, on which printStackTrace()
will be invoked to print the stack trace. If t
is
null, it is ignored.public void error(java.lang.String msg)
msg
- message to be printed. A newline will be appended to the
message before printing either to System.out
or to the debug file. If msg
is null, it is
ignored.error(String, Throwable)
public void error(java.lang.String msg, java.lang.Throwable t)
System.out
.
This method creates the debug file if does not exist; otherwise it starts appending to the existing debug file. When invoked for the first time on this object, the method writes a line delimiter of '*'s.
Note that the debug file will remain open until destroy()
is invoked. To conserve file resources, you should invoke
destroy()
explicitly rather than wait for the garbage
collector to clean up.
msg
- message to be printed. A newline will be appended to the
message before printing either to System.out
or to the debug file. If msg
is null, it is
ignored.t
- Throwable
, on which printStackTrace()
will be invoked to print the stack trace. If t
is
null, it is ignored.public void setDebug(int debugType)
debugType
argument.debugType
- is any one of five possible values:
Debug.OFF
Debug.ERROR
Debug.WARNING
Debug.MESSAGE
Debug.ON
public void setDebug(java.lang.String debugType)
debugType
argument.debugType
- is any one of the following possible values:
Debug.STR_OFF
Debug.STR_ERROR
Debug.STR_WARNING
Debug.STR_MESSAGE
Debug.STR_ON
public void destroy()
destroy()
is invoked. To conserve file resources, you should
invoke destroy()
explicitly rather than wait for the garbage
collector to clean up.
If this object is accessed after destroy()
has been
invoked, the results are undefined.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |