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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLAN_EXPERIMENTAL The Constant PLAN_EXPERIMENTAL.
static java.lang.String	PLAN_FREE The Constant PLAN_FREE.
static java.lang.String	PLAN_STANDARD The Constant PLAN_STANDARD.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAPIKey(java.lang.String serviceName) Returns the apiKey from the VCAP_SERVICES or null if doesn't exists.
static java.lang.String	getAPIKey(java.lang.String serviceName, java.lang.String plan) Returns the apiKey from the VCAP_SERVICES or null if doesn't exists.
static java.lang.String	getAPIUrl(java.lang.String serviceName) Gets the API url.
static java.lang.String	getAPIUrl(java.lang.String serviceName, java.lang.String plan) Returns the apiKey from the VCAP_SERVICES or null if doesn't exists.
static CredentialUtils.ServiceCredentials	getUserNameAndPassword(java.lang.String serviceName) Returns the username and password as defined in the VCAP_SERVICES or null if they do not exist or are not accessible.
static CredentialUtils.ServiceCredentials	getUserNameAndPassword(java.lang.String serviceName, java.lang.String plan) Returns the username and password as defined in the VCAP_SERVICES or null if they do not exist or are not accessible.
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

Field Detail

PLAN_EXPERIMENTAL

public static final java.lang.String PLAN_EXPERIMENTAL

The Constant PLAN_EXPERIMENTAL.

See Also:

Constant Field Values

PLAN_FREE

public static final java.lang.String PLAN_FREE

The Constant PLAN_FREE.

See Also:

Constant Field Values

PLAN_STANDARD

public static final java.lang.String PLAN_STANDARD

The Constant PLAN_STANDARD.

See Also:

Constant Field Values

Method Detail

getAPIKey

public static java.lang.String getAPIKey(java.lang.String serviceName)

Returns the apiKey from the VCAP_SERVICES or null if doesn't exists.

Parameters:

serviceName - the service name

Returns:

the API key or null if the service cannot be found.

getAPIKey

public static java.lang.String getAPIKey(java.lang.String serviceName,
                                         java.lang.String plan)

Returns the apiKey from the VCAP_SERVICES or null if doesn't exists. If plan is specified, then only credentials for the given plan will be returned.

Parameters:

serviceName - the service name

plan - the service plan: standard, free or experimental

Returns:

the API key

getUserNameAndPassword

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

Returns the username and password as defined in the VCAP_SERVICES or null if they do not exist or are not accessible. This is a utility method for getUserNameAndPassword(String, String). Invoking this method is identical to calling getUserNameAndPassword(serviceName, null);

Parameters:

serviceName - the name of the service whose credentials are sought

Returns:

an object representing the service's credentials

getUserNameAndPassword

public static CredentialUtils.ServiceCredentials getUserNameAndPassword(java.lang.String serviceName,
                                                                        java.lang.String plan)

Returns the username and password as defined in the VCAP_SERVICES or null if they do not exist or are not accessible. If a plan is provided then only the credentials for that plan (and service) will be returned. Null will be returned if the plan does not exist.

Parameters:

serviceName - the name of the service whose credentials are sought

plan - the plan name

Returns:

an object representing the service's credentials

getAPIUrl

public static java.lang.String getAPIUrl(java.lang.String serviceName)

Gets the API url.

Parameters:

serviceName - the service name

Returns:

the API url

getAPIUrl

public static java.lang.String getAPIUrl(java.lang.String serviceName,
                                         java.lang.String plan)

Returns the apiKey from the VCAP_SERVICES or null if doesn't exists. If plan is specified, then only credentials for the given plan will be returned.

Parameters:

serviceName - the service name

plan - the service plan: standard, free or experimental

Returns:

the API key

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