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

brooklyn.location
[Java] Interface LocationRegistry

@SuppressWarnings("rawtypes")
public interface LocationRegistry

The registry of the sorts of locations that brooklyn knows about. Given a {@LocationDefinition} or a java.lang.String representation of a spec, this can be used to create a Location instance.

Method Summary
boolean canResolve(java.lang.String spec)

Returns true/false depending whether spec seems like a valid location
LocationDefinition getDefinedLocation(java.lang.String id)

LocationDefinition getDefinedLocationByName(java.lang.String name)

java.util.Map getDefinedLocations()

java.util.Map getProperties()

void removeDefinedLocation(java.lang.String id)

removes the defined location from the registry (applications running there are unaffected)
Location resolve(LocationDefinition l)

returns fully populated (config etc) location from the given definition
Location resolve(java.lang.String spec)

See resolve(String, Map) (with no options)
Location resolve(java.lang.String spec, java.util.Map locationFlags)

Returns a location created from the given spec, which might correspond to a definition, or created on-the-fly.

java.util.List resolve(java.lang.Iterable spec)

As resolve(String) but works with a collection of location specs.
void updateDefinedLocation(LocationDefinition l)

adds or updates the given defined location
 

Method Detail

canResolve

public boolean canResolve(java.lang.String spec)
Returns true/false depending whether spec seems like a valid location

getDefinedLocation

public LocationDefinition getDefinedLocation(java.lang.String id)

getDefinedLocationByName

public LocationDefinition getDefinedLocationByName(java.lang.String name)

getDefinedLocations

public java.util.Map getDefinedLocations()

getProperties

public java.util.Map getProperties()

removeDefinedLocation

public void removeDefinedLocation(java.lang.String id)
removes the defined location from the registry (applications running there are unaffected)

resolve

public Location resolve(LocationDefinition l)
returns fully populated (config etc) location from the given definition

resolve

public Location resolve(java.lang.String spec)
See resolve(String, Map) (with no options)

resolve

public Location resolve(java.lang.String spec, java.util.Map locationFlags)
Returns a location created from the given spec, which might correspond to a definition, or created on-the-fly. Optional flags can be passed through to underlying the location.

resolve

public java.util.List resolve(java.lang.Iterable spec)
As resolve(String) but works with a collection of location specs.

Usually given a collection of string specs. Also supports comma-separated lists as a single spec.

For legacy compatibility this also accepts nested lists, but that is deprecated (and triggers a warning).

updateDefinedLocation

public void updateDefinedLocation(LocationDefinition l)
adds or updates the given defined location

 

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