brooklyn.location.affinity

Class AffinityRules

java.lang.Object

brooklyn.location.affinity.AffinityRules

All Implemented Interfaces:

com.google.common.base.Predicate<brooklyn.entity.Entity>

public class AffinityRules
extends Object
implements com.google.common.base.Predicate<brooklyn.entity.Entity>

Affinity rules for Docker hosts.

Rules are specified as strings, formatted as follows:

• (NOT) TYPE entityType?
• (NOT) NAME entityName
• (NOT) ID entityId?
• (NOT) APPLICATION applicationId?
• (NOT) PREDICATE entityPredicateClass
• (NOT) EMPTY

The SAME token is the default behaviour, and means the entities must have the property defined in the rule, NOT means they mustn't have the property. The parameter given specifies the type or id, and if it's missing thee rule will apply to the properties of the entity being placed. Rules that take a class name will instantiate an instance of that class from the current classpath, so ensure the appropriate Jar files are available. The EMPTY rule will treaty empty locations as allowable, otherwise a new DockerHostLocation will be created for the container.

To specify a rule that there must be no entities of the same type, an entity of type SolrServer, all in the same application, use these rules:

 NOT TYPE
 TYPE brooklyn.entity.nosql.solr.SolrServer
 SAME APPLICATION
 

Specify the rules during configuration using the AFFINITY_RULES key:

 - serviceType: brooklyn.entity.webapp.tomcat.TomcatServer
   brooklyn.config:
   affinity.rules: |
     NOT TYPE
     TYPE brooklyn.entity.nosql.solr.SolrServer
     SAME APPLICATION
 

Field Summary

Fields

Modifier and Type	Field and Description
static brooklyn.config.ConfigKey<String>	AFFINITY_RULES
static String	APPLICATION
static String	EMPTY
static String	ID
static String	NAME
static String	NOT
static String	PREDICATE
static String	TYPE
static Iterable<String>	VERBS

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowEmptyLocations()
boolean	apply(brooklyn.entity.Entity input)
AffinityRules	parse(Iterable<String> rules)
AffinityRules	parse(String... rules)
AffinityRules	parse(String rules)
static AffinityRules	rulesFor(brooklyn.entity.Entity entity)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.common.base.Predicate

equals

Field Detail

AFFINITY_RULES

public static final brooklyn.config.ConfigKey<String> AFFINITY_RULES

NOT

public static final String NOT

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

APPLICATION

public static final String APPLICATION

See Also:

Constant Field Values

PREDICATE

public static final String PREDICATE

See Also:

Constant Field Values

EMPTY

public static final String EMPTY

See Also:

Constant Field Values

VERBS

public static final Iterable<String> VERBS

Method Detail

rulesFor

public static AffinityRules rulesFor(brooklyn.entity.Entity entity)

parse

public AffinityRules parse(String... rules)

parse

public AffinityRules parse(String rules)

parse

public AffinityRules parse(Iterable<String> rules)

apply

public boolean apply(@Nullable
            brooklyn.entity.Entity input)

Specified by:

apply in interface com.google.common.base.Predicate<brooklyn.entity.Entity>

allowEmptyLocations

public boolean allowEmptyLocations()