Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

brooklyn.location
[Java] Interface LocationResolver

public interface LocationResolver

Provides a way of creating location instances of a particular type.

Method Summary
boolean accepts(java.lang.String spec, LocationRegistry registry)

whether the spec is something which should be passed to this resolver
java.lang.String getPrefix()

the prefix that this resolver will attend to
void init(ManagementContext managementContext)

Location newLocationFromString(java.util.Map properties, java.lang.String spec)

Returns a Location instance, e.g. a JcloudsLocation instance configured to provision in AWS eu-west-1; the properties map may contain lots of info some of which may be relevant to this location (eg containing credentials for many clouds, and resolver picks out the ones applicable here) -- commonly it is a BrooklynProperties instance, read from .brooklyn/brooklyn.properties
Location newLocationFromString(java.util.Map locationFlags, java.lang.String spec, LocationRegistry registry)

Similar to newLocationFromString(Map, String) but passing in a reference to the registry itself (from which the base properties are discovered) and including flags (e.g. user, key, cloud credential) which are known to be for this location.
 

Method Detail

accepts

public boolean accepts(java.lang.String spec, LocationRegistry registry)
whether the spec is something which should be passed to this resolver

getPrefix

public java.lang.String getPrefix()
the prefix that this resolver will attend to

init

public void init(ManagementContext managementContext)

newLocationFromString

@Deprecated
public Location newLocationFromString(@SuppressWarnings("rawtypes") java.util.Map properties, java.lang.String spec)
Returns a Location instance, e.g. a JcloudsLocation instance configured to provision in AWS eu-west-1; the properties map may contain lots of info some of which may be relevant to this location (eg containing credentials for many clouds, and resolver picks out the ones applicable here) -- commonly it is a BrooklynProperties instance, read from .brooklyn/brooklyn.properties

throws:
NoSuchElementException if not found
deprecated:
since 0.6; use newLocationFromString(Map, String, LocationRegistry)

newLocationFromString

@SuppressWarnings("rawtypes")
public Location newLocationFromString(java.util.Map locationFlags, java.lang.String spec, LocationRegistry registry)
Similar to newLocationFromString(Map, String) but passing in a reference to the registry itself (from which the base properties are discovered) and including flags (e.g. user, key, cloud credential) which are known to be for this location.

introduced to support locations which refer to other locations, e.g. NamedLocationResolver

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.