TPTP 4.4.0 Monitoring Tools Project
Internal API Specification

org.eclipse.hyades.perfmon.internal.agents.apache
Class ApacheTabInterface

java.lang.Object
  extended byorg.eclipse.hyades.perfmon.internal.agents.apache.ApacheTabInterface
All Implemented Interfaces:
AgentTabInterface

public class ApacheTabInterface
extends java.lang.Object
implements AgentTabInterface


Field Summary
static java.lang.String APACHE_AGENT_NAME
           
static java.lang.String URL
           
 
Constructor Summary
ApacheTabInterface()
           
 
Method Summary
 java.lang.String getACAgentName()
          Retrieve the agent controller agent name
 java.lang.String getErrorMessage()
          Retrieve an error message if isValid fails
 AgentSettings getSettings(org.eclipse.debug.core.ILaunchConfiguration conf)
          Get the AgentSettings wrapper of this agent's configuration details, using the provided configuration as source for the settings.
 AgentVariable[] getVariables()
          Get the variables and their values from the agent interface
 void initializeFrom(org.eclipse.debug.core.ILaunchConfiguration configuration)
          Initialize the state of this agent's interface from the provided launch configuration
 boolean isValid(org.eclipse.debug.core.ILaunchConfiguration conf)
          Determine whether this launch configuration is valid.
 void performApply(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy configuration)
          Apply this agent's settings to the given configuration
 void setDefaults(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy configuration)
          Set the default values for the agent's configuration in the provided launch configuration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

APACHE_AGENT_NAME

public static final java.lang.String APACHE_AGENT_NAME
See Also:
Constant Field Values

URL

public static final java.lang.String URL
See Also:
Constant Field Values
Constructor Detail

ApacheTabInterface

public ApacheTabInterface()
Method Detail

getACAgentName

public java.lang.String getACAgentName()
Description copied from interface: AgentTabInterface
Retrieve the agent controller agent name

Specified by:
getACAgentName in interface AgentTabInterface
Returns:
the name used to reference the agent in the agent controller

setDefaults

public void setDefaults(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy configuration)
Description copied from interface: AgentTabInterface
Set the default values for the agent's configuration in the provided launch configuration

Specified by:
setDefaults in interface AgentTabInterface
Parameters:
configuration - the launch configuration where the default values should be set

initializeFrom

public void initializeFrom(org.eclipse.debug.core.ILaunchConfiguration configuration)
Description copied from interface: AgentTabInterface
Initialize the state of this agent's interface from the provided launch configuration

Specified by:
initializeFrom in interface AgentTabInterface
Parameters:
configuration - the launch configuration to initialize from

performApply

public void performApply(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy configuration)
Description copied from interface: AgentTabInterface
Apply this agent's settings to the given configuration

Specified by:
performApply in interface AgentTabInterface
Parameters:
configuration - the launch configuration to apply to

isValid

public boolean isValid(org.eclipse.debug.core.ILaunchConfiguration conf)
Description copied from interface: AgentTabInterface
Determine whether this launch configuration is valid. If not valid, use getErrorMessage() to retrieve an explanation.

Specified by:
isValid in interface AgentTabInterface
Parameters:
conf - the configuration to check for validity
Returns:
true if this is valud, false if not

getErrorMessage

public java.lang.String getErrorMessage()
Description copied from interface: AgentTabInterface
Retrieve an error message if isValid fails

Specified by:
getErrorMessage in interface AgentTabInterface
Returns:
the error message or null if none exists

getVariables

public AgentVariable[] getVariables()
Description copied from interface: AgentTabInterface
Get the variables and their values from the agent interface

Specified by:
getVariables in interface AgentTabInterface
Returns:
the variables to be sent to the agent

getSettings

public AgentSettings getSettings(org.eclipse.debug.core.ILaunchConfiguration conf)
Description copied from interface: AgentTabInterface
Get the AgentSettings wrapper of this agent's configuration details, using the provided configuration as source for the settings.

Specified by:
getSettings in interface AgentTabInterface
Parameters:
conf - the source configuration
Returns:
the agent settings object used to configure and launch the agent

TPTP 4.4.0 Monitoring Tools Project
Internal API Specification