from-scratch 0.1.0

data/cookbooks/java/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+Contributing
+============
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. [**Add tests!**](https://github.com/agileorbit-cookbooks/java/blob/master/TESTING.md)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+As this cookbook is no longer maintained by Chef, you **do not** need to sign any sort of contributor agreement. Simply make your change and open a pull request.
+
+Contributions will only be accepted if they are fully tested as specified in [TESTING.md](https://github.com/agileorbit-cookbooks/java/blob/master/TESTING.md)

data/cookbooks/java/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'berkshelf', '~> 3.2.1'
+
+group :test do
+  gem 'foodcritic', '~> 4.0.0'
+  gem 'rubocop', '~> 0.27.1'
+  gem 'chefspec', '~> 4.1.1'
+end
+
+group :integration do
+  gem 'test-kitchen', '~> 1.2.1'
+  gem 'kitchen-vagrant', '~> 0.15'
+end

data/cookbooks/java/ISSUES.md

@@ -0,0 +1,43 @@
+Java Cookbook Issues
+=======================
+This file documents the steps necessary to report and issue with the Java cookbook. Following these guidelines will help ensure your issue is resolved in a timely manner.
+
+Reporting
+---------
+When you report an issue, please include the following information:
+
+- A high-level overview of what you are trying to accomplish
+- An [SSCCE](http://sscce.org/) _Short, Self Contained, Correct (Compilable), Example_
+- The command you ran
+- What you expected to happen
+- What actually happened
+- The exception backtrace(s), if any
+- What operating system and version
+- Everything output by running `env`
+- What version of the cookbook are you using?
+- What version of Ruby you are using (run `ruby -v`)
+- What version of Rubygems you are using (run `gem -v`)
+- What version of Chef you are using (run `knife -v`)
+
+Here's a snippet you can copy-paste into the issue and fill out:
+
+```text
+(What is the issue? What are you trying to do? What happened?)
+
+- Command: `...`
+- OS:
+- Cookbook Version:
+- Ruby Version:
+- Rubygems Version:
+- Chef Version:
+- env:
+    ```text
+    # Paste your env here
+    ```
+- Backtrace:
+    ```text
+    # Paste backtrace here
+    ```
+```
+
+[Create a ticket](https://github.com/agileorbit-cookbooks/java/issues/new) describing your problem and include the information above.

data/cookbooks/java/LICENSE

@@ -0,0 +1,201 @@
+                              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.

data/cookbooks/java/README.md

@@ -0,0 +1,402 @@
+java
+=====
+
+This cookbook installs a Java JDK/JRE. It defaults to installing
+OpenJDK, but it can also install Oracle and IBM JDKs.
+
+Usage
+-----
+
+Simply include the `java` recipe wherever you would like Java installed, such as a run list (`recipe[java]`) or a cookbook (`include_recipe 'java'`). By default, OpenJDK 6 is installed. The `install_flavor` attribute is used to determine which JDK to install (OpenJDK, Oracle, IBM, or Windows), and `jdk_version` specifies which version to install (currently 6 and 7 are supported for all JDK types, 8 for Oracle only).
+
+### Examples
+
+To install Oracle Java 7 (note that when installing Oracle JDK, `accept_oracle_download_terms` attribute must be set -- see below role for an example):
+```ruby
+name "java"
+description "Install Oracle Java"
+default_attributes(
+  "java" => {
+    "install_flavor" => "oracle",
+    "jdk_version" => "7",
+    "oracle" => {
+      "accept_oracle_download_terms" => true
+    }
+  }
+)
+run_list(
+  "recipe[java]"
+)
+```
+
+Example role to install IBM flavored Java:
+```ruby
+name "java"
+description "Install IBM Java on Ubuntu"
+default_attributes(
+  "java" => {
+    "install_flavor" => "ibm",
+    "ibm" => {
+      "accept_ibm_download_terms" => true,
+      "url" => "http://fileserver.example.com/ibm-java-x86_64-sdk-7.0-4.1.bin",
+      "checksum" => "The SHA256 checksum of the bin"
+    }
+  }
+)
+run_list(
+  "recipe[java]"
+)
+```
+
+Requirements
+-----
+
+Chef 0.10.10+ and Ohai 6.10+ for `platform_family` use.
+
+### Platform
+
+* Debian, Ubuntu
+* CentOS, Red Hat, Fedora, Scientific, Amazon, XenServer
+* ArchLinux
+* FreeBSD
+* SmartOS
+* Windows
+* Mac OS X
+
+Attributes
+-----
+
+See `attributes/default.rb` for default values.
+
+* `node['java']['install_flavor']` - Flavor of JVM you would like
+installed (`oracle`, `oracle_rpm`, `openjdk`, `ibm`, `windows`), default `openjdk`
+on Linux/Unix platforms, `windows` on Windows platforms.
+* `node['java']['jdk_version']` - JDK version to install, defaults to
+  `'6'`.
+* `node['java']['java_home']` - Default location of the
+  "`$JAVA_HOME`".
+* `node['java']['set_etc_environment']` - Optionally sets
+  JAVA_HOME in `/etc/environment` for  Default `false`.
+* `node['java']['openjdk_packages']` - Array of OpenJDK package names
+  to install in the `java::openjdk` recipe. This is set based on the
+  platform.
+* `node['java']['tarball']` - Name of the tarball to retrieve from
+your internal repository, default `jdk1.6.0_29_i386.tar.gz`
+* `node['java']['tarball_checksum']` - Checksum for the tarball, if
+you use a different tarball, you also need to create a new sha256
+checksum
+* `node['java']['jdk']` - Version and architecture specific attributes
+for setting the URL on Oracle's site for the JDK, and the checksum of
+the .tar.gz.
+* `node['java']['oracle']['accept_oracle_download_terms']` - Indicates
+  that you accept Oracle's EULA
+* `node['java']['windows']['url']` - The internal location of your
+  java install for windows
+* `node['java']['windows']['package_name']` - The package name used by
+  windows_package to check in the registry to determine if the install
+  has already been run
+* `node['java']['windows']['checksum']` - The checksum for the package to
+  download on Windows machines (default is nil, which does not perform
+  checksum validation)
+* `node['java']['ibm']['url']` - The URL which to download the IBM
+  JDK/SDK. See the `ibm` recipe section below.
+* `node['java']['ibm']['accept_ibm_download_terms']` - Indicates that
+  you accept IBM's EULA (for `java::ibm`)
+* `node['java']['oracle_rpm']['type']` - Type of java RPM (`jre` or `jdk`), default `jdk`
+* `node['java']['oracle_rpm']['package_version']` - optional, can be set 
+  to pin a version different from the up-to-date one available in the YUM repo,
+  it might be needed to also override the node['java']['java_home'] attribute 
+  to a value consistent with the defined version
+* `node['java']['oracle_rpm']['package_name']` - optional, can be set 
+  to define a package name different from the RPM published by Oracle.
+* `node['java']['accept_license_agreement']` - Indicates that you accept
+  the EULA for openjdk package installation.
+* `node['java']['set_default']` - Indicates whether or not you want the
+  JDK installed to be default on the system.  Defaults to true.
+* `node['java']['oracle']['jce']['enabled']` - Indicates if the JCE Unlimited Strength Jurisdiction Policy Files should be installed for oracle JDKs
+* `node['java']['oracle']['jce']['home']` - Where the JCE policy files should be installed to
+* `node['java']['oracle']['jce'][java_version]['checksum']` - Checksum of the JCE policy zip. Can be sha256 or md5
+* `node['java']['oracle']['jce'][java_version]['url']` - URL which to download the JCE policy zip
+
+Recipes
+-----
+
+### default
+
+Include the default recipe in a run list or recipe to get `java`.  By default
+the `openjdk` flavor of Java is installed, but this can be changed by
+using the `install_flavor` attribute. By default on Windows platform
+systems, the `install_flavor` is `windows` and on Mac OS X platform systems, the `install_flavor` is `homebrew`.
+
+OpenJDK is the default because of licensing changes made upstream by
+Oracle. See notes on the `oracle` recipe below.
+
+NOTE: In most cases, including just the default recipe will be sufficient.
+It's possible to include the install_type recipes directly, as long as
+the necessary attributes (such as java_home) are set.
+
+### set_attributes_from_version
+
+Sets default attributes based on the JDK version. This is included by `default.rb`. This logic must be in
+a recipe instead of attributes/default.rb. See [#95](https://github.com/agileorbit-cookbooks/java/pull/95)
+for details.
+
+### default_java_symlink
+
+Updates /usr/lib/jvm/default-java to point to JAVA_HOME.
+
+### purge_packages
+
+Purges deprecated Sun Java packages.
+
+### openjdk
+
+This recipe installs the `openjdk` flavor of Java. It also uses the
+`alternatives` system on RHEL/Debian families to set the default Java.
+
+On platforms such as SmartOS that require the acceptance of a license
+agreement during package installation, set
+`node['java']['accept_license_agreement']` to true in order to indicate
+that you accept the license.
+
+### oracle
+
+This recipe installs the `oracle` flavor of Java. This recipe does not
+use distribution packages as Oracle changed the licensing terms with
+JDK 1.6u27 and prohibited the practice for both RHEL and Debian family
+platforms.
+
+As of 26 March 2012 you can no longer directly download the JDK from
+Oracle's website without using a special cookie. This cookbook uses
+that cookie to download the oracle recipe on your behalf, however the
+`java::oracle` recipe forces you to set either override the
+`node['java']['oracle']['accept_oracle_download_terms']` to true or
+set up a private repository accessible by HTTP.
+
+override the `accept_oracle_download_terms` in, e.g., `roles/base.rb`
+```ruby
+    default_attributes(
+      :java => {
+         :oracle => {
+           "accept_oracle_download_terms" => true
+         }
+       }
+    )
+```
+
+For both RHEL and Debian families, this recipe pulls the binary
+distribution from the Oracle website, and installs it in the default
+`JAVA_HOME` for each distribution. For Debian, this is
+`/usr/lib/jvm/default-java`. For RHEl, this is `/usr/lib/jvm/java`.
+
+After putting the binaries in place, the `java::oracle` recipe updates
+`/usr/bin/java` to point to the installed JDK using the
+`update-alternatives` script. This is all handled in the `java_ark`
+LWRP.
+
+### oracle_i386
+
+This recipe installs the 32-bit Java virtual machine without setting
+it as the default. This can be useful if you have applications on the
+same machine that require different versions of the JVM.
+
+This recipe operates in a similar manner to `java::oracle`.
+
+### oracle_rpm
+
+This recipe installs the Oracle JRE or JDK provided by a custom YUM
+repositories.
+It also uses the `alternatives` system on RHEL families to set
+the default Java.
+
+### windows
+
+Because there is no easy way to pull the java msi off oracle's site,
+this recipe requires you to host it internally on your own http repo.
+
+**IMPORTANT NOTE**
+
+If you use the `windows` recipe, you'll need to make sure you've uploaded
+the `aws` and `windows` cookbooks. As of version 1.18.0, this cookbook
+references them with `suggests` instead of `depends`, as they are only
+used by the `windows` recipe.
+
+### ibm
+
+The `java::ibm` recipe is used to install the IBM version of Java.
+Note that IBM requires you to create an account *and* log in to
+download the binary installer for your platform. You must accept the
+license agreement with IBM to use their version of Java. In this
+cookbook, you indicate this by setting
+`node['java']['ibm']['accept_ibm_download_terms']` to `true`. You must
+also host the binary on your own HTTP server to have an automated
+installation. The `node['java']['ibm']['url']` attribute must be set
+to a valid https/http URL; the URL is checked for validity in the recipe.
+
+At this time the `java::ibm` recipe does not support multiple SDK
+installations.
+
+Resources/Providers
+-----
+
+### java_ark
+
+This cookbook contains the `java_ark` LWRP. Generally speaking this
+LWRP is deprecated in favor of `ark` from the
+[ark cookbook](https://github.com/opscode-cookbooks/ark), but it is
+still used in this cookbook for handling the Oracle JDK installation.
+
+By default, the extracted directory is extracted to
+`app_root/extracted_dir_name` and symlinked to `app_root/default`
+
+#### Actions
+
+- `:install`: extracts the tarball and makes necessary symlinks
+- `:remove`: removes the tarball and run update-alternatives for all
+  symlinked `bin_cmds`
+
+#### Attribute Parameters
+
+- `url`: path to tarball, .tar.gz, .bin (oracle-specific), and .zip
+  currently supported
+- `checksum`: SHA256 checksum, not used for security but avoid
+  redownloading the archive on each chef-client run
+- `app_home`: the default for installations of this type of
+  application, for example, `/usr/lib/tomcat/default`. If your
+  application is not set to the default, it will be placed at the same
+  level in the directory hierarchy but the directory name will be
+   `app_root/extracted_directory_name + "_alt"`
+- `app_home_mode`: file mode for app_home, is an integer
+- `bin_cmds`: array of binary commands that should be symlinked to
+  `/usr/bin`, examples are mvn, java, javac, etc. These cmds must be in
+  the `bin` subdirectory of the extracted folder. Will be ignored if this
+  `java_ark` is not the default
+- `owner`: owner of extracted directory, set to "root" by default
+- `group`: group of extracted directory, set to `:owner` by default
+- `default`: whether this the default installation of this package,
+  boolean true or false
+- `reset_alternatives`: whether alternatives is reset
+  boolean true or false
+- `use_alt_suffix`: whether '_alt' suffix is used for not default javas
+  boolean true or false
+
+#### Examples
+```ruby
+# install jdk6 from Oracle
+java_ark "jdk" do
+    url 'http://download.oracle.com/otn-pub/java/jdk/6u29-b11/jdk-6u29-linux-x64.bin'
+    checksum  'a8603fa62045ce2164b26f7c04859cd548ffe0e33bfc979d9fa73df42e3b3365'
+    app_home '/usr/local/java/default'
+    bin_cmds ["java", "javac"]
+    action :install
+end
+```
+### java_alternatives
+
+The `java_alternatives` LWRP uses `update-alternatives` command
+to set and unset command alternatives for various Java tools
+such as java, javac, etc.
+
+#### Actions
+
+- `:set`: set alternatives for Java tools
+- `:unset`: unset alternatives for Java tools
+
+#### Attribute Parameters
+
+- `java_location`: Java installation location.
+- `bin_cmds`: array of Java tool names to set or unset alternatives on.
+- `default`: whether to set the Java tools as system default. Boolean, defaults to `true`.
+- `priority`: priority of the alternatives. Integer, defaults to `1061`.
+
+#### Examples
+```ruby
+# set alternatives for java and javac commands
+java_alternatives "set java alternatives" do
+    java_location '/usr/local/java'
+    bin_cmds ["java", "javac"]
+    action :set
+end
+```
+
+Production Deployment with Oracle Java
+-----
+Oracle has been known to change the behavior of its download site frequently. It is recommended you store the archives on an artifact server or s3 bucket. You can then override the attributes in a cookbook, role, or environment:
+
+```ruby
+default['java']['jdk_version'] = '7'
+default['java']['install_flavor'] = 'oracle'
+default['java']['jdk']['7']['x86_64']['url'] = 'http://artifactory.example.com/artifacts/jdk-7u65-linux-x64.tar.gz'
+default['java']['oracle']['accept_oracle_download_terms'] = true
+```
+
+Recommendations for inclusion in community cookbooks
+-----
+
+This cookbook is a dependency for many other cookbooks in the Java/Chef sphere. Here are some guidelines for including it into other cookbooks:
+
+### Allow people to not use this cookbook
+Many users manage Java on their own or have systems that already have java installed. Give these users an option to skip this cookbook, for example:
+```ruby
+include_recipe 'java' if node['maven']['install_java']
+```
+
+This would allow a users of the maven cookbook to choose if they want the maven cookbook to install java for them or leave that up to the consumer.
+
+Another good example is from the [Jenkins Cookbook Java recipe](https://github.com/opscode-cookbooks/jenkins/commit/ca2a69d982011dc1bec6a6d0ee4da5c1a1599864).
+
+### Pinning to major version of cookbook and Java
+This cookbook follows semver. It is recommended to pin at the major version of this cookbook when including it in other cookbooks, eg: `depends 'java', '~> 1.0'`
+
+It is acceptable to set the `node['java']['jdk_version']` to a specific version if required for your software to run, eg software xyz requires Java 8 to run. Refrain from pinning to specific patches of the JDK to allow users to consume security updates.
+
+Development
+-----
+
+This cookbook uses
+[test-kitchen](https://github.com/opscode/test-kitchen) for
+integration tests and
+[ChefSpec/RSpec](https://github.com/sethvargo/chefspec) for unit tests.
+See [TESTING.md](https://github.com/agileorbit-cookbooks/java/blob/master/TESTING.md) for testing instructions.
+
+At this time due to licensing concerns, the IBM recipe is not set up
+in test kitchen. If you would like to test this locally, copy
+.kitchen.yml to .kitchen.local.yml and add the following suite:
+```yml
+suites:
+- name: ibm
+  run_list: ["recipe[java]"]
+  attributes:
+    java:
+      install_flavor: "ibm"
+      ibm:
+        accept_ibm_download_terms: true
+        url: "http://jenkins/ibm-java-x86_64-sdk-7.0-4.1.bin"
+        checksum: the-sha256-checksum
+```
+
+Log into the IBM DeveloperWorks site to download a copy of the IBM
+Java SDK you wish to use/test, host it on an internal HTTP server, and
+calculate the SHA256 checksum to use in the suite.
+
+License and Author
+-----
+
+* Author: Seth Chisamore (<schisamo@opscode.com>)
+* Author: Bryan W. Berry (<bryan.berry@gmail.com>)
+* Author: Joshua Timberman (<joshua@opscode.com>)
+* Author: Eric Helgeson (<erichelgeson@gmail.com>)
+
+Copyright: 2014, Agile Orbit, LLC
+
+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.