org.apache.brooklyn.location.jclouds.api

Interface JcloudsLocationPublic

All Superinterfaces:

BrooklynObject, CloudLocationConfig, Configurable, Identifiable, JcloudsLocationConfig, JcloudsLocationConfigPublic, Location, LocationWithObjectStore, MachineManagementMixins.GivesMachineMetadata, MachineManagementMixins.KillsMachines, MachineManagementMixins.ListsMachines, MachineManagementMixins.ResumesMachines, MachineManagementMixins.RichMachineProvisioningLocation<MachineLocation>, MachineManagementMixins.SuspendResumeLocation, MachineManagementMixins.SuspendsMachines, MachineProvisioningLocation<MachineLocation>, ProvisioningLocation<MachineLocation>

All Known Implementing Classes:

DockerJcloudsLocation, JcloudsLocation

public interface JcloudsLocationPublic
extends JcloudsLocationConfig, MachineManagementMixins.RichMachineProvisioningLocation<MachineLocation>, LocationWithObjectStore, MachineManagementMixins.SuspendResumeLocation

A public interface in front of Jclouds Location for use from downstream projects which wish to reference JcloudsLocation but not have a package-dependency on org.apache.brooklyn.location.jclouds (which pulls in many of the jclouds bundles)

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	COMMON_USER_NAMES_TO_TRY
static java.util.List<java.lang.String>	ROOT_ALIASES these userNames are known to be the preferred/required logins in some common/default images where root@ is not allowed to log in
static java.lang.String	ROOT_USERNAME

Fields inherited from interface org.apache.brooklyn.location.jclouds.JcloudsLocationConfig

COMPUTE_SERVICE_REGISTRY, CONNECTIVITY_RESOLVER, CUSTOM_CREDENTIALS, IMAGE_CHOOSER, JCLOUDS_LOCATION_CUSTOMIZER, JCLOUDS_LOCATION_CUSTOMIZER_TYPE, JCLOUDS_LOCATION_CUSTOMIZERS, JCLOUDS_LOCATION_CUSTOMIZERS_SUPPLIER_TYPE, OS_FAMILY, OS_FAMILY_OVERRIDE, OS_VERSION_REGEX, PORT_FORWARDER, TEMPLATE_BUILDER

Fields inherited from interface org.apache.brooklyn.location.jclouds.api.JcloudsLocationConfigPublic

AUTO_ASSIGN_FLOATING_IP, AUTO_CREATE_FLOATING_IPS, AUTO_GENERATE_KEYPAIRS, CLOUD_PROVIDER, CUSTOM_MACHINE_SETUP_SCRIPT_URL, CUSTOM_MACHINE_SETUP_SCRIPT_URL_LIST, CUSTOM_MACHINE_SETUP_SCRIPT_VARS, CUSTOM_TEMPLATE_OPTIONS_SCRIPT_CONTENTS, DEFAULT_IMAGE_ID, DISABLE_ROOT_AND_PASSWORD_SSH, DONT_CREATE_USER, DONT_REQUIRE_TTY_FOR_SUDO, EXTRA_PUBLIC_KEY_DATA_TO_AUTH, EXTRA_PUBLIC_KEY_URLS_TO_AUTH, GENERATE_HOSTNAME, GRANT_USER_SUDO, GROUP_ID, HARDWARE_ID, IMAGE_DESCRIPTION_REGEX, IMAGE_ID, IMAGE_NAME_REGEX, INCLUDE_BROOKLYN_USER_METADATA, JCLOUDS_KEY_ENDPOINT, JCLOUDS_KEY_USERNAME, KEY_PAIR, LOCAL_TEMP_DIR, LOGIN_USER, LOGIN_USER_PASSWORD, LOGIN_USER_PRIVATE_KEY_DATA, LOGIN_USER_PRIVATE_KEY_FILE, LOOKUP_AWS_HOSTNAME, MACHINE_CREATE_ATTEMPTS, MACHINE_CREATION_SEMAPHORE, MAP_DEV_RANDOM_TO_DEV_URANDOM, MAX_CONCURRENT_MACHINE_CREATIONS, NETWORK_NAME, OPEN_IPTABLES, OVERRIDE_RAM, PORT_FORWARDING_MANAGER, RUN_AS_ROOT, SECURITY_GROUPS, STOP_IPTABLES, STRING_TAGS, TAGS, TEMPLATE_OPTIONS, TEMPLATE_SPEC, USE_JCLOUDS_SSH_INIT, USE_MACHINE_PUBLIC_ADDRESS_AS_PRIVATE_ADDRESS, USE_PORT_FORWARDING, USER_DATA_UUENCODED, USER_METADATA, USER_METADATA_MAP, USER_METADATA_STRING

