co.ecg.alpaca.toolkit.shell.locations

Class ServiceProviderLocation

java.lang.Object

co.ecg.alpaca.toolkit.shell.locations.Location

co.ecg.alpaca.toolkit.shell.locations.ServiceProviderLocation

All Implemented Interfaces:

LocationCommandInterface

public class ServiceProviderLocation
extends Location
implements LocationCommandInterface

Field Summary

Fields

Modifier and Type	Field and Description
static HashMap<TreeNode<String>,Command>	commandTreeToCommandMap
static TreeNode<String>	locationCommandTree

Constructor Summary

Constructors

Constructor and Description
ServiceProviderLocation(ServerLocation server, ServiceProvider serviceProvider) Creates a ServiceProvider location with the provided server location and backing ServiceProvider.

Method Summary

Modifier and Type	Method and Description
static void	addCommandToTree(Command command)
void	displayHelp() Command help description.
int	execute(List<String> args) Executes this command.
Location	getChildLocation(String locationName)
ServiceProvider	getServiceProvider()
void	populateChildren()
void	refresh()
String	toString()

Methods inherited from class co.ecg.alpaca.toolkit.shell.locations.Location

addCommandToTree, execute, getAlpaca, getBroadWorksServer, getChildren, getCommandTree, getCommandTreeMap, getConnection, getName, getParent, getPwd, getRootLocationCommandMap, getRootLocationCommandTree, isSystem, isValid, println, pwd, reset, setChildren, setCommandMap, setCommands, setConnection, setIsValid, setName, setParent, setPwd

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.ecg.alpaca.toolkit.shell.locations.interfaces.LocationCommandInterface

getChildren, getCommandTree, getCommandTreeMap, getName, getParent, getPwd, isSystem, pwd, reset

Field Detail

locationCommandTree

public static TreeNode<String> locationCommandTree

commandTreeToCommandMap

public static HashMap<TreeNode<String>,Command> commandTreeToCommandMap

Constructor Detail

ServiceProviderLocation

public ServiceProviderLocation(ServerLocation server,
                               ServiceProvider serviceProvider)

Creates a ServiceProvider location with the provided server location and backing ServiceProvider.

Parameters:

server - The server location

serviceProvider - The backing ServiceProvider

Method Detail

addCommandToTree

public static void addCommandToTree(Command command)

displayHelp

public void displayHelp()

Description copied from interface: LocationCommandInterface

Command help description.

Specified by:

displayHelp in interface LocationCommandInterface

Overrides:

displayHelp in class Location

execute

public int execute(List<String> args)
            throws AlpacaException

Description copied from interface: LocationCommandInterface

Executes this command.

Specified by:

execute in interface LocationCommandInterface

Overrides:

execute in class Location

Throws:

AlpacaException

getChildLocation

public Location getChildLocation(String locationName)

Specified by:

getChildLocation in class Location

getServiceProvider

public ServiceProvider getServiceProvider()

populateChildren

public void populateChildren()

Specified by:

populateChildren in interface LocationCommandInterface

toString

public String toString()

Overrides:

toString in class Object

refresh

public void refresh()
             throws BroadWorksObjectException

Specified by:

refresh in class Location

Throws:

BroadWorksObjectException