diff --git a/README.adoc b/README.adoc index b4c5533c..a800d96d 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,4 @@ -// Do not edit this file (e.g. go instead to src/main/asciidoc) +// Do not edit this file (e.g. go instead to docs/src/main/asciidoc) image::https://travis-ci.org/spring-cloud/spring-cloud-commons.svg?branch=master[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-commons] @@ -7,6 +7,14 @@ http://pivotal.io/platform-as-a-service/migrating-to-cloud-native-application-ar Many of those features are covered by http://projects.spring.io/spring-boot[Spring Boot], which we build on in Spring Cloud. Some more are delivered by Spring Cloud as two libraries: Spring Cloud Context and Spring Cloud Commons. Spring Cloud Context provides utilities and special services for the `ApplicationContext` of a Spring Cloud application (bootstrap context, encryption, refresh scope and environment endpoints). Spring Cloud Commons is a set of abstractions and common classes used in different Spring Cloud implementations (eg. Spring Cloud Netflix vs. Spring Cloud Consul). +If you are getting an exception due to "Illegal key size" and you are using Sun's JDK, you need to install the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files. See the following links for more information: + +* Java 6 JCE Link http://www.oracle.com/technetwork/java/javase/downloads/jce-6-download-429243.html +* Java 7 JCE Link http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html +* Java 8 JCE Link http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html + +Extract files into JDK/jre/lib/security folder (whichever version of JRE/JDK x64/x86 you are using). + == Building :jdkversion: 1.7 @@ -54,46 +62,6 @@ parsing or rendering it, just copying it to `${main.basedir}` any changes in the README it will then show up after a Maven build as a modified file in the correct place. Just commit it and push the change. -=== Pull Requests - -Spring Cloud is released under the non-restrictive Apache 2.0 license, -and follows a very standard Github development process, using Github -tracker for issues and merging pull requests into master. If you want -to contribute even something trivial please do not hesitate, but -follow the guidelines below. - -==== Sign the Contributor License Agreement -Before we accept a non-trivial patch or pull request we will need you -to sign the -https://support.springsource.com/spring_committer_signup[contributor's -agreement]. Signing the contributor's agreement does not grant anyone -commit rights to the main repository, but it does mean that we can -accept your contributions, and you will get an author credit if we do. -Active contributors might be asked to join the core team, and given -the ability to merge pull requests. - -==== Code Conventions and Housekeeping -None of these is essential for a pull request, but they will all help. They can also be -added after the original pull request but before a merge. - -* Use the Spring Framework code format conventions. If you use Eclipse and you follow - the ``Importing into eclipse'' instructions below you should get project specific - formatting automatically. You can also import formatter settings using the - `eclipse-code-formatter.xml` file from the `eclipse` folder. If using IntelliJ, you can - use the http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin] - to import the same file. -* Make sure all new `.java` files to have a simple Javadoc class comment with at least an - `@author` tag identifying you, and preferably at least a paragraph on what the class is - for. -* Add the ASF license header comment to all new `.java` files (copy from existing files - in the project) -* Add yourself as an `@author` to the .java files that you modify substantially (more - than cosmetic changes). -* Add some Javadocs and, if you change the namespace, some XSD doc elements. -* A few unit tests would help a lot as well -- someone has to do it. -* If no-one else is using your branch, please rebase it against the current master (or - other target branch in the main project). - === Working with the code If you don't have an IDE preference we would recommend that you use http://www.springsource.com/developer/sts[Spring Tools Suite] or @@ -144,9 +112,11 @@ Maven is well supported by most Java IDEs. Refer to you vendor documentation. == Contributing -Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like -to contribute something, or simply want to hack on the code this document should help -you get started. +Spring Cloud is released under the non-restrictive Apache 2.0 license, +and follows a very standard Github development process, using Github +tracker for issues and merging pull requests into master. If you want +to contribute even something trivial please do not hesitate, but +follow the guidelines below. === Sign the Contributor License Agreement Before we accept a non-trivial patch or pull request we will need you to sign the @@ -180,4 +150,4 @@ added after the original pull request but before a merge. other target branch in the main project). * When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit - message (where XXXX is the issue number). \ No newline at end of file + message (where XXXX is the issue number).