org.alfresco.bm.app

Class AbstractCommandContext

java.lang.Object

org.alfresco.bm.app.AbstractCommandContext

All Implemented Interfaces:

CommandContext, org.alfresco.bm.server.ConfigConstants

Direct Known Subclasses:

ConfirmCommandContext, EntryCommandContext, ExitCommandContext

public abstract class AbstractCommandContext
extends Object
implements CommandContext, org.alfresco.bm.server.ConfigConstants

Basic command context support.

Version:

1.2

Author:

Derek Hulley

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.bm.server.ConfigConstants

org.alfresco.bm.server.ConfigConstants.RunState

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CMD_EXIT
protected static String	CMD_HELP
protected static String	CMD_HELP_SHORT

Fields inherited from interface org.alfresco.bm.server.ConfigConstants

DEFAULT_RUNSTATE, DEFAULT_SERVER_ID, EXT_JAR, EXT_PROPERTIES, EXT_XML, PATH_CLASSES, PATH_CLUSTER_PROPERTIES, PATH_CLUSTERS, PATH_CONFIG, PATH_JARS, PATH_LOADED, PATH_RUN_PROPERTIES, PATH_RUNS, PATH_SERVER, PATH_SERVERS, PATH_TEST_CONTEXT, PATH_TEST_PROPERTIES, PATH_TESTS, PROP_CLUSTER, PROP_CONTROL_RUN_STATE, PROP_EVENTS_THREAD_COUNT, PROP_EVENTS_THREAD_EVENTSPERSECONDPERTHREAD, PROP_EVENTS_THREAD_WAITFORCOMPLETION, PROP_HTTP_CONNECTION_MAX, PROP_HTTP_CONNECTION_TIMEOUT_MS, PROP_HTTP_SOCKET_TIMEOUT_MS, PROP_HTTP_SOCKET_TTL_MS, PROP_MONGO_AUTOCONNECTRETRY, PROP_MONGO_CONNECTIONSPERHOST, PROP_MONGO_SOCKETTIMEOUT, PROP_MONGO_URI, PROP_MONGO_WRITENUMBER, PROP_SERVER_ID, PROP_TEST_NAME, PROP_TEST_RUN_FQN, PROP_TEST_RUN_NAME, SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCommandContext() Common initialization

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addPathElementsLocation(List<String> pathElements) Help build path elements.
CommandContext	executeCommand(String command) For this to have been called, we have to assume that the command has not been recognized further down the hierarchy.
protected TreeMap<String,String>	getCommands() Override to provide a set of available commands
protected File	getCurrentDir() Get the current user directory for file selection operations
String	getLocation() Get the current path for the command context
protected Map<String,String>	getOrderedProperties(Properties props) Helper method to order properties by key
protected void	setCurrentDir(File file) Set the current user directory for file selection operations

Methods inherited from class java.lang.Object

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

Field Detail

CMD_HELP

protected static final String CMD_HELP

See Also:

Constant Field Values

CMD_HELP_SHORT

protected static final String CMD_HELP_SHORT

See Also:

Constant Field Values

CMD_EXIT

protected static final String CMD_EXIT

See Also:

Constant Field Values

Constructor Detail

AbstractCommandContext

protected AbstractCommandContext()

Common initialization

Method Detail

getCommands

protected TreeMap<String,String> getCommands()

Override to provide a set of available commands

Returns:

a set of commands that can be executed

getCurrentDir

protected File getCurrentDir()

Get the current user directory for file selection operations

setCurrentDir

protected void setCurrentDir(File file)

Set the current user directory for file selection operations

getLocation

public String getLocation()

Get the current path for the command context

Specified by:

getLocation in interface CommandContext

Returns:

the current path

addPathElementsLocation

protected abstract void addPathElementsLocation(List<String> pathElements)

Help build path elements.

Implementing classes should call superclasses first in most cases.

Parameters:

pathElements - elements to append to

executeCommand

public CommandContext executeCommand(String command)

For this to have been called, we have to assume that the command has not been recognized further down the hierarchy.

Specified by:

executeCommand in interface CommandContext

Parameters:

command - the command to execute

Returns:

the post-execution command context

getOrderedProperties

protected Map<String,String> getOrderedProperties(Properties props)

Helper method to order properties by key