systemExplorer
Class SystemExplorer

java.lang.Object
  systemExplorer.SystemExplorer

public class SystemExplorer
extends Object

This class is a command-line application that allows the user to exercise GemFire's admin API.

Since:

3.5

Author:

GemStone Systems, Inc.

Constructor Summary

SystemExplorer()

Method Summary

(package private) void	cache(String command) Selects the member's SystemMemberCache.
(package private) void	cacheserver(String command) Selects the indicated CacheServer entity if it exists.
(package private) void	createRootRegion(String command) Creates the named root Region in the current cache.
(package private) void	createSubRegion(String command) Creates the named subRegion of the current region.
(package private) void	defineLocator(String command) Defines a DistributionLocator so this example can manipulate it.
(package private) CacheServer	findCacheServer(String name) Finds the named CacheServer under the current context.
(package private) DistributionLocator	findLocator(String id) Finds the named DistributionLocator under the current context.
(package private) SystemMember	findMember(String name) Finds the named SystemMember under the current context.
(package private) StatisticResource	findStatisticResource(String name) Finds the named StatisticResource under the current context.
(package private) SystemMemberRegion	findSystemMemberRegion(String name) Finds the named SystemMemberRegion under the current context.
(package private) void	go() Prompts the user for input and executes the command accordingly.
(package private) void	initialize(String propsFileName) Initializes the DistributedSystem for this example program.
(package private) void	list(String command) Lists the details for the currently selected admin entity.
(package private) void	listCacheServer() Lists the details for a CacheServer.
(package private) void	listDistributedSystem() Lists the details for the DistributedSystem.
(package private) void	listDistributionLocator() Lists the details for a DistributionLocator.
(package private) void	listStatisticResource() Lists the details for a StatisticResource.
(package private) void	listSystemMember() Lists the details for a SystemMember.
(package private) void	listSystemMemberCache() Lists the details for a SystemMemberCache.
(package private) void	listSystemMemberRegion() Lists the details for a SystemMemberRegion.
(package private) void	locator(String command) Selects the named DistributionLocator entity if it exists.
static void	main(String[] args) Parses the command line and runs the SystemExplorer example.
(package private) void	member(String command) Selects the named SystemMember entity if it exists.
(package private) void	region(String command) Selects the named SystemMemberRegion entity if it exists.
(package private) void	showHelp() Prints information on how this program should be used.
(package private) void	showPrompt() Shows the user prompt from the currently selected entity.
(package private) void	start(String command) Starts the currently selected administrative entity.
(package private) void	stat(String command) Selects the named StatisticResource entity if it exists.
(package private) void	stop(String command) Stops the currently selected administrative entity.
(package private) void	system(String command) Selects the DistributedSystem entity if it exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemExplorer

public SystemExplorer()

Method Detail

showHelp

void showHelp()

Prints information on how this program should be used.

initialize

void initialize(String propsFileName)
          throws Exception

Initializes the DistributedSystem for this example program.

Throws:

Exception

main

public static void main(String[] args)
                 throws Exception

Parses the command line and runs the SystemExplorer example.

Throws:

Exception

go

void go()
  throws IOException

Prompts the user for input and executes the command accordingly.

Throws:

IOException

showPrompt

void showPrompt()

Shows the user prompt from the currently selected entity.

list

void list(String command)
    throws AdminException

Lists the details for the currently selected admin entity.

Throws:

AdminException

defineLocator

void defineLocator(String command)
             throws AdminException

Defines a DistributionLocator so this example can manipulate it.

Throws:

AdminException

start

void start(String command)
     throws AdminException

Starts the currently selected administrative entity.

Throws:

AdminException

stop

void stop(String command)
    throws AdminException

Stops the currently selected administrative entity.

Throws:

AdminException

system

void system(String command)
      throws AdminException

Selects the DistributedSystem entity if it exists.

Throws:

AdminException

member

void member(String command)
      throws AdminException

Selects the named SystemMember entity if it exists.

Throws:

AdminException

cacheserver

void cacheserver(String command)
           throws AdminException

Selects the indicated CacheServer entity if it exists.

Throws:

AdminException

locator

void locator(String command)
       throws AdminException

Selects the named DistributionLocator entity if it exists.

Throws:

AdminException

stat

void stat(String command)
    throws AdminException

Selects the named StatisticResource entity if it exists.

Throws:

AdminException

cache

void cache(String command)
     throws AdminException

Selects the member's SystemMemberCache.

Throws:

AdminException

createRootRegion

void createRootRegion(String command)
                throws AdminException

Creates the named root Region in the current cache.

Throws:

AdminException

createSubRegion

void createSubRegion(String command)
               throws AdminException

Creates the named subRegion of the current region.

Throws:

AdminException

region

void region(String command)
      throws AdminException

Selects the named SystemMemberRegion entity if it exists.

Throws:

AdminException

listDistributedSystem

void listDistributedSystem()

Lists the details for the DistributedSystem.

listDistributionLocator

void listDistributionLocator()

Lists the details for a DistributionLocator.

listCacheServer

void listCacheServer()

Lists the details for a CacheServer.

listSystemMember

void listSystemMember()

Lists the details for a SystemMember.

listSystemMemberCache

void listSystemMemberCache()

Lists the details for a SystemMemberCache.

listSystemMemberRegion

void listSystemMemberRegion()

Lists the details for a SystemMemberRegion.

listStatisticResource

void listStatisticResource()

Lists the details for a StatisticResource.

findSystemMemberRegion

SystemMemberRegion findSystemMemberRegion(String name)
                                    throws AdminException

Finds the named SystemMemberRegion under the current context.

Throws:

AdminException

findStatisticResource

StatisticResource findStatisticResource(String name)
                                  throws AdminException

Finds the named StatisticResource under the current context.

Throws:

AdminException

findMember

SystemMember findMember(String name)
                  throws AdminException

Finds the named SystemMember under the current context.

Throws:

AdminException

findCacheServer

CacheServer findCacheServer(String name)
                      throws AdminException

Finds the named CacheServer under the current context.

Throws:

AdminException

findLocator

DistributionLocator findLocator(String id)
                          throws AdminException

Finds the named DistributionLocator under the current context.

Throws:

AdminException