org.powertac.server

Class CompetitionSetupService

java.lang.Object

org.powertac.server.CompetitionSetupService

All Implemented Interfaces:

CompetitionSetup

@Service
public class CompetitionSetupService
extends Object
implements CompetitionSetup

Manages command-line and file processing for pre-game simulation setup. A simulation can be started in one of two ways:

• By running the process with command-line arguments as specified in PowerTacServer, or
• by calling the preGame() method to set up the environment and allow configuration of the next game, through a web (or REST) interface.

Author:

John Collins

Constructor Summary

Constructors

Constructor and Description
CompetitionSetupService() Standard constructor

Method Summary

Modifier and Type	Method and Description
String	bootSession(String bootFilename, String configFilename, String gameId, String logfileSuffix, String seedData, String weatherData)
String	bootSession(String bootFilename, String config, String game, String logSuffix, String seedData, String weatherData, String configDump) Starts a boot session with the given arguments.
void	preGame() Pre-game server setup - creates the basic configuration elements to make them accessible to the web-based game-setup functions.
void	processCmdLine(String[] args) Processes command-line arguments, which means looking for the specified script file and processing that
String	simSession(String bootData, String config, String jmsUrl, String gameId, String logfileSuffix, List<String> brokerUsernames, String seedData, String weatherData, String inputQueueName)
String	simSession(String bootData, String config, String jmsUrl, String game, String logSuffix, List<String> brokerUsernames, String seedData, String weatherData, String inputQueueName, String configOutput)

Methods inherited from class java.lang.Object

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

Constructor Detail

CompetitionSetupService

public CompetitionSetupService()

Standard constructor

Method Detail

processCmdLine

public void processCmdLine(String[] args)

Processes command-line arguments, which means looking for the specified script file and processing that

bootSession

public String bootSession(String bootFilename,
                          String config,
                          String game,
                          String logSuffix,
                          String seedData,
                          String weatherData,
                          String configDump)

Starts a boot session with the given arguments. If the bootFilename is null, then runs just far enough to dump the configuration and quits.

Specified by:

bootSession in interface CompetitionSetup

bootSession

public String bootSession(String bootFilename,
                          String configFilename,
                          String gameId,
                          String logfileSuffix,
                          String seedData,
                          String weatherData)

Specified by:

bootSession in interface CompetitionSetup

simSession

public String simSession(String bootData,
                         String config,
                         String jmsUrl,
                         String game,
                         String logSuffix,
                         List<String> brokerUsernames,
                         String seedData,
                         String weatherData,
                         String inputQueueName,
                         String configOutput)

Specified by:

simSession in interface CompetitionSetup

simSession

public String simSession(String bootData,
                         String config,
                         String jmsUrl,
                         String gameId,
                         String logfileSuffix,
                         List<String> brokerUsernames,
                         String seedData,
                         String weatherData,
                         String inputQueueName)

Specified by:

simSession in interface CompetitionSetup

preGame

public void preGame()

Pre-game server setup - creates the basic configuration elements to make them accessible to the web-based game-setup functions. This method must be called when the server is started, and again at the completion of each simulation. The actual simulation is started with a call to competitionControlService.runOnce().

Specified by:

preGame in interface CompetitionSetup