IDebug (OpenAM Project 15.1.7-SNAPSHOT API)

All Known Implementing Classes:

DebugImpl
```
public interface IDebug
```
Allows a pluggable implementation of the Debug service within the Access Manager SDK. The implementation of this interface as well as the com.sun.identity.shared.debug.IDebugProvider interface together provide the necessary functionality to replace or enhance the Debug service.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ERROR` Deprecated. use `DebugLevel` instead.
`static int`	`MESSAGE` Deprecated. use `DebugLevel` instead.
`static int`	`OFF` Deprecated. use `DebugLevel` instead.
`static int`	`ON` Deprecated. use `DebugLevel` instead.
`static String`	`STR_ERROR` Deprecated. use `DebugLevel` instead.
`static String`	`STR_MESSAGE` Deprecated. use `DebugLevel` instead.
`static String`	`STR_OFF` Deprecated. use `DebugLevel` instead.
`static String`	`STR_ON` Deprecated. use `DebugLevel` instead.
`static String`	`STR_WARNING` Deprecated. use `DebugLevel` instead.
`static int`	`WARNING` Deprecated. use `DebugLevel` instead.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`error(String message, Throwable th)` Allows the recording of messages if the debug level is set to `ERROR` or higher for this instance.
`boolean`	`errorEnabled()` Returns `true` if the current instances allows logging of `ERROR` level debug messages.
`String`	`getName()` Returns the name of the IDebug instance.
`int`	`getState()` Returns current debug level used by this instance.
`void`	`message(String message, Throwable th)` Allows the recording of messages if the debug level is set to `MESSAGE` for this instance.
`boolean`	`messageEnabled()` Returns `true` if the current instance allows logging of `MESSAGE` level debug messages.
`void`	`resetDebug(String mf)` Allows runtime modification of the backend used by this instance.
`void`	`setDebug(int level)` Allows runtime modification of the debug level used by this instance.
`void`	`setDebug(String level)` Allows runtime modification of the debug level used by this instance.
`void`	`warning(String message, Throwable th)` Allows the recording of messages if the debug level is set to `WARNING` or higher for this instance.
`boolean`	`warningEnabled()` Returns `true` if the current instance allows logging of `WARNING` level debug messages.

- Field Detail
  - OFF
```
@Deprecated
static final int OFF
```
    Deprecated. use DebugLevel instead.
  - ERROR
```
@Deprecated
static final int ERROR
```
    Deprecated. use DebugLevel instead.
  - WARNING
```
@Deprecated
static final int WARNING
```
    Deprecated. use DebugLevel instead.
  - MESSAGE
```
@Deprecated
static final int MESSAGE
```
    Deprecated. use DebugLevel instead.
  - ON
```
@Deprecated
static final int ON
```
    Deprecated. use DebugLevel instead.
  - STR_OFF
```
@Deprecated
static final String STR_OFF
```
    Deprecated. use DebugLevel instead.
  - STR_ERROR
```
@Deprecated
static final String STR_ERROR
```
    Deprecated. use DebugLevel instead.
  - STR_WARNING
```
@Deprecated
static final String STR_WARNING
```
    Deprecated. use DebugLevel instead.
  - STR_MESSAGE
```
@Deprecated
static final String STR_MESSAGE
```
    Deprecated. use DebugLevel instead.
  - STR_ON
```
@Deprecated
static final String STR_ON
```
    Deprecated. use DebugLevel instead.
- Method Detail
  - getName
```
String getName()
```
    Returns the name of the IDebug instance. The value is exactly equal to the one that was first used to create this instance.
    
    Returns:
    
    name of this IDebug instance
  - getState
```
int getState()
```
    Returns current debug level used by this instance. The value is an integer equals to one of the various debug level integers as defined in the class com.iplanet.am.util.Debug. This value could be one of the followings:
    - OFF
    - ERROR
    - WARNING
    - MESSAGE
    - ON
    Returns:
    
    an integer indicating the debug level used by this instance.
  - setDebug
```
void setDebug(int level)
```
    Allows runtime modification of the debug level used by this instance. The argument level must be an integer exactly equal to one of the debug level integers as defined in the class com.iplanet.am.util.Debug. This value could be one of the following:
    - OFF
    - ERROR
    - WARNING
    - MESSAGE
    - ON
    Parameters:
    
    level - An integer indicating the debug level to be used by this instance.
  - resetDebug
```
void resetDebug(String mf)
```
    Allows runtime modification of the backend used by this instance. by resetting the debug instance to reinitialize itself. NB : The debug file associated with this debug won't be closed. Because of merge, a debug file could be used by more than one debug instances.
    
    Parameters:
    
    mf - merge flag, on to create a single debug file
  - setDebug
```
void setDebug(String level)
```
    Allows runtime modification of the debug level used by this instance. The argument level must be a string which should exactly match the string definitions of debug level as defined in the class com.iplanet.am.util.Debug. This value could be one of the following:
    - STR_OFF
    - STR_ERROR
    - STR_WARNING
    - STR_MESSAGE
    - STR_ON
    Parameters:
    
    level - String representing the debug level to be used by this instance.
  - messageEnabled
```
boolean messageEnabled()
```
    Returns true if the current instance allows logging of MESSAGE level debug messages.
    
    Returns:
    
    true if MESSAGE level debugging is enabled.
  - warningEnabled
```
boolean warningEnabled()
```
    Returns true if the current instance allows logging of WARNING level debug messages.
    
    Returns:
    
    true if WARNING level debugging is enabled.
  - errorEnabled
```
boolean errorEnabled()
```
    Returns true if the current instances allows logging of ERROR level debug messages.
    
    Returns:
    
    true if ERROR level debugging is enabled.
  - message
```
void message(String message,
             Throwable th)
```
    Allows the recording of messages if the debug level is set to MESSAGE for this instance.
    
    Parameters:
    
    message - Message to be recorded.
    
    th - The optional java.lang.Throwable which if present will be used to record the stack trace.
  - warning
```
void warning(String message,
             Throwable th)
```
    Allows the recording of messages if the debug level is set to WARNING or higher for this instance.
    
    Parameters:
    
    message - Message to be recorded.
    
    th - The optional java.lang.Throwable which if present will be used to record the stack trace.
  - error
```
void error(String message,
           Throwable th)
```
    Allows the recording of messages if the debug level is set to ERROR or higher for this instance.
    
    Parameters:
    
    message - Message to be recorded.
    
    th - the optional java.lang.Throwable which if present will be used to record the stack trace.

Interface IDebug

Field Summary

Method Summary

Field Detail

OFF

ERROR

WARNING

MESSAGE

ON

STR_OFF

STR_ERROR

STR_WARNING

STR_MESSAGE

STR_ON

Method Detail

getName

getState

setDebug

resetDebug

setDebug

messageEnabled

warningEnabled

errorEnabled

message

warning

error