TPTP 4.6.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.probekit.launch.launchpad
Class LaunchPad

java.lang.Object
  extended by org.eclipse.tptp.platform.probekit.launch.launchpad.LaunchPad

public class LaunchPad
extends java.lang.Object


Constructor Summary
LaunchPad()
          Constructor
 
Method Summary
 void addFilter(java.lang.String filterString)
          Add a filter to the LaunchPad filter list.
 void agentActive(TRCAgentProxy agentProxy)
          This method is called by the Workbench extension point to notify the launchpad that the agent is active and is about to get resumed.
 void clearFilters()
          Clear all probe filters.
 void deployClass(byte[] classBuffer, java.lang.String className)
          Deploy a class into the running process over the RAC connection
 void deployClass(java.io.File classFile)
          Deploys a class from the supplied file into a running process over the RAC connection
 void deployProbe(ProbeRegistryEntry probeRegistryEntry)
          Depolys a probe given a probe registry entry.
 void deployProbeScript(byte[] probeScriptBuffer)
          Deploy a class into the running process over the RAC connection
 void deployProbeScript(java.io.File probeScriptFile)
          Deploy a probe script into the running process over the RAC connection
 void sendFilters(java.lang.String[] filterStrings)
          Send a filter to the Agent Extension for using in the agent extension callback filtering.
 void setAgent(org.eclipse.hyades.internal.execution.local.control.Agent agent)
          Set the Hyades profiling agent.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LaunchPad

public LaunchPad()
Constructor

Method Detail

deployProbeScript

public void deployProbeScript(byte[] probeScriptBuffer)
                       throws LaunchPadException
Deploy a class into the running process over the RAC connection

Parameters:
probeScriptBuffer - - byte array with raw script bytes
Throws:
LaunchPadException

deployProbeScript

public void deployProbeScript(java.io.File probeScriptFile)
                       throws LaunchPadException
Deploy a probe script into the running process over the RAC connection

Parameters:
probeScriptFile -
Throws:
LaunchPadException

setAgent

public void setAgent(org.eclipse.hyades.internal.execution.local.control.Agent agent)
Set the Hyades profiling agent. Probes will be later deployed to this agent.

Parameters:
agent - - Hyades profiling agent

clearFilters

public void clearFilters()
Clear all probe filters. If no filters are defined by the LaunchPad then the filter set from the probe script will take effect. Otherwise filters from the launcher will replace the original filters in the script.


addFilter

public void addFilter(java.lang.String filterString)
Add a filter to the LaunchPad filter list. These filters will override the original filters from the script. The filter string is defined in the following format: filter ::= [":" method [":" signature ]] ":" action action ::= "INCLUDE"|"EXCLUDE" pkg_and_class ::= ["*"][name "."] name ["*"]|"*" method ::= signature ::= ["*"] name ["*"}|"*"

Parameters:
filterString -

sendFilters

public void sendFilters(java.lang.String[] filterStrings)
                 throws LaunchPadException
Send a filter to the Agent Extension for using in the agent extension callback filtering. Filters are sent as binary custom command. The command is structered in the following way: First 4 bytes contain the total length of all filter strings including the trailing zero byte. The length is followed by the strings in utf8 encoding separated by zeros Note: This feature is not used as of today (03/15/05). It is reserved for the future if we need a 'Global' filtering mechanism that applies to all probes simulteniously.

Parameters:
filterStrings -
Throws:
LaunchPadException

deployClass

public void deployClass(byte[] classBuffer,
                        java.lang.String className)
                 throws LaunchPadException
Deploy a class into the running process over the RAC connection

Parameters:
classBuffer - - array of bytes with the raw class data
className - - class name
Throws:
LaunchPadException

deployClass

public void deployClass(java.io.File classFile)
                 throws LaunchPadException
Deploys a class from the supplied file into a running process over the RAC connection

Parameters:
classFile - - Class file
Throws:
LaunchPadException

agentActive

public void agentActive(TRCAgentProxy agentProxy)
                 throws LaunchPadException
This method is called by the Workbench extension point to notify the launchpad that the agent is active and is about to get resumed. At this point the launcpad is parsing the launcher options, retrieves the probe script and probe classes, prepares filters and then deploys the script and related classes to the active agent

Parameters:
agentProxy - - TRCAgentProxy delivered by the Workbench extension point
Throws:
LaunchPadException

deployProbe

public void deployProbe(ProbeRegistryEntry probeRegistryEntry)
                 throws LaunchPadException
Depolys a probe given a probe registry entry. This method is usually called when somebody configures an application to be launched with probes. It can be called more than once if several probes were selected from the registry in the launch configuration. The right invokation point is the AgentActive callback (after the agent was activated but before it processed the resume command.

Parameters:
probeRegistryEntry - - Probe Registry Entry
Throws:
LaunchPadException - - Launchpad Exception

TPTP 4.6.0 Platform Project
Public API Specification