LocationConfigUtils.OsCredential (Apache Brooklyn)

java.lang.Object
- brooklyn.location.basic.LocationConfigUtils.OsCredential

Enclosing class:

LocationConfigUtils
```
@Beta
public static class LocationConfigUtils.OsCredential
extends java.lang.Object
```
Convenience class for holding private/public keys and passwords, inferring from config keys. See LocationConfigUtils.getOsCredential(ConfigBag).

Method Summary

Methods
Modifier and Type	Method and Description
`LocationConfigUtils.OsCredential`	`checkNoErrors()` throws if there were errors resolving (e.g.
`LocationConfigUtils.OsCredential`	`checkNotEmpty()` throws if there are any problems
`LocationConfigUtils.OsCredential`	`doKeyValidation(boolean doKeyValidation)` whether to check the private/public keys and passphrase are coherent; default true
`java.lang.String`	`getPassword()`
`java.lang.String`	`getPreferredCredential()` returns either the key or password or null; if both a key and a password this prefers the key unless otherwise set via `preferPassword()`
`java.lang.String`	`getPrivateKeyData()`
`java.lang.String`	`getPublicKeyData()`
`java.util.Set<java.lang.String>`	`getWarningMessages()`
`boolean`	`hasKey()`
`boolean`	`hasPassword()`
`boolean`	`isEmpty()` if there is no credential (ignores public key)
`boolean`	`isUsingPassword()` if a password is available, and either this is preferred over a key or there is no key
`LocationConfigUtils.OsCredential`	`logAnyWarnings()`
`static LocationConfigUtils.OsCredential`	`newInstance(ConfigBag config)`
`LocationConfigUtils.OsCredential`	`preferKey()` if both key and password supplied, prefer the key; the default
`LocationConfigUtils.OsCredential`	`preferPassword()` if both key and password supplied, prefer the password; see `preferKey()`
`LocationConfigUtils.OsCredential`	`requirePublicKey(boolean requirePublicKey)` if false, do not mind if there is no public key corresponding to any private key; defaults to true; only applies if a private key is set
`LocationConfigUtils.OsCredential`	`throwOnErrors(boolean throwOnErrors)` whether to throw on problems
`java.lang.String`	`toString()`
`LocationConfigUtils.OsCredential`	`useDefaultKeys(boolean tryDefaultKeys)` if true (the default) this will look at default locations set on keys
`LocationConfigUtils.OsCredential`	`warnOnErrors(boolean warnOnErrors)` whether to log warnings on problems

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - checkNotEmpty
```
public LocationConfigUtils.OsCredential checkNotEmpty()
```
    throws if there are any problems
  - checkNoErrors
```
public LocationConfigUtils.OsCredential checkNoErrors()
```
    throws if there were errors resolving (e.g. explicit keys, none of which were found/valid, or public key required and not found)
    
    Returns:
  - logAnyWarnings
```
public LocationConfigUtils.OsCredential logAnyWarnings()
```
  - getWarningMessages
```
public java.util.Set<java.lang.String> getWarningMessages()
```
  - getPreferredCredential
```
public java.lang.String getPreferredCredential()
```
    returns either the key or password or null; if both a key and a password this prefers the key unless otherwise set via preferPassword()
  - isEmpty
```
public boolean isEmpty()
```
    if there is no credential (ignores public key)
  - hasKey
```
public boolean hasKey()
```
  - hasPassword
```
public boolean hasPassword()
```
  - isUsingPassword
```
public boolean isUsingPassword()
```
    if a password is available, and either this is preferred over a key or there is no key
  - getPrivateKeyData
```
public java.lang.String getPrivateKeyData()
```
  - getPublicKeyData
```
public java.lang.String getPublicKeyData()
```
  - getPassword
```
public java.lang.String getPassword()
```
  - preferKey
```
public LocationConfigUtils.OsCredential preferKey()
```
    if both key and password supplied, prefer the key; the default
  - preferPassword
```
public LocationConfigUtils.OsCredential preferPassword()
```
    if both key and password supplied, prefer the password; see preferKey()
  - requirePublicKey
```
public LocationConfigUtils.OsCredential requirePublicKey(boolean requirePublicKey)
```
    if false, do not mind if there is no public key corresponding to any private key; defaults to true; only applies if a private key is set
  - doKeyValidation
```
public LocationConfigUtils.OsCredential doKeyValidation(boolean doKeyValidation)
```
    whether to check the private/public keys and passphrase are coherent; default true
  - useDefaultKeys
```
public LocationConfigUtils.OsCredential useDefaultKeys(boolean tryDefaultKeys)
```
    if true (the default) this will look at default locations set on keys
  - warnOnErrors
```
public LocationConfigUtils.OsCredential warnOnErrors(boolean warnOnErrors)
```
    whether to log warnings on problems
  - throwOnErrors
```
public LocationConfigUtils.OsCredential throwOnErrors(boolean throwOnErrors)
```
    whether to throw on problems
  - newInstance
```
public static LocationConfigUtils.OsCredential newInstance(ConfigBag config)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class LocationConfigUtils.OsCredential

Method Summary

Methods inherited from class java.lang.Object

Method Detail

checkNotEmpty

checkNoErrors

logAnyWarnings

getWarningMessages

getPreferredCredential

isEmpty

hasKey

hasPassword

isUsingPassword

getPrivateKeyData

getPublicKeyData

getPassword

preferKey

preferPassword

requirePublicKey

doKeyValidation

useDefaultKeys

warnOnErrors

throwOnErrors

newInstance

toString