com.ibm.websphere.naming
Class DumpNameSpace

java.lang.Object
  |
  +--com.ibm.websphere.naming.DumpNameSpace

public class DumpNameSpace

extends java.lang.Object

This class is used to dump the contents of a WebSphere name space. It can be invoked from the command line or from a Java program.

There are two report formats: short and long. In a short report, the binding name and bound object type are printed. In a long report, the binding name, bound object type, local object type, and string representation of the local object are printed.

For details on command line options execute this class from the command line with the option "-help". WebSphere includes the script file dumpNameSpace.sh (dumpNameSpace.bat on Windows) to run this program.

For details on invoking this class from a command line, see the constructor and method descriptions below.

Field Summary

static java.lang.String	BUNDLE_NAME
static int	LONG Constant used to specify long reports.
static int	SHORT Constant used to specify short reports.

Constructor Summary

DumpNameSpace()
Creates a DumpNameSpace instance which prints name space dumps in short format to System.out.

DumpNameSpace(java.io.PrintStream outStream, int reportFormat)
Creates a DumpNameSpace instance which prints name space dumps in the specified report format to the specified print stream.

Method Summary

void	javax.naming.Context)">generateDump(javax.naming.Context ctx) Generates a name space dump starting at the specified context.
static void	main(java.lang.String[] args) This method is used to generate name space dumps from the command line.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHORT

public static final int SHORT

Constant used to specify short reports. In a short report, the binding name and bound object type are printed.

LONG

public static final int LONG

Constant used to specify long reports. In a long report, the binding name, bound object type, local object type, and string representation of the local object are printed.

BUNDLE_NAME

public static final java.lang.String BUNDLE_NAME

Constructor Detail

DumpNameSpace

public DumpNameSpace()

Creates a DumpNameSpace instance which prints name space dumps in short format to System.out.

DumpNameSpace

public DumpNameSpace(java.io.PrintStream outStream,
                     int reportFormat)

Creates a DumpNameSpace instance which prints name space dumps in the specified report format to the specified print stream.

Parameters:

outStream - The print stream to which the dump is written. If a null vaue is specified, System.out is used.

reportFormat - Indicates whether to use a short or long report format. Valid values are DumpNameSpace.SHORT and DumpNameSpace.LONG. If any other value is specified, DumpNameSpace.SHORT is used.

Method Detail

main

public static void main(java.lang.String[] args)

This method is used to generate name space dumps from the command line. For more information on the command line syntax, execute this class from the command line with the option "-help".

javax.naming.Context)">

generateDump

public void generateDump(javax.naming.Context ctx)

Generates a name space dump starting at the specified context.

Parameters:

ctx - The context with which to start the name space dump. It can be the initial context or any other context in the name space.