Module openj9.dtfjview

Package com.ibm.jvm.dtfjview.spi

Interface ISession

All Known Implementing Classes:

Session

public interface ISession

Represents a single jdmpview session which may contain multiple contexts.

Method Summary

Modifier and Type	Method	Description
void	execute(String command)	Executes the supplied command.
void	findAndSetContextWithJVM()	Convenience method which instructs the session to search through all the available contexts and set the current one to the first one it finds with a non-corrupt DTFJ JavaRuntime in it.
ISessionContextManager	getContextManager()	Get the manager which is managing this context within this session.
ICombinedContext	getCurrentContext()	The currently selected context against which commands will be executed.
IOutputManager	getOutputManager()	The instance which is managing all registered output channels.
void	setContext(int id)	Set the context within which subsequent commands will be executed.
void	setContext(ICombinedContext switchTo)	Set the context within which subsequent commands will be executed.
void	showContexts(boolean shortFormat)	Display the contexts which are present in the core file currently being analysed.

Method Details

getOutputManager

IOutputManager getOutputManager()

The instance which is managing all registered output channels.

Returns:

the manager

getCurrentContext

ICombinedContext getCurrentContext()

The currently selected context against which commands will be executed.

Returns:

the current context, it may or may not have DDR interactive support

getContextManager

ISessionContextManager getContextManager()

Get the manager which is managing this context within this session.

Returns:

the context manager

setContext

void setContext(int id)
         throws CommandException

Set the context within which subsequent commands will be executed.

Parameters:

id - context ID

Throws:

CommandException - thrown if an invalid context ID is specified

setContext

void setContext(ICombinedContext switchTo)
         throws CommandException

Set the context within which subsequent commands will be executed.

Parameters:

switchTo - the context to switch to

Throws:

CommandException - thrown if the switch fails. The underlying reason will be in the logs.

showContexts

void showContexts(boolean shortFormat)

Display the contexts which are present in the core file currently being analysed.

Parameters:

shortFormat - true for short format which just displays the first line of the java -version string

findAndSetContextWithJVM

void findAndSetContextWithJVM()

Convenience method which instructs the session to search through all the available contexts and set the current one to the first one it finds with a non-corrupt DTFJ JavaRuntime in it.

execute

void execute(String command)

Executes the supplied command. Output will be written via the IOutputManager to all registered channels.

Parameters:

command - the command and any parameters to execute.