org.apache.brooklyn.api.location

Interface LocationResolver

All Known Implementing Classes:

AbstractLocationResolver, ByonLocationResolver, CatalogLocationResolver, DefinedLocationByIdResolver, DockerLocationResolver, HostLocationResolver, JcloudsByonLocationResolver, JcloudsLocationResolver, KubernetesLocationResolver, LocalhostLocationResolver, MultiLocationResolver, NamedLocationResolver, OpenShiftLocationResolver, PortForwardManagerLocationResolver, ServerPoolLocationResolver, SingleMachineLocationResolver

public interface LocationResolver

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

Method Summary

Modifier and Type	Method and Description
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)
boolean	isEnabled() whether the location is enabled
LocationSpec<? extends Location>	newLocationSpecFromString(java.lang.String spec, java.util.Map<?,?> locationFlags, LocationRegistry registry) Creates a LocationSpec given a spec string, flags (e.g.

Method Detail

init

void init(ManagementContext managementContext)

getPrefix

java.lang.String getPrefix()

the prefix that this resolver will attend to

accepts

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

whether the spec is something which should be passed to this resolver

isEnabled

boolean isEnabled()

whether the location is enabled

newLocationSpecFromString

LocationSpec<? extends Location> newLocationSpecFromString(java.lang.String spec,
                                                           java.util.Map<?,?> locationFlags,
                                                           LocationRegistry registry)

Creates a LocationSpec given a spec string, flags (e.g. user, key, cloud credential), and the registry itself from which the base properties are discovered and supporting locations which refer to other locations, e.g. NamedLocationResolver.