com.ibm.security.krb5

Class Krb5Debug

  1. java.lang.Object
  2. extended bycom.ibm.security.krb5.Krb5Debug

  1. public class Krb5Debug
  2. extends java.lang.Object
Controls the output of debug information. Categorizes debugging into functional areas. Individual categories can be turned on or off without affecting other categories. If debugging is not explicitly turned off and no category is turned on, kdc top-level operations debug is output.

All debug information is output to the Java System.out, normally the standard output of the process.

Krb5Debugging is turned on or off by setting the Java property com.ibm.security.krb5.server.debug. Setting the property to all turns on debugging for all categories, and setting it to off turns off debugging completely. The property may be set to one or more of the following to turn on debugging for particular categories. Multiple categories should be comma-separated.

The property com.ibm.security.krb5.server.debug is read and the chosen categories set statically. In other words, the chosen categories are applicable to the entire JVM.

Krb5Debugging can also be controlled programatically using the set and unset methods. Any changes made affects the whole JVM.

Author:
Thomas Owusu.

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
ALL
Turns on debugging for all categories.
  1. static
  2. int
AS
DOCUMENT ME!
  1. static
  2. int
CCACHE
DOCUMENT ME!
  1. static
  2. int
CONFIG
DOCUMENT ME!
  1. static
  2. int
CRYPTO
DOCUMENT ME!
  1. static
  2. int
EXCEPTION
DOCUMENT ME!
  1. static
  2. int
KDC
DOCUMENT ME!
  1. static
  2. int
KTAB
DOCUMENT ME!
  1. static
  2. int
LAST
DOCUMENT ME!
  1. static
  2. int
OFF
DOCUMENT ME!
  1. static
  2. int
RCACHE
DOCUMENT ME!
  1. static
  2. int
TGS
DOCUMENT ME!
  1. static
  2. int
TOOL
DOCUMENT ME!
  1. static
  2. int
UTIL
DOCUMENT ME!

Constructor Summary

Constructor and Description
Krb5Debug()
The default constructor.
Krb5Debug(java.lang.String prefix)
The default constructor.

Method Summary

Modifier and Type Method and Description
  1. void
exception(int category,java.lang.Exception exc)
Prints the stack trace from the specified exception if both the specified category and exception category are enabled.
  1. static
  2. boolean
on()
Tests if debugging is on for any category.
  1. static
  2. boolean
on(int category)
Tests if debugging is on for the specified category.
  1. void
out(int category,byte[] msg)
Displays the specified message if the specified category is on.
  1. void
out(int category,java.lang.Exception exc)
Prints the the specified exception if both the specified category and exception category are enabled.
  1. void
out(int category,java.lang.String msg)
Displays the specified message if the specified category is on.
  1. void
set(int option)
Turns on debugging for the specified category.
  1. java.lang.String
toString()
Returns a sting representation of this Krb5Debug object instance.
  1. void
unset(int option)
Turns off debugging for the specified category.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALL

  1. public static final int ALL
Turns on debugging for all categories.
See Also:

OFF

  1. public static final int OFF
DOCUMENT ME!
See Also:

CCACHE

  1. public static final int CCACHE
DOCUMENT ME!
See Also:

AS

  1. public static final int AS
DOCUMENT ME!
See Also:

CONFIG

  1. public static final int CONFIG
DOCUMENT ME!
See Also:

EXCEPTION

  1. public static final int EXCEPTION
DOCUMENT ME!
See Also:

CRYPTO

  1. public static final int CRYPTO
DOCUMENT ME!
See Also:

KTAB

  1. public static final int KTAB
DOCUMENT ME!
See Also:

KDC

  1. public static final int KDC
DOCUMENT ME!
See Also:

RCACHE

  1. public static final int RCACHE
DOCUMENT ME!
See Also:

TGS

  1. public static final int TGS
DOCUMENT ME!
See Also:

TOOL

  1. public static final int TOOL
DOCUMENT ME!
See Also:

UTIL

  1. public static final int UTIL
DOCUMENT ME!
See Also:

LAST

  1. public static final int LAST
DOCUMENT ME!
See Also:

Constructor Detail

Krb5Debug

  1. public Krb5Debug()
The default constructor. It sets debug options from the com.ibm.security.krb5.server.debug property.

Krb5Debug

  1. public Krb5Debug(java.lang.String prefix)
The default constructor. It sets debug options from the com.ibm.security.krb5.server.debug property.
Parameters:
prefix - DOCUMENT ME!

Method Detail

out

  1. public void out(int category,
  2. java.lang.String msg)
Displays the specified message if the specified category is on. The message is displayed as a string as-is.
Parameters:
category - DOCUMENT ME!
msg - DOCUMENT ME!

out

  1. public void out(int category,
  2. byte[] msg)
Displays the specified message if the specified category is on. The message is displayed in classic hex-dump format.
Parameters:
category - DOCUMENT ME!
msg - DOCUMENT ME!

on

  1. public static boolean on()
Tests if debugging is on for any category.
Returns:
true if debugging is on.

on

  1. public static boolean on(int category)
Tests if debugging is on for the specified category.
Parameters:
category - DOCUMENT ME!
Returns:
true if debugging is on for the specified category.

set

  1. public void set(int option)
Turns on debugging for the specified category.
Parameters:
option - DOCUMENT ME!

unset

  1. public void unset(int option)
Turns off debugging for the specified category. Unsetting ALL will turn off debugging.
Parameters:
option - DOCUMENT ME!

toString

  1. public java.lang.String toString( )
Returns a sting representation of this Krb5Debug object instance. The string includes the debug categories that are on.
Overrides:
toString in class java.lang.Object
Returns:
DOCUMENT ME!

out

  1. public void out(int category,
  2. java.lang.Exception exc)
Prints the the specified exception if both the specified category and exception category are enabled.
Parameters:
category - DOCUMENT ME!
exc - DOCUMENT ME!

exception

  1. public void exception(int category,
  2. java.lang.Exception exc)
Prints the stack trace from the specified exception if both the specified category and exception category are enabled.
Parameters:
category - DOCUMENT ME!
exc - DOCUMENT ME!