dumpNameSpace tool

You can use the dumpNameSpace tool to dump the contents of a name space accessed through a name server. When you invoke the dumpNameSpace tool, the naming service must be active. The dumpNameSpace tool cannot dump name spaces local to the server process, such as those with java: and local: URL schemes. The local: name space contains references to enterprise beans with local interfaces. Use the name space dump utility for java:, local: and server name spaces to dump java: and local: name spaces.

Note that the server root context for the server at the specified host and port is dumped (unless a non-default starting context which precludes it is specified). The server root contexts for other servers are not dumped.

If you run the dumpNameSpace tool with security enabled, a login prompt is displayed. If you cancel the login prompt, the dumpNameSpace tool continues outbound with an "UNAUTHENTICATED" credential. Thus, by default, an "UNAUTHENTICATED" credential is used that is equivalent to the "Everyone" access authorization policy. You can modify this default setting by changing the value for the com.ibm.CSI.performClientAuthenticationRequired property to true in the install_dir/properties/sas.client.props file. When you change this property to true, rerun the dumpNameSpace tool, and cancel the login prompt, the authorization fails and the command will not continue outbound.

Command line invocation descriptions of the dumpNameSpace tool follow. This section includes sample output.

You can also access this tool through its program interface. Refer to the class com.ibm.websphere.naming.DumpNameSpace in the WebSphere Application Server API documentation.

Syntax

To invoke the tool through the command line, enter the following command from the WebSphere/AppServer/bin directory:

Platform Command
UNIX dumpNameSpace.sh [[-keyword value]...]
Windows NT dumpNameSpace [[-keyword value]...]

Parameters

The keywords and associated values for the dumpNameSpace utility follow:

-host myhost.austin.ibm.com

Indicates the bootstrap host or the WebSphere Application Server host whose name space you want to dump. The value defaults to localhost.

-port nnn

Indicates the bootstrap port which, if not specified, defaults to 2809.

-root {cell | server | node | host | legacy | tree | default}

Indicates the root context to use as the initial context for the dump. The applicable root options and default root context depend on the type of name server from which the dump is being obtained. This information is provided in the following tables.

For WebSphere Application Servers V5 or later:

cell DumpNameSpace default. Dump the tree starting at the cell root context.
server Dump the tree starting at the server root context.
node Dump the tree starting at the node root context. (Synonymous with host.)

For WebSphere Application Servers v4.0 or later:

legacy DumpNameSpace default. Dump the tree starting at the legacy root context.
host Dump the tree starting at the bootstrap host root context. (Synonymous with node.)
tree Dump the tree starting at the tree root context.

For all WebSphere Application Servers and other name servers:

default Dump the tree starting at the initial context which JNDI returns by default for that server type. This is the only -root choice that is compatible with WebSphere Application Servers prior to v4.0 and with non-WebSphere Application Server name servers.

-url some provider URL

Indicates the value for the java.naming.provider.url property used to get the initial JNDI context. This option can be used in place of the -host, -port, and -root options. If the -url option is specified, the -host, -port, and -root options are ignored.

-factory com.ibm.websphere.naming.WsnInitialContextFactory

Indicates the initial context factory to be used to get the JNDI initial context. The value defaults to: com.ibm.websphere.naming.WsnInitialContextFactory The default value generally does not need to be changed.

-startAt some/subcontext/in/the/tree

Indicates the path from the bootstrap host's root context to the top level context where the dump should begin. The utility recursively dumps subcontexts below this point. It defaults to an empty string, that is, the bootstrap host root context.

-format{jndi | ins}

Option Description
jndi The default. Displays name components as atomic strings.
ins Shows name components parsed per INS rules (id.kind).

-report {short | long}

Option Description
short The default. Dumps the binding name and bound object type. This output is also provided by JNDI Context.list().
long Dumps the binding name, bound object type, local object type, and string representation of the local object (that is, the IORs, string values, and other values that are printed).

For objects of user-defined classes to display correctly with the long report option, it may be necessary to add their containing directories to the list of directories searched. Set the environment variable WAS_USER_DIRS. The value can include one or more directories, as for example:

UNIX

WAS_USER_DIRS=/usr/classdir1:/usr/classdir2 export WAS_USER_DIRS

Windows NT

set WAS_USER_DIRS=c:\classdir1;d:\classdir2

All zip, jar, and class files in the specified directories can then be resolved by the class loader when running dumpNameSpace.

-traceString "some.package.name.to.trace.*=all=enabled"

Represents the trace string with the same format as that generated by the servers. The output is sent to the file, DumpNameSpaceTrace.out.

Related tasks
Troubleshooting name space problems
Related reference
Example: Invoking the name space dump utility
Name space dump utility for java:, local: and server name spaces
Example: Invoking the name space dump utility for java: and local: name spaces
Name space dump sample output