| java.lang.Object
 com.sun.portal.desktop.util.PropertiesDebug
| PropertiesDebug | | public class PropertiesDebug (Code) | | Allows a uniform interface to file debug and exception information in a
uniform format. PropertiesDebug 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.
PropertiesDebug files are created in the directory specified by the property,
ps.debug.dir, in /etc/opt/SUNWportal/platform.conf file. The
default value for this property is /var/opt/SUNWportal/debug.
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 | |
| final public static int | ERROR
flags the state where error debugging is enabled. | | final public static int | MESSAGE
This state enables debugging of messages, warnings and errors. | | final public static int | OFF
flags the disabled debug state. | | final public static int | ON
flags the enabled debug state for warnings, errors and messages. | | final public static int | WARNING
flags the state where warning debugging is enabled, but message
debugging is disabled. |
| Constructor Summary | |
| public | PropertiesDebug(String debugName)
This constructor takes as an argument the name of the debug file. |
| Method Summary | |
| public boolean | debugEnabled()
Checks if message debugging is enabled. | | public void | destroy()
Destroys the debug object, closes the debug file and releases any system
resources. | | public void | error(String msg)
Prints error messages only when debug level is greater than DEBUG.OFF. | | public void | error(String msg, Throwable t)
Prints error messages only if debug state is greater than
PropertiesDebug.OFF. | | protected void | finalize()
Flushes and then closes the debug file. | | public static synchronized PropertiesDebug | getInstance(String debugName)
Gets an existing instance of PropertiesDebug for the specified debug file or a new
one if no such instance already exists. | | public int | getState()
| | public void | message(String msg)
Prints messages only when the debug state is either
DEBUG.MESSAGE or PropertiesDebug.ON.
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. | | public void | message(String msg, Throwable t)
Prints debug and exception messages only when the debug
state is either DEBUG.MESSAGE or PropertiesDebug.ON. | | public boolean | messageEnabled()
Checks if message debugging is enabled.
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. | | public void | setDebug(int debugType)
Sets the debug capabilities based on the values of the
debugType argument. | | public void | setDebug(String debugType)
Sets the debug capabilities based on the values of the
debugType argument. | | public void | warning(String msg)
Prints warning messages only when debug level is greater than
DEBUG.ERROR.
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. | | public void | warning(String msg, Throwable t)
Prints warning messages only when debug level is greater than
DEBUG.ERROR.
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. | | public boolean | warningEnabled()
Checks if warning debugging is enabled.
NOTE: Debugging is an IO intensive operation and may hurt
application performance when abused. |
| ERROR | | final public static int ERROR(Code) | | flags the state where error debugging is enabled. When debugging is set
to less than ERROR, error debugging is also disabled.
|
| MESSAGE | | final public static int MESSAGE(Code) | | This state enables debugging of messages, warnings and errors.
|
| OFF | | final public static int OFF(Code) | | flags the disabled debug state.
|
| ON | | final public static int ON(Code) | | flags the enabled debug state for warnings, errors and messages.
Printing to a file is disabled. All printing is done on System.out.
|
| WARNING | | final public static int WARNING(Code) | | flags the state where warning debugging is enabled, but message
debugging is disabled. When debugging is set to less than
WARNING, warning debugging is also disabled.
|
| PropertiesDebug | | public PropertiesDebug(String debugName)(Code) | | This constructor takes as an argument the name of the debug file. The
debug file is neither created nor opened until the first time
message(), warning() or error()
is invoked and the debug state is neither OFF nor
ON.
NOTE:The recommended and preferred method to create PropertiesDebug
objects is getInstance(String). This constructor may be
deprecated in future.
Parameters:
debugFileName - name of the debug file to create or use
See Also: PropertiesDebug.getInstance |
| debugEnabled | | public boolean debugEnabled()(Code) | | Checks if message debugging is enabled.
NOTE: It is recommended that messageEnabled()
be used instead of debugEnabled() as the former is more
intuitive.
true if message debugging is enabledfalse if message debugging is disabled
See Also: PropertiesDebug.messageEnabled |
| destroy | | public void destroy()(Code) | | Destroys the debug object, closes the debug file and releases any system
resources. 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.
If this object is accessed after destroy() has been
invoked, the results are undefined.
|
| error | | public void error(String msg, Throwable t)(Code) | | Prints error messages only if debug state is greater than
PropertiesDebug.OFF. If the debug file is not accessible and debugging is enabled,
the message along with a timestamp 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.
Parameters:
msg - message to be printed. A newline will be appended to themessage before printing either to System.outor to the debug file. If msg is null, it isignored.
Parameters:
t - Throwable, on which printStackTrace() will beinvoked to print the stack trace. If t isnull, it is ignored. |
| finalize | | protected void finalize()(Code) | | Flushes and then closes the debug file.
|
| getInstance | | public static synchronized PropertiesDebug getInstance(String debugName)(Code) | | Gets an existing instance of PropertiesDebug for the specified debug file or a new
one if no such instance already exists.
|
| getState | | public int getState()(Code) | | Returns one of the five possible values:
PropertiesDebug.OFF
PropertiesDebug.ERROR
PropertiesDebug.WARNING
PropertiesDebug.MESSAGE
PropertiesDebug.ON
|
| message | | public void message(String msg)(Code) | | Prints messages only when the debug state is either
DEBUG.MESSAGE or PropertiesDebug.ON.
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 maximize application performance.
See Also: PropertiesDebug.message(String msgThrowable t) |
| message | | public void message(String msg, Throwable t)(Code) | | Prints debug and exception messages only when the debug
state is either DEBUG.MESSAGE or PropertiesDebug.ON. If the debug file is not
accessible and debugging is enabled, the message along with a timestamp
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.
Parameters:
msg - message to be printed. A newline will be appended to themessage before printing either to System.outor to the debug file. If msg is null, it isignored.
Parameters:
t - Throwable, on which printStackTrace will beinvoked to print the stack trace. If t isnull, it is ignored.
See Also: PropertiesDebug.error(String msgThrowable t) |
| messageEnabled | | public boolean messageEnabled()(Code) | | Checks if message debugging is enabled.
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 enabledfalse if message debugging is disabled |
| setDebug | | public void setDebug(int debugType)(Code) | | Sets the debug capabilities based on the values of the
debugType argument.
Parameters:
debugType - is any one of five possible values:PropertiesDebug.OFF
PropertiesDebug.ERROR
PropertiesDebug.WARNING
PropertiesDebug.MESSAGE
PropertiesDebug.ON
|
| setDebug | | public void setDebug(String debugType)(Code) | | Sets the debug capabilities based on the values of the
debugType argument.
Parameters:
debugType - is any one of the following possible values:off - debugging is disabled on - all debugging is enabled and written toSystem.out message - message debugging is enabled and written to the debugfile warning - warning debugging is enabled and written to the debug fileerror - error debugging is enabled and written to the debug file |
| warning | | public void warning(String msg)(Code) | | Prints warning messages only when debug level is greater than
DEBUG.ERROR.
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.
See Also: PropertiesDebug.warning(String msgThrowable t) |
| warning | | public void warning(String msg, Throwable t)(Code) | | Prints warning messages only when debug level is greater than
DEBUG.ERROR.
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 debuging is enabled, the
message along with a timestamp 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.
Parameters:
msg - message to be printed. A newline will be appended to themessage before printing either to System.outor to the debug file. If msg is null, it isignored.
Parameters:
t - Throwable, on which printStackTrace() will beinvoked to print the stack trace. If t isnull, it is ignored. |
| warningEnabled | | public boolean warningEnabled()(Code) | | Checks if warning debugging is enabled.
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 enabledfalse if warning debugging is disabled |
|
|