org.apache.brooklyn.test.framework

Interface TargetableTestComponent

All Superinterfaces:

org.apache.brooklyn.api.objs.BrooklynObject, org.apache.brooklyn.api.objs.Configurable, org.apache.brooklyn.api.entity.Entity, org.apache.brooklyn.api.objs.Identifiable, Startable

All Known Subinterfaces:

BaseTest, InfrastructureDeploymentTestCase, LoopOverGroupMembersTestCase, ParallelTestCase, RelativeEntityTestCase, SimpleShellCommandTest, TestCase, TestEffector, TestEndpointReachable, TestHttpCall, TestSensor, TestSshCommand, TestWinrmCommand

All Known Implementing Classes:

InfrastructureDeploymentTestCaseImpl, LoopOverGroupMembersTestCaseImpl, ParallelTestCaseImpl, RelativeEntityTestCaseImpl, SimpleShellCommandTestImpl, TargetableTestComponentImpl, TestCaseImpl, TestEffectorImpl, TestEndpointReachableImpl, TestHttpCallImpl, TestSensorImpl, TestSshCommandImpl, TestWinrmCommandImpl

public interface TargetableTestComponent
extends org.apache.brooklyn.api.entity.Entity, Startable

Entity that can target another entity for the purpose of testing

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

org.apache.brooklyn.api.entity.Entity.AdjunctSupport<T extends org.apache.brooklyn.api.objs.EntityAdjunct>, org.apache.brooklyn.api.entity.Entity.EnricherSupport, org.apache.brooklyn.api.entity.Entity.GroupSupport, org.apache.brooklyn.api.entity.Entity.PolicySupport, org.apache.brooklyn.api.entity.Entity.SensorSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

org.apache.brooklyn.api.objs.BrooklynObject.RelationSupport<T extends org.apache.brooklyn.api.objs.BrooklynObject>, org.apache.brooklyn.api.objs.BrooklynObject.SubscriptionSupport, org.apache.brooklyn.api.objs.BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

org.apache.brooklyn.api.objs.Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity>	TARGET_ENTITY The target entity to test.
static org.apache.brooklyn.api.sensor.AttributeSensor<String>	TARGET_ENTITY_ID
static org.apache.brooklyn.api.sensor.AttributeSensor<String>	TARGET_ENTITY_NAME
static org.apache.brooklyn.api.sensor.AttributeSensor<String>	TARGET_ENTITY_TYPE
static org.apache.brooklyn.config.ConfigKey<String>	TARGET_ID Id of the target entity to test.
static org.apache.brooklyn.config.ConfigKey<org.apache.brooklyn.util.time.Duration>	TARGET_RESOLUTION_TIMEOUT The duration to wait for an entity with the given targetId to exist, before throwing an exception.

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

Method Summary

Modifier and Type	Method and Description
org.apache.brooklyn.api.entity.Entity	resolveTarget() Get the target of the test.

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, groups, invoke, policies, relations, removeChild, removeEnricher, removeGroup, removePolicy, sensors, setDisplayName, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig, setConfig

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

restart, start, stop

Field Detail

TARGET_ENTITY

static final AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity> TARGET_ENTITY

The target entity to test. Optional, use either this or targetId. If both are set then this will take precedence.

TARGET_ID

static final org.apache.brooklyn.config.ConfigKey<String> TARGET_ID

Id of the target entity to test.

See Also:

#TARGET_ENTITY target}.

TARGET_RESOLUTION_TIMEOUT

static final org.apache.brooklyn.config.ConfigKey<org.apache.brooklyn.util.time.Duration> TARGET_RESOLUTION_TIMEOUT

The duration to wait for an entity with the given targetId to exist, before throwing an exception.

TARGET_ENTITY_ID

static final org.apache.brooklyn.api.sensor.AttributeSensor<String> TARGET_ENTITY_ID

TARGET_ENTITY_NAME

static final org.apache.brooklyn.api.sensor.AttributeSensor<String> TARGET_ENTITY_NAME

TARGET_ENTITY_TYPE

static final org.apache.brooklyn.api.sensor.AttributeSensor<String> TARGET_ENTITY_TYPE

Method Detail

resolveTarget

org.apache.brooklyn.api.entity.Entity resolveTarget()

Get the target of the test.

Returns:

The target entity

Throws:

{@link - IllegalArgumentException} if the target cannot be found