/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.brooklyn.camp.brooklyn.spi.creation;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import org.apache.brooklyn.api.location.Location;
import org.apache.brooklyn.api.location.LocationDefinition;
import org.apache.brooklyn.api.mgmt.ManagementContext;
import org.apache.brooklyn.util.collections.MutableList;
import org.apache.brooklyn.util.collections.MutableMap;
import org.apache.brooklyn.util.exceptions.Exceptions;
import org.apache.brooklyn.util.guava.Maybe;
import org.apache.brooklyn.util.guava.Maybe.Absent;
import org.apache.brooklyn.util.text.Strings;
import com.google.common.collect.Iterables;
public class BrooklynYamlLocationResolver {
protected final ManagementContext mgmt;
public BrooklynYamlLocationResolver(ManagementContext bmc) {
this.mgmt = bmc;
}
/** returns list of locations, if any were supplied, or null if none indicated */
@SuppressWarnings("unchecked")
public List<Location> resolveLocations(Map<? super String,?> attrs, boolean removeUsedAttributes) {
Object location = attrs.get("location");
Object locations = attrs.get("locations");
if (location==null && locations==null)
return null;
Location locationFromString = null;
List<Location> locationsFromList = null;
if (location!=null) {
if (location instanceof String) {
locationFromString = resolveLocationFromString((String)location);
} else if (location instanceof Map) {
locationFromString = resolveLocationFromMap((Map<?,?>)location);
} else {
throw new IllegalStateException("Illegal parameter for 'location'; must be a string or map (but got "+location+")");
}
}
if (locations!=null) {
if (!(locations instanceof Iterable))
throw new IllegalStateException("Illegal parameter for 'locations'; must be an iterable (but got "+locations+")");
locationsFromList = resolveLocations( (Iterable<Object>)locations );
}
if (locationFromString!=null && locationsFromList!=null) {
if (locationsFromList.size() != 1)
throw new IllegalStateException("Conflicting 'location' and 'locations' ("+location+" and "+locations+"); "
+ "if both are supplied the list must have exactly one element being the same");
if (!locationFromString.equals( Iterables.getOnlyElement(locationsFromList) ))
throw new IllegalStateException("Conflicting 'location' and 'locations' ("+location+" and "+locations+"); "
+ "different location specified in each");
} else if (locationFromString!=null) {
locationsFromList = Arrays.asList(locationFromString);
}
return locationsFromList;
}
public List<Location> resolveLocations(Iterable<Object> locations) {
List<Location> result = MutableList.of();
for (Object l: locations) {
Location ll = resolveLocation(l);
if (ll!=null) result.add(ll);
}
return result;
}
public Location resolveLocation(Object location) {
if (location instanceof String) {
return resolveLocationFromString((String)location);
} else if (location instanceof Map) {
return resolveLocationFromMap((Map<?,?>)location);
}
// could support e.g. location definition
throw new IllegalStateException("Illegal parameter for 'location' ("+location+"); must be a string or map");
}
/** resolves the location from the given spec string, either "Named Location", or "named:Named Location" format;
* returns null if input is blank (or null); otherwise guaranteed to resolve or throw error */
public Location resolveLocationFromString(String location) {
if (Strings.isBlank(location)) return null;
return resolveLocation(location, MutableMap.of());
}
public Location resolveLocationFromMap(Map<?,?> location) {
if (location.size() > 1) {
throw new IllegalStateException("Illegal parameter for 'location'; expected a single entry in map ("+location+")");
}
Object key = Iterables.getOnlyElement(location.keySet());
Object value = location.get(key);
if (!(key instanceof String)) {
throw new IllegalStateException("Illegal parameter for 'location'; expected String key ("+location+")");
}
if (!(value instanceof Map)) {
throw new IllegalStateException("Illegal parameter for 'location'; expected config map ("+location+")");
}
return resolveLocation((String)key, (Map<?,?>)value);
}
protected Location resolveLocation(String spec, Map<?,?> flags) {
LocationDefinition ldef = mgmt.getLocationRegistry().getDefinedLocationByName((String)spec);
if (ldef!=null)
// found it as a named location
return mgmt.getLocationRegistry().resolve(ldef, null, flags).get();
Maybe<Location> l = mgmt.getLocationRegistry().resolve(spec, null, flags);
if (l.isPresent()) return l.get();
RuntimeException exception = ((Absent<?>)l).getException();
throw new IllegalStateException("Illegal parameter for 'location' ("+spec+"); not resolvable: "+
Exceptions.collapseText( exception ), exception);
}
}