COM.TIBCO.hawk.agent.nest

Interface MicroAgent

All Known Subinterfaces:

DynamicMicroAgent, ServiceMicroAgent

public interface MicroAgent

Objects wishing to run as microagents in the TIBCO Hawk agent must implement this interface.

Method Summary

Modifier and Type	Method and Description
MicroAgentDescriptor	describeMicroAgent() Provides the MicroAgentDescriptor for this microagent.
void	initializeMicroAgent(java.lang.String[] args) This method is called by a microagent container before the microagent is added to it.
void	thisMicroAgentAdded(MicroAgentID mid) This method is called by a microagent container when this microagent has been successfully added to it.
void	thisMicroAgentRemoved() Called when this microagent is removed from the microagent container.

Method Detail

initializeMicroAgent

void initializeMicroAgent(java.lang.String[] args)
                   throws MicroAgentException

This method is called by a microagent container before the microagent is added to it. It is used to initialize the microagent. A MicroAgentException may be thrown to signal a problem with initialization. If the exception is thrown, the microagent will not be added to the container and no other methods will be called.

Parameters:

args - The command-line arguments or other initialization parameters that have been designated for this microagent

Throws:

MicroAgentException - if there is a problem with the initialization

describeMicroAgent

MicroAgentDescriptor describeMicroAgent()
                                 throws MicroAgentException

Provides the MicroAgentDescriptor for this microagent. This method is called after initializeMicroAgent() is called and before the microagent is added to the container.

Throws:

MicroAgentException - if there is an error generating the description

thisMicroAgentAdded

void thisMicroAgentAdded(MicroAgentID mid)

This method is called by a microagent container when this microagent has been successfully added to it.

Parameters:

mid - The MicroAgentID that has been assigned to this microagent

thisMicroAgentRemoved

void thisMicroAgentRemoved()

Called when this microagent is removed from the microagent container. May be used to perform cleanup operations.