Package jetbrains.buildServer.serverSide.agentTypes

Class SimpleAgentTypePolicy

java.lang.Object

jetbrains.buildServer.serverSide.agentTypes.SimpleAgentTypePolicy

All Implemented Interfaces:

AgentTypePolicy

public final class SimpleAgentTypePolicy
extends Object
implements AgentTypePolicy

Determines which configurations allowed to run on the agent. Value object.

Since:

7.0

Author:

Leonid Bushuev from JetBrains

Field Summary

Fields

Modifier and Type	Field	Description
static int	BT_RESTRICTED_POLICY
static int	RUN_ALL_POLICY

Constructor Summary

Constructors

Constructor	Description
SimpleAgentTypePolicy(int policyKind, Set<String> projectIds, Set<String> buildTypeIds)	Makes an instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Set<String>	getAllowedBuildTypes()	Selected build types.
Set<String>	getAllowedProjects()	Allowed projects.
int	getPolicyKind()	Kind of the policy.
int	hashCode()
boolean	isAllowedToRun(String projectId, String buildTypeId)	Checks whether the specified build configuration is allowed to run on this agent.
boolean	isBuildTypeAllowed(String buildTypeId)	Checks whether the specified build configuration is selected by this policy (this method does not consider pool associations).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RUN_ALL_POLICY

public static final int RUN_ALL_POLICY

See Also:

Constant Field Values

BT_RESTRICTED_POLICY

public static final int BT_RESTRICTED_POLICY

See Also:

Constant Field Values

Constructor Detail

SimpleAgentTypePolicy

public SimpleAgentTypePolicy(int policyKind,
                             @Nullable
                             Set<String> projectIds,
                             @Nullable
                             Set<String> buildTypeIds)

Makes an instance.

Parameters:

policyKind - 1 - all, 2 - selected.

poolId -

buildTypeIds - selected build types.

Method Detail

getPolicyKind

public int getPolicyKind()

Kind of the policy.

Specified by:

getPolicyKind in interface AgentTypePolicy

Returns:

1 - run all, 2 - run selected only.

getAllowedProjects

@NotNull
public Set<String> getAllowedProjects()

Allowed projects.

Specified by:

getAllowedProjects in interface AgentTypePolicy

Returns:

an immutable set of project identifiers; may be ampty.

getAllowedBuildTypes

@NotNull
public Set<String> getAllowedBuildTypes()

Selected build types.

Specified by:

getAllowedBuildTypes in interface AgentTypePolicy

Returns:

an immutable set of build type identifiers; may be ampty.

isBuildTypeAllowed

public boolean isBuildTypeAllowed(@NotNull
                                  String buildTypeId)

Checks whether the specified build configuration is selected by this policy (this method does not consider pool associations).

Specified by:

isBuildTypeAllowed in interface AgentTypePolicy

Returns:

see above

isAllowedToRun

public boolean isAllowedToRun(@NotNull
                              String projectId,
                              @NotNull
                              String buildTypeId)

Checks whether the specified build configuration is allowed to run on this agent.

Specified by:

isAllowedToRun in interface AgentTypePolicy

Parameters:

projectId -

buildTypeId - build configuration to check.

Returns:

true if allowed.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object