org.safs.jvmagent

Interface LocalAgentFactory

All Known Implementing Classes:

LocalAgentFactoryImpl

public interface LocalAgentFactory

Instances of this class are intended to provide instances of LocalAgent objects that are appropriate for the requester and the testobject in question.

Ex: If we provide a java.awt.Component testobject we want to receive the LocalAgent that knows how to deal with this Component. Subclasses can provide alternate LocalAgents that are specific for the tool (like Abbot) that is going to be playing with the testobject.

Since:

Feb 17, 2005

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_AGENT_NAME 'ComponentAgent' Default agent name used to instantiate local agent helpers.
static java.lang.String	DEFAULT_AGENT_PACKAGE 'org.safs.jvmagent' Default package used to instantiate local agent helpers.

Method Summary

Modifier and Type	Method and Description
LocalAgent	getAgent(java.lang.String agentname) Locate and return the LocalAgent using the stored agentpackage and provided agentname.
LocalAgent	getDefaultAgent() Return the default LocalAgent for the current agent package.
LocalAgent	getDerivedAgent(java.lang.Object testobject) Locate and return the LocalAgent most appropriate for the testobject target.
LocalAgent	getLocalAgent(java.lang.String fullclassname) Return the LocalAgent for the fully specified agentclass.
void	setAgentPackage(java.lang.String agentpackage) Override the DEFAULT_AGENT_PACKAGE setting for instantiating local agent helpers.
void	setDefaultAgentName(java.lang.String agentname) Override the DEFAULT_AGENT_NAME setting for instantiating the default agent helper.

Field Detail

DEFAULT_AGENT_PACKAGE

static final java.lang.String DEFAULT_AGENT_PACKAGE

'org.safs.jvmagent' Default package used to instantiate local agent helpers. Ex: A ComponentAgent with this default package would be 'org.safs.jvmagent.ComponentAgent'

See Also:

Constant Field Values

DEFAULT_AGENT_NAME

static final java.lang.String DEFAULT_AGENT_NAME

'ComponentAgent' Default agent name used to instantiate local agent helpers. Ex: A ComponentAgent with this default package would be 'org.safs.jvmagent.ComponentAgent'

See Also:

Constant Field Values

Method Detail

setAgentPackage

void setAgentPackage(java.lang.String agentpackage)

Override the DEFAULT_AGENT_PACKAGE setting for instantiating local agent helpers.

setDefaultAgentName

void setDefaultAgentName(java.lang.String agentname)

Override the DEFAULT_AGENT_NAME setting for instantiating the default agent helper.

getAgent

LocalAgent getAgent(java.lang.String agentname)
             throws InvalidAgentException

Locate and return the LocalAgent using the stored agentpackage and provided agentname. Ex: If agentname = "ComponentAgent" and stored agentpackage = "org.safs.jvmagent" then we will attempt to return "org.safs.jvmagent.ComponentAgent".

Returns:

LocalAgent

Throws:

InvalidAgentException - if agent cannot be found/created/returned.

getDerivedAgent

LocalAgent getDerivedAgent(java.lang.Object testobject)
                    throws InvalidAgentException

Locate and return the LocalAgent most appropriate for the testobject target. For example, if the testobject is a Swing JFrame we would return the LocalAgent from the current agent package that knows how to handle JFrames.

Returns:

LocalAgent

Throws:

InvalidAgentException - if agent cannot be found/created/returned.

getDefaultAgent

LocalAgent getDefaultAgent()
                    throws InvalidAgentException

Return the default LocalAgent for the current agent package. This is usually an agent with reduced capability like an ObjectAgent or a ComponentAgent with no ability to deal with more complex testobjects.

Returns:

LocalAgent

Throws:

InvalidAgentException - if agent cannot be found/created/returned.

getLocalAgent

LocalAgent getLocalAgent(java.lang.String fullclassname)
                  throws InvalidAgentException

Return the LocalAgent for the fully specified agentclass.

Parameters:

fullclassname - the full proper class name for the desired LocalAgent. The internal agent package is ignored.

Returns:

LocalAgent

Throws:

InvalidAgentException - if agent cannot be found/created/returned.