org.apache.brooklyn.core.location

Class Locations

java.lang.Object

org.apache.brooklyn.core.location.Locations

public class Locations
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Locations.LocationsFilter

Field Summary

Fields

Modifier and Type	Field and Description
static Locations.LocationsFilter	USE_FIRST_LOCATION

Constructor Summary

Constructors

Constructor and Description
Locations()

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<? extends Location>	coerceToCollectionOfLocationsManaged(ManagementContext mgmt, java.lang.Object rawO) As LocationRegistry.getListOfLocationsManaged(Object), but using coerceToLocationManaged(ManagementContext, Object) for more forgiving interpretations.
static Location	coerceToLocationManaged(ManagementContext mgmt, java.lang.Object rawO) As LocationRegistry.getLocationManaged(String, Map) but also accepting maps and yaml representations of maps.
static Maybe<MachineLocation>	findUniqueMachineLocation(java.lang.Iterable<? extends Location> locations) as Machines.findUniqueMachineLocation(Iterable)
static Maybe<SshMachineLocation>	findUniqueSshMachineLocation(java.lang.Iterable<? extends Location> locations) as Machines#findUniqueSshMachineLocation(Iterable)
static java.util.Collection<? extends Location>	getLocationsCheckingAncestors(java.util.Collection<? extends Location> locations, Entity entity) if no locations are supplied, returns locations on the entity, or in the ancestors, until it finds a non-empty set, or ultimately the empty set if no locations are anywhere
static boolean	isManaged(Location loc)
static void	manage(Location loc, ManagementContext managementContext) Deprecated. in 0.6.0; use LocationManager.createLocation(LocationSpec) instead.
static void	unmanage(Location loc)

Methods inherited from class java.lang.Object

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

Field Detail

USE_FIRST_LOCATION

public static final Locations.LocationsFilter USE_FIRST_LOCATION

Constructor Detail

Locations

public Locations()

Method Detail

findUniqueMachineLocation

public static Maybe<MachineLocation> findUniqueMachineLocation(java.lang.Iterable<? extends Location> locations)

as Machines.findUniqueMachineLocation(Iterable)

findUniqueSshMachineLocation

public static Maybe<SshMachineLocation> findUniqueSshMachineLocation(java.lang.Iterable<? extends Location> locations)

as Machines#findUniqueSshMachineLocation(Iterable)

getLocationsCheckingAncestors

public static java.util.Collection<? extends Location> getLocationsCheckingAncestors(java.util.Collection<? extends Location> locations,
                                                                                     Entity entity)

if no locations are supplied, returns locations on the entity, or in the ancestors, until it finds a non-empty set, or ultimately the empty set if no locations are anywhere

isManaged

public static boolean isManaged(Location loc)

unmanage

public static void unmanage(Location loc)

manage

@Deprecated
public static void manage(Location loc,
                                      ManagementContext managementContext)

Deprecated. in 0.6.0; use LocationManager.createLocation(LocationSpec) instead.

Registers the given location (and all its children) with the management context.

Throws:

java.lang.IllegalStateException - if the parent location is not already managed

Since:

0.6.0 (added only for backwards compatibility, where locations are being created directly; previously in Entities).

coerceToLocationManaged

public static Location coerceToLocationManaged(ManagementContext mgmt,
                                               java.lang.Object rawO)

As LocationRegistry.getLocationManaged(String, Map) but also accepting maps and yaml representations of maps.

The caller is responsible for ensuring the resulting Location is unmanaged.

coerceToCollectionOfLocationsManaged

public static java.util.Collection<? extends Location> coerceToCollectionOfLocationsManaged(ManagementContext mgmt,
                                                                                            java.lang.Object rawO)

As LocationRegistry.getListOfLocationsManaged(Object), but using coerceToLocationManaged(ManagementContext, Object) for more forgiving interpretations.

The caller is responsible for ensuring the resulting Location is unmanaged.