com.ibm.watson.developer_cloud.util

Class CredentialUtils

java.lang.Object

com.ibm.watson.developer_cloud.util.CredentialUtils

public final class CredentialUtils
extends java.lang.Object

CredentialUtils retrieves service credentials from the environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CredentialUtils.ServiceCredentials A util class to easily store service credentials.

Method Summary

Methods

Modifier and Type	Method and Description
static CredentialUtils.ServiceCredentials	getCredentialsFromVcap(java.lang.String serviceName) Calls methods to parse VCAP_SERVICES and retrieve credential values.
static CredentialUtils.ServiceCredentials	getFileCredentials(java.lang.String serviceName) Calls methods to find and parse a credential file in various locations.
static boolean	hasBadStartOrEndChar(java.lang.String credentialValue) Returns true if the supplied value begins or ends with curly brackets or quotation marks.
static void	setContext(java.util.Hashtable<java.lang.String,java.lang.String> env) Sets the context variable for JDNI.
static void	setServices(java.lang.String services) Sets the VCAP_SERVICES variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

hasBadStartOrEndChar

public static boolean hasBadStartOrEndChar(java.lang.String credentialValue)

Returns true if the supplied value begins or ends with curly brackets or quotation marks. Returns false for null inputs.

Parameters:

credentialValue - the credential value to check

Returns:

true if the value starts or ends with these characters and is therefore invalid

getCredentialsFromVcap

public static CredentialUtils.ServiceCredentials getCredentialsFromVcap(java.lang.String serviceName)

Calls methods to parse VCAP_SERVICES and retrieve credential values. For some values, if VCAP_SERVICES aren't present, it'll fall back to checking JDNI.

Parameters:

serviceName - the service name

Returns:

ServiceCredentials object containing parsed values

setServices

public static void setServices(java.lang.String services)

Sets the VCAP_SERVICES variable. This is utility variable for testing

Parameters:

services - the VCAP_SERVICES

setContext

public static void setContext(java.util.Hashtable<java.lang.String,java.lang.String> env)

Sets the context variable for JDNI. This is a utility method for testing.

Parameters:

env - Configuration options for the context

getFileCredentials

public static CredentialUtils.ServiceCredentials getFileCredentials(java.lang.String serviceName)

Calls methods to find and parse a credential file in various locations.

Parameters:

serviceName - the service name

Returns:

ServiceCredentials object containing parsed values