Brooklyn

brooklyn.location.basic.jclouds
[Java] Class CredentialsFromEnv

java.lang.Object
  brooklyn.location.basic.jclouds.CredentialsFromEnv

public class CredentialsFromEnv

The credentials to use for a jclouds location, loaded from environment variables / system properties Preferred format is: brooklyn.jclouds.aws-ec2.identity brooklyn.jclouds.aws-ec2.credentials brooklyn.jclouds.aws-ec2.public-key-file brooklyn.jclouds.aws-ec2.private-key-file It will also support the following syntax (in decreasing order of preference): JCLOUDS_AWS_EC2_IDENTITY (and the others, using bash shell format) brooklyn.jclouds.identity (and the others, just without the provider) JCLOUDS_IDENTITY (and the others, using bash shell format without the provider) A number of other properties are also supported, listed in the SUPPORTED_* maps in JcloudsLocation. These include imageId, imageNameRegex, minRam, etc. Note that the camel case referenced there should be converted to the hyphenated syntax above (brooklyn.jclouds.provider.image-id) or underscores in the case of environment variables (e.g. JCLOUDS_CLOUDSERVERS_UK_IMAGE_ID).

Authors:
aled, alex


Field Summary
static Logger log

protected java.util.Map props

map containing the extracted properties, e.g.

 
Constructor Summary
CredentialsFromEnv(java.lang.String provider)

CredentialsFromEnv(java.util.Map properties, java.lang.String provider)

CredentialsFromEnv(BrooklynProperties sysProps, java.lang.String provider)

 
Method Summary
java.util.Map asMap()

protected static java.lang.String convertFromCamelToProperty(java.lang.String word)

protected static java.lang.String convertFromPropertyToShell(java.lang.String word)

protected java.lang.String findProviderSpecificValueFile(java.lang.String type)

java.lang.String getCredential()

java.lang.String getIdentity()

java.lang.String getLocationName()

location name is a user-suppliable name for the location, or null if no location

java.lang.String getPrivateKeyFile()

java.lang.String getProvider()

provider is the jclouds provider, or null if not jclouds

protected java.lang.String getProviderSpecificValue(java.lang.String type)

protected java.lang.String getProviderSpecificValue(java.util.Map flags, java.lang.String typeCamel)

protected java.lang.String getProviderSpecificValueWithDefault(java.lang.String type, java.lang.String defaultValue)

java.lang.String getPublicKeyFile()

protected java.lang.String getRequiredProviderSpecificValue(java.lang.String type)

static CredentialsFromEnv newInstance(java.util.Map flags, java.lang.String provider)

creates a new instance, allowing credentials easily to be specified, directly as keys of the form: provider, identity, credential, publicKeyFile, privateKeyFile

protected java.lang.String pickExistingFile(java.util.List candidates)

protected java.lang.String pickExistingFile(java.util.List candidates, java.lang.String defaultIfNone)

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Field Detail

log

public static final Logger log


props

protected java.util.Map props
map containing the extracted properties, e.g. "provider", "publicKeyFile", etc; use asMap() to access


 
Constructor Detail

CredentialsFromEnv

public CredentialsFromEnv(java.lang.String provider)


CredentialsFromEnv

public CredentialsFromEnv(@SuppressWarnings("rawtypes") java.util.Map properties, java.lang.String provider)


CredentialsFromEnv

public CredentialsFromEnv(BrooklynProperties sysProps, java.lang.String provider)


 
Method Detail

asMap

@SuppressWarnings("rawtypes")
public java.util.Map asMap()


convertFromCamelToProperty

protected static java.lang.String convertFromCamelToProperty(java.lang.String word)


convertFromPropertyToShell

protected static java.lang.String convertFromPropertyToShell(java.lang.String word)


findProviderSpecificValueFile

protected java.lang.String findProviderSpecificValueFile(java.lang.String type)


getCredential

public java.lang.String getCredential()


getIdentity

public java.lang.String getIdentity()


getLocationName

public java.lang.String getLocationName()
location name is a user-suppliable name for the location, or null if no location


getPrivateKeyFile

public java.lang.String getPrivateKeyFile()


getProvider

public java.lang.String getProvider()
provider is the jclouds provider, or null if not jclouds


getProviderSpecificValue

protected java.lang.String getProviderSpecificValue(java.lang.String type)


getProviderSpecificValue

protected java.lang.String getProviderSpecificValue(@SuppressWarnings("rawtypes") java.util.Map flags, java.lang.String typeCamel)


getProviderSpecificValueWithDefault

protected java.lang.String getProviderSpecificValueWithDefault(java.lang.String type, java.lang.String defaultValue)


getPublicKeyFile

public java.lang.String getPublicKeyFile()


getRequiredProviderSpecificValue

protected java.lang.String getRequiredProviderSpecificValue(java.lang.String type)


newInstance

public static CredentialsFromEnv newInstance(java.util.Map flags, java.lang.String provider)
creates a new instance, allowing credentials easily to be specified, directly as keys of the form: provider, identity, credential, publicKeyFile, privateKeyFile


pickExistingFile

protected java.lang.String pickExistingFile(java.util.List candidates)


pickExistingFile

protected java.lang.String pickExistingFile(java.util.List candidates, java.lang.String defaultIfNone)


 

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