Method Detail

• getDefinedLocations

  java.util.Map<java.lang.String,LocationDefinition> getDefinedLocations()

  map of ID (possibly randomly generated) to the definition (spec, name, id, and props; where spec is the spec as defined, for instance possibly another named:xxx location)

• getDefinedLocationById

  LocationDefinition getDefinedLocationById(java.lang.String id)

  returns a LocationDefinition given its ID (usually a random string), or null if none

• getDefinedLocationByName

  LocationDefinition getDefinedLocationByName(java.lang.String name)

  returns a LocationDefinition given its name (e.g. for named locations, supply the bit after the "named:" prefix), or null if none

• updateDefinedLocation

  void updateDefinedLocation(LocationDefinition l)

  adds or updates the given defined location

• removeDefinedLocation

  void removeDefinedLocation(java.lang.String id)

  removes the defined location from the registry (applications running there are unaffected)

• resolve

  @Beta
  Maybe<Location> resolve(LocationDefinition ld,
                             java.lang.Boolean manage,
                             java.util.Map locationFlags)

  Returns a fully populated (config etc) location from the given definition, with optional add'l flags. the location will be managed by default, unless the manage parameter is false, or the manage parameter is null and the CREATE_UNMANAGED flag is set.

  The manage parameter is Boolean so that null can be used to say rely on anything in the flags.

  Since:

  0.7.0, but beta and likely to change as the semantics of this class are tuned

• resolve

  Location resolve(LocationDefinition l)

  As {@link #resolve(LocationDefinition, Boolean, Map), with the location managed, and no additional flags, unwrapping the result (throwing if not resolvable)

• resolve

  @Beta
  Maybe<Location> resolve(java.lang.String spec,
                             java.lang.Boolean manage,
                             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.

  Since:

  0.7.0, but beta and likely to change as the semantics of this class are tuned

• resolveForPeeking

  @Deprecated
  Location resolveForPeeking(LocationDefinition l)

  Deprecated. since 0.7.0, use resolve(LocationDefinition, Boolean, Map)
  efficiently returns for inspection only a fully populated (config etc) location from the given definition; the value might be unmanaged so it is not meant for any use other than inspection, but callers should prefer this when they don't wish to create a new location which will be managed in perpetuity!

• resolve

  @Deprecated
  Location resolve(LocationDefinition l,
                            java.util.Map<?,?> locationFlags)

  Deprecated. since 0.7.0, use resolve(LocationDefinition, Boolean, Map)
  returns fully populated (config etc) location from the given definition, with overrides;

• resolve

  Location resolve(java.lang.String spec)

  See resolve(String, Boolean, Map); asks for the location to be managed, and supplies no additional flags, and unwraps the result (throwing if the spec cannot be resolve)

• canMaybeResolve

  @Deprecated
  boolean canMaybeResolve(java.lang.String spec)

  Deprecated. since 0.7.0, not really needed, and semantics are weak; use resolve(String, Boolean, Map)
  Returns true/false depending whether spec seems like a valid location, that is it has a chance of being resolved (depending on the spec) but NOT guaranteed, as it is not passed to the spec; see resolve(String, Boolean, Map) which has stronger guarantees

• resolve

  Location resolve(java.lang.String spec,
                 @Nullable
                 java.util.Map locationFlags)

  As resolve(String, Boolean, Map), but unwrapped

  Throws:

  java.util.NoSuchElementException - if the spec cannot be resolved

• resolveIfPossible

  @Deprecated
  Location resolveIfPossible(java.lang.String spec)

  Deprecated. since 0.7.0 use resolve(String, Boolean, Map)
  as resolve(String) but returning null (never throwing)

• resolve

  java.util.List<Location> resolve(java.lang.Iterable<?> spec)

  As resolve(String) but takes collections (of strings or locations)

  Expects a collection of elements being individual location spec strings or locations, and returns a list of resolved (newly created and managed) locations.

  From 0.7.0 this no longer flattens lists (nested lists are disallowed) or parses comma-separated elements (they are resolved as-is)

• resolveList

  java.util.List<Location> resolveList(java.lang.Object specList)

  Takes a string, interpreted as a comma-separated (or JSON style, when you need internal double quotes or commas) list; or a list, passed to resolve(Iterable); or null/empty (empty list), and returns a list of resolved (created and managed) locations

• getProperties

  java.util.Map getProperties()