Package repast.simphony.batch.ssh
Class LocalSession
java.lang.Object
repast.simphony.batch.ssh.LocalSession
- All Implemented Interfaces:
Session
- Author:
- Nick Collier
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
copyCompletionStatus
(String outDirectory) Copies the completion status from the host and directory where the model was run to the specified directory.createDonePoller
(long frequency) Create a callable that returns with the model run by this Session is finished.findOutput
(List<OutputPattern> patterns) Finds the model output that is the result of running this Session and returns those files.getHost()
Gets the name or ip address of the remote host.getId()
Gets the id (user@host) of this Remote.getInput()
Gets the file that contains parameter input for this Session.int
Gets the number of model instances to run on this Remote.getStatus
(int instance) Gets the status of the specified instance.getUser()
Gets the user account used to log into the remote host.void
initModelArchive
(Configuration config, String directory) Initializes the model for running.void
Retrieves the run completion status (e.g.void
runModel()
Runs the model for this Session.void
Sets the file that contains the parameter input for this Session.void
setRunStatus
(int instance, RunningStatus status) Sets the run status for the specified instance on this Remote.
-
Constructor Details
-
LocalSession
public LocalSession()
-
-
Method Details
-
getHost
Description copied from interface:Session
Gets the name or ip address of the remote host. -
getUser
Description copied from interface:Session
Gets the user account used to log into the remote host. -
getId
Description copied from interface:Session
Gets the id (user@host) of this Remote. -
getInstances
public int getInstances()Description copied from interface:Session
Gets the number of model instances to run on this Remote.- Specified by:
getInstances
in interfaceSession
- Returns:
- the number of model instances to run on this Remote.
-
getInput
Description copied from interface:Session
Gets the file that contains parameter input for this Session. -
setInput
Description copied from interface:Session
Sets the file that contains the parameter input for this Session. -
setRunStatus
Description copied from interface:Session
Sets the run status for the specified instance on this Remote.- Specified by:
setRunStatus
in interfaceSession
- Parameters:
instance
- the instance idstatus
- the status
-
getStatus
Description copied from interface:Session
Gets the status of the specified instance. -
createDonePoller
Description copied from interface:Session
Create a callable that returns with the model run by this Session is finished.- Specified by:
createDonePoller
in interfaceSession
- Returns:
- a callable that returns with the model run by this Session is finished.
-
copyCompletionStatus
Description copied from interface:Session
Copies the completion status from the host and directory where the model was run to the specified directory.- Specified by:
copyCompletionStatus
in interfaceSession
- Throws:
StatusException
-
findOutput
Finds the model output that is the result of running this Session and returns those files. In the case of remote output the output may be copied to local temporary location. The patterns used to identify output is specified in the filePatterns parameters.- Specified by:
findOutput
in interfaceSession
- Parameters:
patterns
- the OutputPatterns of the files to find.- Returns:
- the location of the output in a list of MatchedFiles. Each MatchedFiles object holds one or more files for a specific match.
- Throws:
StatusException
-
retrieveRunCompletionStatus
Description copied from interface:Session
Retrieves the run completion status (e.g. FAILURE) and sets it for this Session.- Specified by:
retrieveRunCompletionStatus
in interfaceSession
- Throws:
StatusException
-
runModel
Description copied from interface:Session
Runs the model for this Session.- Specified by:
runModel
in interfaceSession
- Throws:
SessionException
-
initModelArchive
public void initModelArchive(Configuration config, String directory) throws ModelArchiveConfiguratorException, SessionException Initializes the model for running. This configures the model archive for this Session and copies it over to the remote host.- Specified by:
initModelArchive
in interfaceSession
- Parameters:
directory
- the directory to copy the model archive into- Throws:
ModelArchiveConfiguratorException
SessionException
-