com.ibm.websphere.naming

Class DumpNameSpace

  1. java.lang.Object
  2. extended bycom.ibm.websphere.naming.DumpNameSpace

  1. public class DumpNameSpace
  2. 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.


Nested Class Summary

Modifier and Type Class and Description
  1. static class
DumpNameSpace.ReportFormat

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
BAD_EXIT_STATUS_NO_STARTING_CONTEXT
System exit with 1 -- Error in getting starting context.
  1. static
  2. int
BAD_EXIT_STATUS_WITH_BAD_OPTION
System exit with 3 -- Bad option specified.
  1. static
  2. int
BAD_EXIT_STATUS_WITH_ERROR
System exit with 2 -- Other error occured with exception.
  1. static
  2. java.lang.String
BUNDLE_NAME
  1. static
  2. int
LONG
Deprecated.
  1. static
  2. int
NORMAL_EXIT_STATUS
System exit with 0.
  1. static
  2. int
SHORT
Deprecated.

Constructor Summary

Constructor and Description
DumpNameSpace()
Creates a DumpNameSpace instance which prints name space dumps in short format to System.out.
DumpNameSpace(java.io.PrintStream outStream,DumpNameSpace.ReportFormat reportFormat)
Creates a DumpNameSpace instance which prints name space dumps in the specified report format to the specified print stream.
DumpNameSpace(java.io.PrintStream outStream,int reportFormat)
Deprecated.

Method Summary

Modifier and Type Method and Description
  1. void
generateDump(javax.naming.Context ctx)
Generates a name space dump starting at the specified context.
  1. static
  2. void
main(java.lang.String[] arguments)
This method is used to generate name space dumps from the command line.
  1. java.lang.String
toString()
Returns a string representation of this object.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SHORT

  1. @Deprecated
  2. public static final int SHORT
Deprecated.
Constant used to specify short reports. In a short report, the binding name and bound object type are printed.
See Also:

LONG

  1. @Deprecated
  2. public static final int LONG
Deprecated.
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.
See Also:

NORMAL_EXIT_STATUS

  1. public static final int NORMAL_EXIT_STATUS
System exit with 0.
See Also:

BAD_EXIT_STATUS_NO_STARTING_CONTEXT

  1. public static final int BAD_EXIT_STATUS_NO_STARTING_CONTEXT
System exit with 1 -- Error in getting starting context.
See Also:

BAD_EXIT_STATUS_WITH_ERROR

  1. public static final int BAD_EXIT_STATUS_WITH_ERROR
System exit with 2 -- Other error occured with exception.
See Also:

BAD_EXIT_STATUS_WITH_BAD_OPTION

  1. public static final int BAD_EXIT_STATUS_WITH_BAD_OPTION
System exit with 3 -- Bad option specified.
See Also:

BUNDLE_NAME

  1. public static final java.lang.String BUNDLE_NAME
See Also:

Constructor Detail

DumpNameSpace

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

DumpNameSpace

  1. @Deprecated
  2. public DumpNameSpace( java.io.PrintStream outStream,
  3. int reportFormat)
Deprecated.
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.

DumpNameSpace

  1. public DumpNameSpace(java.io.PrintStream outStream,
  2. DumpNameSpace.ReportFormat 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.

Method Detail

main

  1. public static void main(java.lang.String[] arguments)
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".

generateDump

  1. 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.

toString

  1. public java.lang.String toString( )
Returns a string representation of this object.
Overrides:
toString in class java.lang.Object
Returns:
a string representation of this object.