No more messy Bluemix JSON configs!
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
.travis.yml
LICENSE
README.md
pom.xml

README.md

Bluemix Config Parser

Build Status

##No more messy JSON config parsing!

When using Bluemix (CloudFoundry), services configuration are read by parsing the JSON from VCAP_SERVICES environment variable. This is a handy util library for parsing Bluemix VCAP_SERVICES configurations JSON. Common configs classess are provided so it'll even work with auto-completion on your favorite IDE.

Usage example

String password = BluemixConfigStore.getConfig().getCloudantNoSQLDB().getCredentials().getPassword();

Installing with Maven

<dependency>
  <groupId>com.clianz</groupId>
  <artifactId>bluemix-config-parser</artifactId>
  <version>0.0.5</version>
</dependency>

Configurations supported

Most of the common services on Bluemix are currently supported:

  • Business rules
  • Clear DB
  • Cloud AMQP (RabbitMQ)
  • Cloudant
  • Concept Expansion
  • Concept Insight
  • Dash DB
  • Data Cache
  • Document Conversion
  • Geospartial Analytics
  • IMF Push
  • Monitoring and Analytics
  • MQ Light
  • Relationship Extraction
  • Rank and Retrieve
  • Sesson Cache
  • SQL DB (DB2)
  • Trade-off Analytics
  • Twitter Insights
  • Weather Insights
  • Workflow
  • Workload Scheduler
  • Twilio
  • Elastic Search by Compose
  • Mongo DB by Compose
  • PostgreSQL by Compose
  • Redis by Compose

Add more bindings to other services if you need, let's do this once and for all for everyone.

Local development deployment

For local development, there are two common ways to setup environment:

  • Set VCAP_SERVICES JSON config for your dev space as an environment variable.

  • Or, start your app with a JVM variable pointing to a file containing your dev config, eg.

    -DVCAP_SERVICES_FILENAME=myDevConfig.json
    

Contributing

Pull requests are welcome. Project page: https://github.com/icha024/bluemix-config-parser/

Just fork this project, follow the pattern to add bindings/tests, then raise a pull request.