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.

    • Constructor Summary

      Constructors 
      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

      Methods 
      Modifier and Type Method and Description
      void generateDump(javax.naming.Context ctx)
      Generates a name space dump starting at the specified context.
      static void main(java.lang.String[] arguments)
      This method is used to generate name space dumps from the command line.
      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

        @Deprecated
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:
        Constant Field Values

      • LONG

        @Deprecated
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:
        Constant Field Values

      • NORMAL_EXIT_STATUS

        public static final int NORMAL_EXIT_STATUS
        System exit with 0.
        See Also:
        Constant Field Values

      • BAD_EXIT_STATUS_NO_STARTING_CONTEXT

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

      • BAD_EXIT_STATUS_WITH_ERROR

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

      • BAD_EXIT_STATUS_WITH_BAD_OPTION

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

    • Constructor Detail

      • DumpNameSpace

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

      • DumpNameSpace

        @Deprecated
public DumpNameSpace(java.io.PrintStream outStream,
                        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

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

        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

        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

        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.
IBM WebSphere Application ServerTM
Release 8.5