Package com.atlassian.bamboo.plugin

Interface AgentPluginResolver

All Known Implementing Classes:

DefaultAgentPluginResolver

@Internal
public interface AgentPluginResolver

Provides API to decide whether given Plugin is supposed to run on remote agents.

Since:

v3.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AgentPluginResolver.AgentPluginFilter

Method Summary

Modifier and Type	Method	Description
Iterable<com.atlassian.plugin.Plugin>	getAgentPlugins(AgentPluginResolver.AgentPluginFilter filter)	Get agent plugins (i.e.
boolean	matches(com.atlassian.plugin.Plugin plugin, AgentPluginResolver.AgentPluginFilter filter)	Check whether plugin matches given filter.

Method Details

getAgentPlugins

Iterable<com.atlassian.plugin.Plugin> getAgentPlugins(AgentPluginResolver.AgentPluginFilter filter)

Get agent plugins (i.e. plugins supposed to run on remote agents) for given filter.

This method returns all currently installed plugins, for which matches(com.atlassian.plugin.Plugin, com.atlassian.bamboo.plugin.AgentPluginResolver.AgentPluginFilter) will return true.

Parameters:

filter - agent plugin filter

Returns:

list of matching plugins

matches

boolean matches(com.atlassian.plugin.Plugin plugin,
 AgentPluginResolver.AgentPluginFilter filter)

Check whether plugin matches given filter. It must be supported by remote agents (i.e. have at least one module supported by remote agents) and match any additional criteria defined in the filter.

Parameters:

plugin - plugin to check

filter - agent filter to match

Returns:

true, if the plugin matches the filter.