Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryanjbaxter
ryanjbaxter committed Feb 17, 2015
0 parents commit 57bdeb3
Show file tree
Hide file tree
Showing 65 changed files with 3,494 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#
# Copyright IBM Corp. 2014
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
.classpath
.project
.settings/
target/
*.class

# Package Files #
*.jar
*.war
*.ear
202 changes: 202 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2 changes: 2 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
This product includes software originally developed by IBM Corporation
Copyright 2014 IBM Corp.
149 changes: 149 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
## About
This project is meant to simplify the way Java developers access services
when deploying apps to IBM Bluemix. When leveraging a bound service in an app
deployed to Bluemix you need to do go through a number of steps regardless of the
service you bound.

1. Access the value of the VCAP_SERVICES environment variable.
2. Parse the returned String into some type of Java object you can work with.
3. Extract the data for the service you are interested in.
4. Extract the credentials for the service you are interested in.
5. Use the services Java client libraries to interact with that service.

Since these steps are pretty much repeated multiple times across all Java apps it is a great
opportunity to create a library that takes care of writing this mundane code. The
[Spring Cloud Connectors project](http://cloud.spring.io/spring-cloud-connectors/)
already does this for [some services](https://github.com/spring-cloud/spring-cloud-connectors/tree/master/spring-cloud-cloudfoundry-connector)
that are common across all Cloud Foundry deployments. However there are many services in Bluemix
that are not part of this project. This project builds upon the Spring Cloud Connectors
project and provides connectors for the services within Bluemix.

### Supported Services
In addition to the services supported by the Spring Cloud Connectors project the
Bluemix Cloud Connectors project supports the following services

* Cloudant - via the [Ektorp library](http://ektorp.org/)
* SendGrid - SendGrid is already supported by the Spring Cloud Connectors project but due to
the way the service credentials are created in VCAP_SERVICES it did not work
* Twilio - via the [Twilio client library](https://www.twilio.com/docs/java/install)

## When To Use This Project
If you are using the Liberty Runtime in Bluemix you can take advantage of the
[auto-configuration](https://www.ng.bluemix.net/docs/#starters/liberty/index.html#automaticconfigurationofboundservices)
features which may do the same thing as this project so it doesn't make sense to use this
project in your app in that case. However if you are not using the Liberty Runtime and you are using
another Java buildpack to run your application than this library might make sense. Also if you want to
use the Liberty buildpack but want the application to manage the connection to the service than this might
also be a situation when you might want to use this library. In addition when developing locally you can configure
connection to local or remote services via a properties file instead of configuring the server itself.

## Getting Started

### Getting The Dependencies

Add the following dependency to you Maven/Gradle project.

TODO Add code

Alternatively you can download the jar from here.

### Accessing The Service Credentials In A Non-Spring App
In a non-Spring app you can easily access the credentials of a service from a ServiceInfo class.
Here is how you would get a list of ServiceInfos for the services bound to your application.

```
CloudFactory cloudFactory = new CloudFactory();
Cloud cloud = cloudFactory.getCloud();
List<ServiceInfo> serviceInfos = cloud.getServiceInfos();
```

You can also get a subset of ServiceInfo objects for a specific service type, for example
Cloudant.

```
List<ServiceInfo> databaseInfos = cloud.getServiceInfos(CouchDbInstance.class);
```

Alternatively you can also get a higher level Java object to work with for a specific service.

```
//The serviceId variable should be the name you gave to your service.
String serviceId = "cloudant-db";
CouchDbInstance couchDb = cloud.getServiceConnector(serviceId, CouchDbInstance.class, null /* default config */);
```

For more detailed information on how this works you should read the
[Spring Cloud Connectors documentation](https://github.com/spring-cloud/spring-cloud-connectors/tree/master/spring-cloud-core).

There is a sample JEE app using the Bluemix Cloud Connectors project in the samples/cloudant-liberty folder.

### Accessing The Service Credentials In A Spring App
When you are using Spring you can easily create beans for services you have bound to your app in Bluemix.

```
public class Config {
@Configuration
static class CloudConfiguration extends AbstractCloudConfig {
@Bean
public CouchDbInstance couchDbInstance() {
CouchDbInstance instance = connectionFactory().service(CouchDbInstance.class);
return instance;
}
}
}
```

This bean can now be injected into other classes and used to access the service bound to your application.
For more detailed information see the
[Spring Cloud Connectors documentation](https://github.com/spring-cloud/spring-cloud-connectors/tree/master/spring-cloud-spring-service-connector).

There is a sample Spring app using the Bluemix Cloud Connectors project in the samples/cloudant-spring folder.

### When Running Locally
When building apps for Bluemix, you usually want to also run your application locally during
development. Developers have come up with various ways of achieving this. Some set a VCAP_SERVICES environment
variable on their development machine. Others write code that tries to determine if the application is running
locally or in the cloud. In Spring you can use something like Spring profiles to enable certain configuration beans
when running in the cloud and running locally.

The Spring Cloud Connectors project has a simple way of allowing developers
to run their Bluemix apps in the cloud and locally without having to write any extra code. You can read more about how this works
in the [Spring Cloud Connectors project](https://github.com/spring-cloud/spring-cloud-connectors/tree/3ec88aba9ed85f2b09d2cafb620ad1d4a28aaa9d/spring-cloud-localconfig-connector).

In short, create a file called `spring-cloud-bootstrap.properties` in the project and add it to the project classpath.
In that file create a property called `spring.cloud.propertiesFile`. The value of the property should be a path to another
properties file which will contain the credentials to the service to use when running locally. Here is a sample
`spring-cloud-bootstrap.properties` file.

spring.cloud.propertiesFile: ${user.home}/.config/cloudant-connector-sample/spring-cloud.properties

The properties file containing the service credentials should contain 2 properties `spring.cloud.appId` and
`spring.cloud.{id}` where {id} is the service ID you are using for your service in the cloud. The `spring.cloud.appId`
property should be a unique id for your app. The `spring.cloud.{id}` should be a URL to your service including any credentials
needed to access the service. Here is a sample

spring.cloud.appId: cloudant-sample
spring.cloud.cloudant: couchdb://user:pass@localhost:5984

#### Cloudant/CouchDB

The Spring Cloud Connectors project assumes that the `spring.cloud.{id}` is a URL. Unfortunately Cloudant/CouchDB operates over
HTTP so it is hard for the Bluemix Cloud Connectors project to know what connector to use. For that reason you must use the `couchdb`
protocol (which is something we made up), for example `couchdb://user:pass@localhost:5984`.

#### Twilio

The Spring Cloud Connectors project assumes that the `spring.cloud.{id}` is a URL. Unfortunately Twilio operates over
HTTP so it is hard for the Bluemix Cloud Connectors project to know what connector to use. For that reason you must use the `twilio`
protocol (which is something we made up), for example `twilio://user:pass@localhost:5984`.


## License

This code is licensed under Apache v2. See the LICENSE file in the root of
the repository.

## Dependencies

For a list of 3rd party dependencies that are used see the POM files of the individual projects.
Loading

0 comments on commit 57bdeb3

Please sign in to comment.