flux.agent
Interface AgentAction

All Known Subinterfaces:

FileCopyAction, FileExistTrigger, FileMoveAction, FileRenameAction, ProcessAction

public interface AgentAction

Triggers and actions that can run on an agent implement this interface.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.String	getAgentPool() This property indicates whether this process runs on an agent, and if it does, which subset of agents are considered for process execution.
void	setAgentPool(java.lang.String pool) This property indicates whether this process runs on an agent, and if it does, which subset of agents are considered for process execution.

Method Detail

getAgentPool

java.lang.String getAgentPool()

This property indicates whether this process runs on an agent, and if it does, which subset of agents are considered for process execution. Each agent has a pool property, which is a string that is used to group similar agents. The agent pool name is case-insensitive.

This property defaults to null, which means that processes run on the Flux engine that executes this process action, not on an agent.

To force a process to run on any one agent in a specific pool of agents, this property must match the name of that agent pool.

Finally, to force a process to simply run on any available agent, use the reserved pool name "*".

If an appropriate agent is not available, this process action waits for an appropriate agent to become available.

Agent pools are used to "pin" processes to certain kinds of agents. For example, if there are Unix computers and Windows computers available on the network, pools can ensure that Unix processes run on Unix computers and Windows processes run on Windows computers, all by setting appropriate pool names on agents and process actions.

As another example, if an agent contains a special resource that no other agent contains, this agent pool property can be used to ensure that processes that require those special resources are executed on agent computers that actually contain those special resources.

As a final example, agents can be used to dramatically increase the number of process actions that a Flux system can support. By using a few hundred agents, a few hundred processes can be executed simultaneously across the few hundred agent computers.

Returns:

An indication whether this process runs on an agent, and if it does, which subset of agents are considered for process execution. May be null.

setAgentPool

void setAgentPool(java.lang.String pool)

This property indicates whether this process runs on an agent, and if it does, which subset of agents are considered for process execution. Each agent has a pool property, which is a string that is used to group similar agents. The agent pool name is case-insensitive.

This property defaults to null, which means that processes run on the Flux engine that executes this process action, not on an agent.

To force a process to run on any one agent in a specific pool of agents, this property must match the name of that agent pool.

Finally, to force a process to simply run on any available agent, use the reserved pool name "*".

If an appropriate agent is not available, this process action waits for an appropriate agent to become available.

Agent pools are used to "pin" processes to certain kinds of agents. For example, if there are Unix computers and Windows computers available on the network, pools can ensure that Unix processes run on Unix computers and Windows processes run on Windows computers, all by setting appropriate pool names on agents and process actions.

As another example, if an agent contains a special resource that no other agent contains, this agent pool property can be used to ensure that processes that require those special resources are executed on agent computers that actually contain those special resources.

As a final example, agents can be used to dramatically increase the number of process actions that a Flux system can support. By using a few hundred agents, a few hundred processes can be executed simultaneously across the few hundred agent computers.

Parameters:

pool - An indication whether this process runs on an agent, and if it does, which subset of agents are considered for process execution. May be null.