io.pivotal.cfenv.core

Class CfEnv

java.lang.Object

io.pivotal.cfenv.core.CfEnv

public class CfEnv
extends Object

Provides access to Cloud Foundry environment variables.

Author:

Mark Pollack

Constructor Summary

Constructors

Constructor and Description
CfEnv()
CfEnv(String vcapApplicationJson, String vcapServicesJson)

Method Summary

Modifier and Type	Method and Description
List<CfService>	findAllServices()
CfCredentials	findCredentialsByLabel(String... spec)
CfCredentials	findCredentialsByName(String... spec)
CfCredentials	findCredentialsByTag(String... spec)
CfService	findServiceByLabel(String... spec)
CfService	findServiceByName(String... spec)
CfService	findServiceByTag(String... spec)
List<CfService>	findServicesByLabel(String... spec)
List<CfService>	findServicesByName(String... spec)
List<CfService>	findServicesByTag(String... spec)
CfApplication	getApp()
boolean	isInCf() Checks that the value of the environment variable VCAP_APPLICATION is not null, usually indicating that this application is running inside of Cloud Foundry

Methods inherited from class java.lang.Object

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

Constructor Detail

CfEnv

public CfEnv()

CfEnv

public CfEnv(String vcapApplicationJson,
             String vcapServicesJson)

Method Detail

getApp

public CfApplication getApp()

findAllServices

public List<CfService> findAllServices()

findServicesByName

public List<CfService> findServicesByName(String... spec)

findServiceByName

public CfService findServiceByName(String... spec)

findServicesByLabel

public List<CfService> findServicesByLabel(String... spec)

findServiceByLabel

public CfService findServiceByLabel(String... spec)

findServiceByTag

public CfService findServiceByTag(String... spec)

findServicesByTag

public List<CfService> findServicesByTag(String... spec)

findCredentialsByName

public CfCredentials findCredentialsByName(String... spec)

findCredentialsByLabel

public CfCredentials findCredentialsByLabel(String... spec)

findCredentialsByTag

public CfCredentials findCredentialsByTag(String... spec)

isInCf

public boolean isInCf()

Checks that the value of the environment variable VCAP_APPLICATION is not null, usually indicating that this application is running inside of Cloud Foundry

Returns:

true if the environment variable VCAP_APPLICATION is not null, false otherwise.