Fields inherited from interface org.apache.brooklyn.core.location.cloud.CloudLocationConfig

ACCESS_CREDENTIAL, ACCESS_IDENTITY, ADDITIONAL_INBOUND_PORTS, CALLER_CONTEXT, CLOUD_AVAILABILITY_ZONE_ID, CLOUD_ENDPOINT, CLOUD_REGION_ID, DESTROY_ON_FAILURE, DOMAIN_NAME, EXTENSION, INBOUND_PORTS, LEGACY_PRIVATE_KEY_DATA, LEGACY_PRIVATE_KEY_FILE, LEGACY_PRIVATE_KEY_PASSPHRASE, LEGACY_PUBLIC_KEY_DATA, LEGACY_PUBLIC_KEY_FILE, LOG_CREDENTIALS, MACHINE_LOCATION_CUSTOMIZERS, MIN_CORES, MIN_DISK, MIN_RAM, OAUTH_ENDPOINT, OS_64_BIT, PASSWORD, POLL_FOR_FIRST_REACHABLE_ADDRESS, POLL_FOR_FIRST_REACHABLE_ADDRESS_PREDICATE, POLL_FOR_FIRST_REACHABLE_ADDRESS_PREDICATE_TYPE, PRIVATE_KEY_DATA, PRIVATE_KEY_FILE, PRIVATE_KEY_PASSPHRASE, PUBLIC_KEY_DATA, PUBLIC_KEY_FILE, USER, VM_NAME_ALLOWED_CHARACTERS, VM_NAME_MAX_LENGTH, VM_NAME_SALT_LENGTH, WAIT_FOR_SSHABLE, WAIT_FOR_WINRM_AVAILABLE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCredential()
java.lang.String	getEndpoint()
java.lang.String	getIdentity()
java.lang.String	getProvider()
java.lang.String	getRegion() returns the location ID used by the provider, if set, e.g.
java.lang.String	toStringNice() return a nice string suitable for display messages

Methods inherited from interface org.apache.brooklyn.api.location.MachineProvisioningLocation

getProvisioningFlags, newSubLocation, obtain, release

Methods inherited from interface org.apache.brooklyn.api.location.Location

containsLocation, getAllConfig, getChildren, getConfig, getDisplayName, getExtension, getId, getParent, hasConfig, hasExtension, relations, setParent, toVerboseString

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig, setConfig

Methods inherited from interface org.apache.brooklyn.api.location.MachineManagementMixins.ListsMachines

listMachines

Methods inherited from interface org.apache.brooklyn.api.location.MachineManagementMixins.GivesMachineMetadata

getMachineMetadata

Methods inherited from interface org.apache.brooklyn.api.location.MachineManagementMixins.KillsMachines

killMachine, killMachine

Methods inherited from interface org.apache.brooklyn.core.mgmt.persist.LocationWithObjectStore

newPersistenceObjectStore

Methods inherited from interface org.apache.brooklyn.api.location.MachineManagementMixins.SuspendsMachines

suspendMachine

Methods inherited from interface org.apache.brooklyn.api.location.MachineManagementMixins.ResumesMachines

resumeMachine

Field Detail

ROOT_USERNAME

static final java.lang.String ROOT_USERNAME

See Also:

Constant Field Values

ROOT_ALIASES

static final java.util.List<java.lang.String> ROOT_ALIASES

these userNames are known to be the preferred/required logins in some common/default images where root@ is not allowed to log in

COMMON_USER_NAMES_TO_TRY

static final java.util.List<java.lang.String> COMMON_USER_NAMES_TO_TRY

Method Detail

getProvider

java.lang.String getProvider()

getIdentity

java.lang.String getIdentity()

getCredential

java.lang.String getCredential()

getRegion

java.lang.String getRegion()

returns the location ID used by the provider, if set, e.g. us-west-1

getEndpoint

java.lang.String getEndpoint()

toStringNice

java.lang.String toStringNice()

return a nice string suitable for display messages