diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/css/highlight.css b/spring-cloud-zookeeper/2.1.4.RELEASE/css/highlight.css new file mode 100644 index 00000000..3850f8b9 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/css/highlight.css @@ -0,0 +1,35 @@ +/* + code highlight CSS resemblign the Eclipse IDE default color schema + @author Costin Leau +*/ + +.hl-keyword { + color: #7F0055; + font-weight: bold; +} + +.hl-comment { + color: #3F5F5F; + font-style: italic; +} + +.hl-multiline-comment { + color: #3F5FBF; + font-style: italic; +} + +.hl-tag { + color: #3F7F7F; +} + +.hl-attribute { + color: #7F007F; +} + +.hl-value { + color: #2A00FF; +} + +.hl-string { + color: #2A00FF; +} \ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual-multipage.css b/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual-multipage.css new file mode 100644 index 00000000..b790654b --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual-multipage.css @@ -0,0 +1,9 @@ +@IMPORT url("manual.css"); + +body.firstpage { + background: url("../images/background.png") no-repeat center top; +} + +div.part h1 { + border-top: none; +} diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual-singlepage.css b/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual-singlepage.css new file mode 100644 index 00000000..303192a8 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual-singlepage.css @@ -0,0 +1,6 @@ +@IMPORT url("manual.css"); + +body { + background: url("../images/background.png") no-repeat center top; +} + diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual.css b/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual.css new file mode 100644 index 00000000..20cf07da --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/css/manual.css @@ -0,0 +1,342 @@ +@IMPORT url("highlight.css"); + +html { + padding: 0pt; + margin: 0pt; +} + +body { + color: #333333; + margin: 15px 30px; + font-family: Helvetica, Arial, Freesans, Clean, Sans-serif; + line-height: 1.6; + -webkit-font-smoothing: antialiased; +} + +code { + font-size: 16px; + font-family: Consolas, "Liberation Mono", Courier, monospace; +} + +:not(a) > code { + color: #6D180B; +} + +:not(pre) > code { + background-color: #F2F2F2; + border: 1px solid #CCCCCC; + border-radius: 4px; + padding: 1px 3px 0; + text-shadow: none; + white-space: nowrap; +} + +body > *:first-child { + margin-top: 0 !important; +} + +div { + margin: 0pt; +} + +hr { + border: 1px solid #CCCCCC; + background: #CCCCCC; +} + +h1, h2, h3, h4, h5, h6 { + color: #000000; + cursor: text; + font-weight: bold; + margin: 30px 0 10px; + padding: 0; +} + +h1, h2, h3 { + margin: 40px 0 10px; +} + +h1 { + margin: 70px 0 30px; + padding-top: 20px; +} + +div.part h1 { + border-top: 1px dotted #CCCCCC; +} + +h1, h1 code { + font-size: 32px; +} + +h2, h2 code { + font-size: 24px; +} + +h3, h3 code { + font-size: 20px; +} + +h4, h1 code, h5, h5 code, h6, h6 code { + font-size: 18px; +} + +div.book, div.chapter, div.appendix, div.part, div.preface { + min-width: 300px; + max-width: 1200px; + margin: 0 auto; +} + +p.releaseinfo { + font-weight: bold; + margin-bottom: 40px; + margin-top: 40px; +} + +div.authorgroup { + line-height: 1; +} + +p.copyright { + line-height: 1; + margin-bottom: -5px; +} + +.legalnotice p { + font-style: italic; + font-size: 14px; + line-height: 1; +} + +div.titlepage + p, div.titlepage + p { + margin-top: 0; +} + +pre { + line-height: 1.0; + color: black; +} + +a { + color: #4183C4; + text-decoration: none; +} + +p { + margin: 15px 0; + text-align: left; +} + +ul, ol { + padding-left: 30px; +} + +li p { + margin: 0; +} + +div.table { + margin: 1em; + padding: 0.5em; + text-align: center; +} + +div.table table, div.informaltable table { + display: table; + width: 100%; +} + +div.table td { + padding-left: 7px; + padding-right: 7px; +} + +.sidebar { + line-height: 1.4; + padding: 0 20px; + background-color: #F8F8F8; + border: 1px solid #CCCCCC; + border-radius: 3px 3px 3px 3px; +} + +.sidebar p.title { + color: #6D180B; +} + +pre.programlisting, pre.screen { + font-size: 15px; + padding: 6px 10px; + background-color: #F8F8F8; + border: 1px solid #CCCCCC; + border-radius: 3px 3px 3px 3px; + clear: both; + overflow: auto; + line-height: 1.4; + font-family: Consolas, "Liberation Mono", Courier, monospace; +} + +table { + border-collapse: collapse; + border-spacing: 0; + border: 1px solid #DDDDDD !important; + border-radius: 4px !important; + border-collapse: separate !important; + line-height: 1.6; +} + +table thead { + background: #F5F5F5; +} + +table tr { + border: none; + border-bottom: none; +} + +table th { + font-weight: bold; +} + +table th, table td { + border: none !important; + padding: 6px 13px; +} + +table tr:nth-child(2n) { + background-color: #F8F8F8; +} + +td p { + margin: 0 0 15px 0; +} + +div.table-contents td p { + margin: 0; +} + +div.important *, div.note *, div.tip *, div.warning *, div.navheader *, div.navfooter *, div.calloutlist * { + border: none !important; + background: none !important; + margin: 0; +} + +div.important p, div.note p, div.tip p, div.warning p { + color: #6F6F6F; + line-height: 1.6; +} + +div.important code, div.note code, div.tip code, div.warning code { + background-color: #F2F2F2 !important; + border: 1px solid #CCCCCC !important; + border-radius: 4px !important; + padding: 1px 3px 0 !important; + text-shadow: none !important; + white-space: nowrap !important; +} + +.note th, .tip th, .warning th { + display: none; +} + +.note tr:first-child td, .tip tr:first-child td, .warning tr:first-child td { + border-right: 1px solid #CCCCCC !important; + padding-top: 10px; +} + +div.calloutlist p, div.calloutlist td { + padding: 0; + margin: 0; +} + +div.calloutlist > table > tbody > tr > td:first-child { + padding-left: 10px; + width: 30px !important; +} + +div.important, div.note, div.tip, div.warning { + margin-left: 0px !important; + margin-right: 20px !important; + margin-top: 20px; + margin-bottom: 20px; + padding-top: 10px; + padding-bottom: 10px; +} + +div.toc { + line-height: 1.2; +} + +dl, dt { + margin-top: 1px; + margin-bottom: 0; +} + +div.toc > dl > dt { + font-size: 32px; + font-weight: bold; + margin: 30px 0 10px 0; + display: block; +} + +div.toc > dl > dd > dl > dt { + font-size: 24px; + font-weight: bold; + margin: 20px 0 10px 0; + display: block; +} + +div.toc > dl > dd > dl > dd > dl > dt { + font-weight: bold; + font-size: 20px; + margin: 10px 0 0 0; +} + +tbody.footnotes * { + border: none !important; +} + +div.footnote p { + margin: 0; + line-height: 1; +} + +div.footnote p sup { + margin-right: 6px; + vertical-align: middle; +} + +div.navheader { + border-bottom: 1px solid #CCCCCC; +} + +div.navfooter { + border-top: 1px solid #CCCCCC; +} + +.title { + margin-left: -1em; + padding-left: 1em; +} + +.title > a { + position: absolute; + visibility: hidden; + display: block; + font-size: 0.85em; + margin-top: 0.05em; + margin-left: -1em; + vertical-align: text-top; + color: black; +} + +.title > a:before { + content: "\00A7"; +} + +.title:hover > a, .title > a:hover, .title:hover > a:hover { + visibility: visible; +} + +.title:focus > a, .title > a:focus, .title:focus > a:focus { + outline: 0; +} diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/ghpages.sh b/spring-cloud-zookeeper/2.1.4.RELEASE/ghpages.sh new file mode 100644 index 00000000..57c5da3a --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/ghpages.sh @@ -0,0 +1,330 @@ +#!/bin/bash -x + +set -e + +# Set default props like MAVEN_PATH, ROOT_FOLDER etc. +function set_default_props() { + # The script should be executed from the root folder + ROOT_FOLDER=`pwd` + echo "Current folder is ${ROOT_FOLDER}" + + if [[ ! -e "${ROOT_FOLDER}/.git" ]]; then + echo "You're not in the root folder of the project!" + exit 1 + fi + + # Prop that will let commit the changes + COMMIT_CHANGES="no" + MAVEN_PATH=${MAVEN_PATH:-} + echo "Path to Maven is [${MAVEN_PATH}]" + REPO_NAME=${PWD##*/} + echo "Repo name is [${REPO_NAME}]" + SPRING_CLOUD_STATIC_REPO=${SPRING_CLOUD_STATIC_REPO:-git@github.com:spring-cloud/spring-cloud-static.git} + echo "Spring Cloud Static repo is [${SPRING_CLOUD_STATIC_REPO}" +} + +# Check if gh-pages exists and docs have been built +function check_if_anything_to_sync() { + git remote set-url --push origin `git config remote.origin.url | sed -e 's/^git:/https:/'` + + if ! (git remote set-branches --add origin gh-pages && git fetch -q); then + echo "No gh-pages, so not syncing" + exit 0 + fi + + if ! [ -d docs/target/generated-docs ] && ! [ "${BUILD}" == "yes" ]; then + echo "No gh-pages sources in docs/target/generated-docs, so not syncing" + exit 0 + fi +} + +function retrieve_current_branch() { + # Code getting the name of the current branch. For master we want to publish as we did until now + # http://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch + # If there is a branch already passed will reuse it - otherwise will try to find it + CURRENT_BRANCH=${BRANCH} + if [[ -z "${CURRENT_BRANCH}" ]] ; then + CURRENT_BRANCH=$(git symbolic-ref -q HEAD) + CURRENT_BRANCH=${CURRENT_BRANCH##refs/heads/} + CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD} + fi + echo "Current branch is [${CURRENT_BRANCH}]" + git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" +} + +# Switches to the provided value of the release version. We always prefix it with `v` +function switch_to_tag() { + git checkout v${VERSION} +} + +# Build the docs if switch is on +function build_docs_if_applicable() { + if [[ "${BUILD}" == "yes" ]] ; then + ./mvnw clean install -P docs -pl docs -DskipTests + fi +} + +# Get the name of the `docs.main` property +# Get whitelisted branches - assumes that a `docs` module is available under `docs` profile +function retrieve_doc_properties() { + MAIN_ADOC_VALUE=$("${MAVEN_PATH}"mvn -q \ + -Dexec.executable="echo" \ + -Dexec.args='${docs.main}' \ + --non-recursive \ + org.codehaus.mojo:exec-maven-plugin:1.3.1:exec) + echo "Extracted 'main.adoc' from Maven build [${MAIN_ADOC_VALUE}]" + + + WHITELIST_PROPERTY=${WHITELIST_PROPERTY:-"docs.whitelisted.branches"} + WHITELISTED_BRANCHES_VALUE=$("${MAVEN_PATH}"mvn -q \ + -Dexec.executable="echo" \ + -Dexec.args="\${${WHITELIST_PROPERTY}}" \ + org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \ + -P docs \ + -pl docs) + echo "Extracted '${WHITELIST_PROPERTY}' from Maven build [${WHITELISTED_BRANCHES_VALUE}]" +} + +# Stash any outstanding changes +function stash_changes() { + git diff-index --quiet HEAD && dirty=$? || (echo "Failed to check if the current repo is dirty. Assuming that it is." && dirty="1") + if [ "$dirty" != "0" ]; then git stash; fi +} + +# Switch to gh-pages branch to sync it with current branch +function add_docs_from_target() { + local DESTINATION_REPO_FOLDER + if [[ -z "${DESTINATION}" && -z "${CLONE}" ]] ; then + DESTINATION_REPO_FOLDER=${ROOT_FOLDER} + elif [[ "${CLONE}" == "yes" ]]; then + mkdir -p ${ROOT_FOLDER}/target + local clonedStatic=${ROOT_FOLDER}/target/spring-cloud-static + if [[ ! -e "${clonedStatic}/.git" ]]; then + echo "Cloning Spring Cloud Static to target" + git clone ${SPRING_CLOUD_STATIC_REPO} ${clonedStatic} && git checkout gh-pages + else + echo "Spring Cloud Static already cloned - will pull changes" + cd ${clonedStatic} && git checkout gh-pages && git pull origin gh-pages + fi + DESTINATION_REPO_FOLDER=${clonedStatic}/${REPO_NAME} + mkdir -p ${DESTINATION_REPO_FOLDER} + else + if [[ ! -e "${DESTINATION}/.git" ]]; then + echo "[${DESTINATION}] is not a git repository" + exit 1 + fi + DESTINATION_REPO_FOLDER=${DESTINATION}/${REPO_NAME} + mkdir -p ${DESTINATION_REPO_FOLDER} + echo "Destination was provided [${DESTINATION}]" + fi + cd ${DESTINATION_REPO_FOLDER} + git checkout gh-pages + git pull origin gh-pages + + # Add git branches + ################################################################### + if [[ -z "${VERSION}" ]] ; then + copy_docs_for_current_version + else + copy_docs_for_provided_version + fi + commit_changes_if_applicable +} + + +# Copies the docs by using the retrieved properties from Maven build +function copy_docs_for_current_version() { + if [[ "${CURRENT_BRANCH}" == "master" ]] ; then + echo -e "Current branch is master - will copy the current docs only to the root folder" + for f in docs/target/generated-docs/*; do + file=${f#docs/target/generated-docs/*} + if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then + # Not ignored... + cp -rf $f ${ROOT_FOLDER}/ + git add -A ${ROOT_FOLDER}/$file + fi + done + COMMIT_CHANGES="yes" + else + echo -e "Current branch is [${CURRENT_BRANCH}]" + # http://stackoverflow.com/questions/29300806/a-bash-script-to-check-if-a-string-is-present-in-a-comma-separated-list-of-strin + if [[ ",${WHITELISTED_BRANCHES_VALUE}," = *",${CURRENT_BRANCH},"* ]] ; then + mkdir -p ${ROOT_FOLDER}/${CURRENT_BRANCH} + echo -e "Branch [${CURRENT_BRANCH}] is whitelisted! Will copy the current docs to the [${CURRENT_BRANCH}] folder" + for f in docs/target/generated-docs/*; do + file=${f#docs/target/generated-docs/*} + if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then + # Not ignored... + # We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html + if [[ "${file}" == "${MAIN_ADOC_VALUE}.html" ]] ; then + # We don't want to copy the spring-cloud-sleuth.html + # we want it to be converted to index.html + cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html + git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html + else + cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH} + git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/$file + fi + fi + done + COMMIT_CHANGES="yes" + else + echo -e "Branch [${CURRENT_BRANCH}] is not on the white list! Check out the Maven [${WHITELIST_PROPERTY}] property in + [docs] module available under [docs] profile. Won't commit any changes to gh-pages for this branch." + fi + fi +} + +# Copies the docs by using the explicitly provided version +function copy_docs_for_provided_version() { + local FOLDER=${DESTINATION_REPO_FOLDER}/${VERSION} + mkdir -p ${FOLDER} + echo -e "Current tag is [v${VERSION}] Will copy the current docs to the [${FOLDER}] folder" + for f in ${ROOT_FOLDER}/docs/target/generated-docs/*; do + file=${f#${ROOT_FOLDER}/docs/target/generated-docs/*} + copy_docs_for_branch ${file} ${FOLDER} + done + COMMIT_CHANGES="yes" + CURRENT_BRANCH="v${VERSION}" +} + +# Copies the docs from target to the provided destination +# Params: +# $1 - file from target +# $2 - destination to which copy the files +function copy_docs_for_branch() { + local file=$1 + local destination=$2 + if ! git ls-files -i -o --exclude-standard --directory | grep -q ^${file}$; then + # Not ignored... + # We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html + if [[ ("${file}" == "${MAIN_ADOC_VALUE}.html") || ("${file}" == "${REPO_NAME}.html") ]] ; then + # We don't want to copy the spring-cloud-sleuth.html + # we want it to be converted to index.html + cp -rf $f ${destination}/index.html + git add -A ${destination}/index.html + else + cp -rf $f ${destination} + git add -A ${destination}/$file + fi + fi +} + +function commit_changes_if_applicable() { + if [[ "${COMMIT_CHANGES}" == "yes" ]] ; then + COMMIT_SUCCESSFUL="no" + git commit -a -m "Sync docs from ${CURRENT_BRANCH} to gh-pages" && COMMIT_SUCCESSFUL="yes" || echo "Failed to commit changes" + + # Uncomment the following push if you want to auto push to + # the gh-pages branch whenever you commit to master locally. + # This is a little extreme. Use with care! + ################################################################### + if [[ "${COMMIT_SUCCESSFUL}" == "yes" ]] ; then + git push origin gh-pages + fi + fi +} + +# Switch back to the previous branch and exit block +function checkout_previous_branch() { + # If -version was provided we need to come back to root project + cd ${ROOT_FOLDER} + git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" + if [ "$dirty" != "0" ]; then git stash pop; fi + exit 0 +} + +# Assert if properties have been properly passed +function assert_properties() { +echo "VERSION [${VERSION}], DESTINATION [${DESTINATION}], CLONE [${CLONE}]" +if [[ "${VERSION}" != "" && (-z "${DESTINATION}" && -z "${CLONE}") ]] ; then echo "Version was set but destination / clone was not!"; exit 1;fi +if [[ ("${DESTINATION}" != "" && "${CLONE}" != "") && -z "${VERSION}" ]] ; then echo "Destination / clone was set but version was not!"; exit 1;fi +if [[ "${DESTINATION}" != "" && "${CLONE}" == "yes" ]] ; then echo "Destination and clone was set. Pick one!"; exit 1;fi +} + +# Prints the usage +function print_usage() { +cat </` +- if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will + switch to gh-pages of that repo and copy the generated docs to `docs//` + +USAGE: + +You can use the following options: + +-v|--version - the script will apply the whole procedure for a particular library version +-d|--destination - the root of destination folder where the docs should be copied. You have to use the full path. + E.g. point to spring-cloud-static folder. Can't be used with (-c) +-b|--build - will run the standard build process after checking out the branch +-c|--clone - will automatically clone the spring-cloud-static repo instead of providing the destination. + Obviously can't be used with (-d) + +EOF +} + + +# ========================================== +# ____ ____ _____ _____ _____ _______ +# / ____|/ ____| __ \|_ _| __ \__ __| +# | (___ | | | |__) | | | | |__) | | | +# \___ \| | | _ / | | | ___/ | | +# ____) | |____| | \ \ _| |_| | | | +# |_____/ \_____|_| \_\_____|_| |_| +# +# ========================================== + +while [[ $# > 0 ]] +do +key="$1" +case ${key} in + -v|--version) + VERSION="$2" + shift # past argument + ;; + -d|--destination) + DESTINATION="$2" + shift # past argument + ;; + -b|--build) + BUILD="yes" + ;; + -c|--clone) + CLONE="yes" + ;; + -h|--help) + print_usage + exit 0 + ;; + *) + echo "Invalid option: [$1]" + print_usage + exit 1 + ;; +esac +shift # past argument or value +done + +assert_properties +set_default_props +check_if_anything_to_sync +if [[ -z "${VERSION}" ]] ; then + retrieve_current_branch +else + switch_to_tag +fi +build_docs_if_applicable +retrieve_doc_properties +stash_changes +add_docs_from_target +checkout_previous_branch \ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/.gitkeep b/spring-cloud-zookeeper/2.1.4.RELEASE/images/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/background.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/background.png new file mode 100644 index 00000000..15dca6fb Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/background.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/1.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/1.png new file mode 100644 index 00000000..7d473430 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/1.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/2.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/2.png new file mode 100644 index 00000000..5d09341b Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/2.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/3.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/3.png new file mode 100644 index 00000000..ef7b7004 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/callouts/3.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/caution.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/caution.png new file mode 100644 index 00000000..8a5e4fca Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/caution.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/important.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/important.png new file mode 100644 index 00000000..ec54df65 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/important.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/logo.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/logo.png new file mode 100644 index 00000000..ade2ce6e Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/logo.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/note.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/note.png new file mode 100644 index 00000000..88d997b1 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/note.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/tip.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/tip.png new file mode 100644 index 00000000..6530abb4 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/tip.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/images/warning.png b/spring-cloud-zookeeper/2.1.4.RELEASE/images/warning.png new file mode 100644 index 00000000..0d5b5244 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/images/warning.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/highlight.css b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/highlight.css new file mode 100644 index 00000000..3850f8b9 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/highlight.css @@ -0,0 +1,35 @@ +/* + code highlight CSS resemblign the Eclipse IDE default color schema + @author Costin Leau +*/ + +.hl-keyword { + color: #7F0055; + font-weight: bold; +} + +.hl-comment { + color: #3F5F5F; + font-style: italic; +} + +.hl-multiline-comment { + color: #3F5FBF; + font-style: italic; +} + +.hl-tag { + color: #3F7F7F; +} + +.hl-attribute { + color: #7F007F; +} + +.hl-value { + color: #2A00FF; +} + +.hl-string { + color: #2A00FF; +} \ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual-multipage.css b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual-multipage.css new file mode 100644 index 00000000..b790654b --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual-multipage.css @@ -0,0 +1,9 @@ +@IMPORT url("manual.css"); + +body.firstpage { + background: url("../images/background.png") no-repeat center top; +} + +div.part h1 { + border-top: none; +} diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual-singlepage.css b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual-singlepage.css new file mode 100644 index 00000000..303192a8 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual-singlepage.css @@ -0,0 +1,6 @@ +@IMPORT url("manual.css"); + +body { + background: url("../images/background.png") no-repeat center top; +} + diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual.css b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual.css new file mode 100644 index 00000000..20cf07da --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/css/manual.css @@ -0,0 +1,342 @@ +@IMPORT url("highlight.css"); + +html { + padding: 0pt; + margin: 0pt; +} + +body { + color: #333333; + margin: 15px 30px; + font-family: Helvetica, Arial, Freesans, Clean, Sans-serif; + line-height: 1.6; + -webkit-font-smoothing: antialiased; +} + +code { + font-size: 16px; + font-family: Consolas, "Liberation Mono", Courier, monospace; +} + +:not(a) > code { + color: #6D180B; +} + +:not(pre) > code { + background-color: #F2F2F2; + border: 1px solid #CCCCCC; + border-radius: 4px; + padding: 1px 3px 0; + text-shadow: none; + white-space: nowrap; +} + +body > *:first-child { + margin-top: 0 !important; +} + +div { + margin: 0pt; +} + +hr { + border: 1px solid #CCCCCC; + background: #CCCCCC; +} + +h1, h2, h3, h4, h5, h6 { + color: #000000; + cursor: text; + font-weight: bold; + margin: 30px 0 10px; + padding: 0; +} + +h1, h2, h3 { + margin: 40px 0 10px; +} + +h1 { + margin: 70px 0 30px; + padding-top: 20px; +} + +div.part h1 { + border-top: 1px dotted #CCCCCC; +} + +h1, h1 code { + font-size: 32px; +} + +h2, h2 code { + font-size: 24px; +} + +h3, h3 code { + font-size: 20px; +} + +h4, h1 code, h5, h5 code, h6, h6 code { + font-size: 18px; +} + +div.book, div.chapter, div.appendix, div.part, div.preface { + min-width: 300px; + max-width: 1200px; + margin: 0 auto; +} + +p.releaseinfo { + font-weight: bold; + margin-bottom: 40px; + margin-top: 40px; +} + +div.authorgroup { + line-height: 1; +} + +p.copyright { + line-height: 1; + margin-bottom: -5px; +} + +.legalnotice p { + font-style: italic; + font-size: 14px; + line-height: 1; +} + +div.titlepage + p, div.titlepage + p { + margin-top: 0; +} + +pre { + line-height: 1.0; + color: black; +} + +a { + color: #4183C4; + text-decoration: none; +} + +p { + margin: 15px 0; + text-align: left; +} + +ul, ol { + padding-left: 30px; +} + +li p { + margin: 0; +} + +div.table { + margin: 1em; + padding: 0.5em; + text-align: center; +} + +div.table table, div.informaltable table { + display: table; + width: 100%; +} + +div.table td { + padding-left: 7px; + padding-right: 7px; +} + +.sidebar { + line-height: 1.4; + padding: 0 20px; + background-color: #F8F8F8; + border: 1px solid #CCCCCC; + border-radius: 3px 3px 3px 3px; +} + +.sidebar p.title { + color: #6D180B; +} + +pre.programlisting, pre.screen { + font-size: 15px; + padding: 6px 10px; + background-color: #F8F8F8; + border: 1px solid #CCCCCC; + border-radius: 3px 3px 3px 3px; + clear: both; + overflow: auto; + line-height: 1.4; + font-family: Consolas, "Liberation Mono", Courier, monospace; +} + +table { + border-collapse: collapse; + border-spacing: 0; + border: 1px solid #DDDDDD !important; + border-radius: 4px !important; + border-collapse: separate !important; + line-height: 1.6; +} + +table thead { + background: #F5F5F5; +} + +table tr { + border: none; + border-bottom: none; +} + +table th { + font-weight: bold; +} + +table th, table td { + border: none !important; + padding: 6px 13px; +} + +table tr:nth-child(2n) { + background-color: #F8F8F8; +} + +td p { + margin: 0 0 15px 0; +} + +div.table-contents td p { + margin: 0; +} + +div.important *, div.note *, div.tip *, div.warning *, div.navheader *, div.navfooter *, div.calloutlist * { + border: none !important; + background: none !important; + margin: 0; +} + +div.important p, div.note p, div.tip p, div.warning p { + color: #6F6F6F; + line-height: 1.6; +} + +div.important code, div.note code, div.tip code, div.warning code { + background-color: #F2F2F2 !important; + border: 1px solid #CCCCCC !important; + border-radius: 4px !important; + padding: 1px 3px 0 !important; + text-shadow: none !important; + white-space: nowrap !important; +} + +.note th, .tip th, .warning th { + display: none; +} + +.note tr:first-child td, .tip tr:first-child td, .warning tr:first-child td { + border-right: 1px solid #CCCCCC !important; + padding-top: 10px; +} + +div.calloutlist p, div.calloutlist td { + padding: 0; + margin: 0; +} + +div.calloutlist > table > tbody > tr > td:first-child { + padding-left: 10px; + width: 30px !important; +} + +div.important, div.note, div.tip, div.warning { + margin-left: 0px !important; + margin-right: 20px !important; + margin-top: 20px; + margin-bottom: 20px; + padding-top: 10px; + padding-bottom: 10px; +} + +div.toc { + line-height: 1.2; +} + +dl, dt { + margin-top: 1px; + margin-bottom: 0; +} + +div.toc > dl > dt { + font-size: 32px; + font-weight: bold; + margin: 30px 0 10px 0; + display: block; +} + +div.toc > dl > dd > dl > dt { + font-size: 24px; + font-weight: bold; + margin: 20px 0 10px 0; + display: block; +} + +div.toc > dl > dd > dl > dd > dl > dt { + font-weight: bold; + font-size: 20px; + margin: 10px 0 0 0; +} + +tbody.footnotes * { + border: none !important; +} + +div.footnote p { + margin: 0; + line-height: 1; +} + +div.footnote p sup { + margin-right: 6px; + vertical-align: middle; +} + +div.navheader { + border-bottom: 1px solid #CCCCCC; +} + +div.navfooter { + border-top: 1px solid #CCCCCC; +} + +.title { + margin-left: -1em; + padding-left: 1em; +} + +.title > a { + position: absolute; + visibility: hidden; + display: block; + font-size: 0.85em; + margin-top: 0.05em; + margin-left: -1em; + vertical-align: text-top; + color: black; +} + +.title > a:before { + content: "\00A7"; +} + +.title:hover > a, .title > a:hover, .title:hover > a:hover { + visibility: visible; +} + +.title:focus > a, .title > a:focus, .title:focus > a:focus { + outline: 0; +} diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/background.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/background.png new file mode 100644 index 00000000..15dca6fb Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/background.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/1.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/1.png new file mode 100644 index 00000000..7d473430 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/1.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/2.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/2.png new file mode 100644 index 00000000..5d09341b Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/2.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/3.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/3.png new file mode 100644 index 00000000..ef7b7004 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/callouts/3.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/caution.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/caution.png new file mode 100644 index 00000000..8a5e4fca Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/caution.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/important.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/important.png new file mode 100644 index 00000000..ec54df65 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/important.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/logo.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/logo.png new file mode 100644 index 00000000..ade2ce6e Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/logo.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/note.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/note.png new file mode 100644 index 00000000..88d997b1 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/note.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/tip.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/tip.png new file mode 100644 index 00000000..6530abb4 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/tip.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/warning.png b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/warning.png new file mode 100644 index 00000000..0d5b5244 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/images/warning.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_pr01.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_pr01.html new file mode 100644 index 00000000..517e6de6 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_pr01.html @@ -0,0 +1,9 @@ + + +
Prev   Next

This project provides Zookeeper integrations for Spring Boot applications through +autoconfiguration and binding to the Spring Environment and other Spring programming model +idioms. With a few annotations, you can quickly enable and configure the common patterns +inside your application and build large distributed systems with Zookeeper based +components. The provided patterns include Service Discovery and Configuration. Integration +with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load Balancing +(Ribbon), and Circuit Breaker (Hystrix).

Prev   Next
Spring Cloud Zookeeper Home 1. Install Zookeeper
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-config.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-config.html new file mode 100644 index 00000000..5071719a --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-config.html @@ -0,0 +1,61 @@ + + + 7. Distributed Configuration with Zookeeper
7. Distributed Configuration with Zookeeper
Prev   

7. Distributed Configuration with Zookeeper

Zookeeper provides a +hierarchical namespace +that lets clients store arbitrary data, such as configuration data. Spring Cloud Zookeeper +Config is an alternative to the +Config Server and Client. +Configuration is loaded into the Spring Environment during the special “bootstrap” +phase. Configuration is stored in the /config namespace by default. Multiple +PropertySource instances are created, based on the application’s name and the active +profiles, to mimic the Spring Cloud Config order of resolving properties. For example, an +application with a name of testApp and with the dev profile has the following property +sources created for it:

  • config/testApp,dev
  • config/testApp
  • config/application,dev
  • config/application

The most specific property source is at the top, with the least specific at the bottom. +Properties in the config/application namespace apply to all applications that use +zookeeper for configuration. Properties in the config/testApp namespace are available +only to the instances of the service named testApp.

Configuration is currently read on startup of the application. Sending a HTTP POST +request to /refresh causes the configuration to be reloaded. Watching the configuration +namespace (which Zookeeper supports) is not currently implemented.

7.1 Activating

Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-config enables +autoconfiguration that sets up Spring Cloud Zookeeper Config.

[Caution]Caution

When working with version 3.4 of Zookeeper you need to change +the way you include the dependency as described here.

7.2 Customizing

Zookeeper Config may be customized by setting the following properties:

bootstrap.yml.  +

spring:
+  cloud:
+    zookeeper:
+      config:
+        enabled: true
+        root: configuration
+        defaultContext: apps
+        profileSeparator: '::'

+

  • enabled: Setting this value to false disables Zookeeper Config.
  • root: Sets the base namespace for configuration values.
  • defaultContext: Sets the name used by all applications.
  • profileSeparator: Sets the value of the separator used to separate the profile name in +property sources with profiles.

7.3 Access Control Lists (ACLs)

You can add authentication information for Zookeeper ACLs by calling the addAuthInfo +method of a CuratorFramework bean. One way to accomplish this is to provide your own +CuratorFramework bean, as shown in the following example:

@BoostrapConfiguration
+public class CustomCuratorFrameworkConfig {
+
+  @Bean
+  public CuratorFramework curatorFramework() {
+    CuratorFramework curator = new CuratorFramework();
+    curator.addAuthInfo("digest", "user:password".getBytes());
+    return curator;
+  }
+
+}

Consult +the ZookeeperAutoConfiguration class +to see how the CuratorFramework bean’s default configuration.

Alternatively, you can add your credentials from a class that depends on the existing +CuratorFramework bean, as shown in the following example:

@BoostrapConfiguration
+public class DefaultCuratorFrameworkConfig {
+
+  public ZookeeperConfig(CuratorFramework curator) {
+    curator.addAuthInfo("digest", "user:password".getBytes());
+  }
+
+}

The creation of this bean must occur during the boostrapping phase. You can register +configuration classes to run during this phase by annotating them with +@BootstrapConfiguration and including them in a comma-separated list that you set as the +value of the org.springframework.cloud.bootstrap.BootstrapConfiguration property in the +resources/META-INF/spring.factories file, as shown in the following example:

resources/META-INF/spring.factories.  +

org.springframework.cloud.bootstrap.BootstrapConfiguration=\
+my.project.CustomCuratorFrameworkConfig,\
+my.project.DefaultCuratorFrameworkConfig

+

Prev   
6. Spring Cloud Zookeeper Dependency Watcher Home 
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-dependencies.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-dependencies.html new file mode 100644 index 00000000..7f74a193 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-dependencies.html @@ -0,0 +1,86 @@ + + + 5. Zookeeper Dependencies
5. Zookeeper Dependencies
Prev   Next

5. Zookeeper Dependencies

The following topics cover how to work with Spring Cloud Zookeeper dependencies:

5.1 Using the Zookeeper Dependencies

Spring Cloud Zookeeper gives you a possibility to provide dependencies of your application +as properties. As dependencies, you can understand other applications that are registered +in Zookeeper and which you would like to call through +Feign +(a REST client builder) and Spring RestTemplate.

You can also use the Zookeeper Dependency Watchers functionality to control and monitor +the state of your dependencies.

5.2 Activating Zookeeper Dependencies

Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables +autoconfiguration that sets up Spring Cloud Zookeeper Dependencies. Even if you provide +the dependencies in your properties, you can turn off the dependencies. To do so, set the +spring.cloud.zookeeper.dependency.enabled property to false (it defaults to true).

5.3 Setting up Zookeeper Dependencies

Consider the following example of dependency representation:

application.yml.  +

spring.application.name: yourServiceName
+spring.cloud.zookeeper:
+  dependencies:
+    newsletter:
+      path: /path/where/newsletter/has/registered/in/zookeeper
+      loadBalancerType: ROUND_ROBIN
+      contentTypeTemplate: application/vnd.newsletter.$version+json
+      version: v1
+      headers:
+        header1:
+            - value1
+        header2:
+            - value2
+      required: false
+      stubs: org.springframework:foo:stubs
+    mailing:
+      path: /path/where/mailing/has/registered/in/zookeeper
+      loadBalancerType: ROUND_ROBIN
+      contentTypeTemplate: application/vnd.mailing.$version+json
+      version: v1
+      required: true

+

The next few sections go through each part of the dependency one by one. The root property +name is spring.cloud.zookeeper.dependencies.

5.3.1 Aliases

Below the root property you have to represent each dependency as an alias. This is due to +the constraints of Ribbon, which requires that the application ID be placed in the URL. +Consequently, you cannot pass any complex path, suchas /myApp/myRoute/name). The alias +is the name you use instead of the serviceId for DiscoveryClient, Feign, or +RestTemplate.

In the previous examples, the aliases are newsletter and mailing. The following +example shows Feign usage with a newsletter alias:

@FeignClient("newsletter")
+public interface NewsletterService {
+        @RequestMapping(method = RequestMethod.GET, value = "/newsletter")
+        String getNewsletters();
+}

5.3.2 Path

The path is represented by the path YAML property and is the path under which the +dependency is registered under Zookeeper. As described in the +previous section, Ribbon +operates on URLs. As a result, this path is not compliant with its requirement. +That is why Spring Cloud Zookeeper maps the alias to the proper path.

5.3.3 Load Balancer Type

The load balancer type is represented by loadBalancerType YAML property.

If you know what kind of load-balancing strategy has to be applied when calling this +particular dependency, you can provide it in the YAML file, and it is automatically +applied. You can choose one of the following load balancing strategies:

  • STICKY: Once chosen, the instance is always called.
  • RANDOM: Picks an instance randomly.
  • ROUND_ROBIN: Iterates over instances over and over again.

5.3.4 Content-Type Template and Version

The Content-Type template and version are represented by the contentTypeTemplate and +version YAML properties.

If you version your API in the Content-Type header, you do not want to add this header +to each of your requests. Also, if you want to call a new version of the API, you do not +want to roam around your code to bump up the API version. That is why you can provide a +contentTypeTemplate with a special $version placeholder. That placeholder will be filled by the value of the +version YAML property. Consider the following example of a contentTypeTemplate:

application/vnd.newsletter.$version+json

Further consider the following version:

v1

The combination of contentTypeTemplate and version results in the creation of a +Content-Type header for each request, as follows:

application/vnd.newsletter.v1+json

5.3.5 Default Headers

Default headers are represented by the headers map in YAML.

Sometimes, each call to a dependency requires setting up of some default headers. To not +do that in code, you can set them up in the YAML file, as shown in the following example +headers section:

headers:
+    Accept:
+        - text/html
+        - application/xhtml+xml
+    Cache-Control:
+        - no-cache

That headers section results in adding the Accept and Cache-Control headers with +appropriate list of values in your HTTP request.

5.3.6 Required Dependencies

Required dependencies are represented by required property in YAML.

If one of your dependencies is required to be up when your application boots, you can set +the required: true property in the YAML file.

If your application cannot localize the required dependency during boot time, it throws an +exception, and the Spring Context fails to set up. In other words, your application cannot +start if the required dependency is not registered in Zookeeper.

You can read more about Spring Cloud Zookeeper Presence Checker +later in this document.

5.3.7 Stubs

You can provide a colon-separated path to the JAR containing stubs of the dependency, as +shown in the following example:

stubs: org.springframework:myApp:stubs

where:

  • org.springframework is the groupId.
  • myApp is the artifactId.
  • stubs is the classifier. (Note that stubs is the default value.)

Because stubs is the default classifier, the preceding example is equal to the following +example:

stubs: org.springframework:myApp

5.4 Configuring Spring Cloud Zookeeper Dependencies

You can set the following properties to enable or disable parts of Zookeeper Dependencies +functionalities:

  • spring.cloud.zookeeper.dependencies: If you do not set this property, you cannot use +Zookeeper Dependencies.
  • spring.cloud.zookeeper.dependency.ribbon.enabled (enabled by default): Ribbon requires +either explicit global configuration or a particular one for a dependency. By turning on +this property, runtime load balancing strategy resolution is possible, and you can use the +loadBalancerType section of the Zookeeper Dependencies. The configuration that needs +this property has an implementation of LoadBalancerClient that delegates to the +ILoadBalancer presented in the next bullet.
  • spring.cloud.zookeeper.dependency.ribbon.loadbalancer (enabled by default): Thanks to +this property, the custom ILoadBalancer knows that the part of the URI passed to Ribbon +might actually be the alias that has to be resolved to a proper path in Zookeeper. Without +this property, you cannot register applications under nested paths.
  • spring.cloud.zookeeper.dependency.headers.enabled (enabled by default): This property +registers a RibbonClient that automatically appends appropriate headers and content +types with their versions, as presented in the Dependency configuration. Without this +setting, those two parameters do not work.
  • spring.cloud.zookeeper.dependency.resttemplate.enabled (enabled by default): When +enabled, this property modifies the request headers of a @LoadBalanced-annotated +RestTemplate such that it passes headers and content type with the version set in +dependency configuration. Without this setting, those two parameters do not work.
Prev   Next
4. Spring Cloud Zookeeper and Service Registry Home 6. Spring Cloud Zookeeper Dependency Watcher
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-dependency-watcher.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-dependency-watcher.html new file mode 100644 index 00000000..baeb7889 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-dependency-watcher.html @@ -0,0 +1,21 @@ + + + 6. Spring Cloud Zookeeper Dependency Watcher
6. Spring Cloud Zookeeper Dependency Watcher
Prev   Next

6. Spring Cloud Zookeeper Dependency Watcher

The Dependency Watcher mechanism lets you register listeners to your dependencies. The +functionality is, in fact, an implementation of the Observator pattern. When a +dependency changes, its state (to either UP or DOWN), some custom logic can be applied.

6.1 Activating

Spring Cloud Zookeeper Dependencies functionality needs to be enabled for you to use the +Dependency Watcher mechanism.

6.2 Registering a Listener

To register a listener, you must implement an interface called +org.springframework.cloud.zookeeper.discovery.watcher.DependencyWatcherListener and +register it as a bean. The interface gives you one method:

void stateChanged(String dependencyName, DependencyState newState);

If you want to register a listener for a particular dependency, the dependencyName would +be the discriminator for your concrete implementation. newState provides you with +information about whether your dependency has changed to CONNECTED or DISCONNECTED.

6.3 Using the Presence Checker

Bound with the Dependency Watcher is the functionality called Presence Checker. It lets +you provide custom behavior when your application boots, to react according to the state +of your dependencies.

The default implementation of the abstract +org.springframework.cloud.zookeeper.discovery.watcher.presence.DependencyPresenceOnStartupVerifier +class is the +org.springframework.cloud.zookeeper.discovery.watcher.presence.DefaultDependencyPresenceOnStartupVerifier, +which works in the following way.

  1. If the dependency is marked us required and is not in Zookeeper, when your application +boots, it throws an exception and shuts down.
  2. If the dependency is not required, the +org.springframework.cloud.zookeeper.discovery.watcher.presence.LogMissingDependencyChecker +logs that the dependency is missing at the WARN level.

Because the DefaultDependencyPresenceOnStartupVerifier is registered only when there is +no bean of type DependencyPresenceOnStartupVerifier, this functionality can be +overridden.

Prev   Next
5. Zookeeper Dependencies Home 7. Distributed Configuration with Zookeeper
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-discovery.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-discovery.html new file mode 100644 index 00000000..f2d19fdb --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-discovery.html @@ -0,0 +1,53 @@ + + + 2. Service Discovery with Zookeeper
2. Service Discovery with Zookeeper
Prev   Next

2. Service Discovery with Zookeeper

Service Discovery is one of the key tenets of a microservice based architecture. Trying to +hand-configure each client or some form of convention can be difficult to do and can be +brittle. Curator(A Java library for Zookeeper) provides Service +Discovery through a Service Discovery +Extension. Spring Cloud Zookeeper uses this extension for service registration and +discovery.

2.1 Activating

Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables +autoconfiguration that sets up Spring Cloud Zookeeper Discovery.

[Note]Note

For web functionality, you still need to include +org.springframework.boot:spring-boot-starter-web.

[Caution]Caution

When working with version 3.4 of Zookeeper you need to change +the way you include the dependency as described here.

2.2 Registering with Zookeeper

When a client registers with Zookeeper, it provides metadata (such as host and port, ID, +and name) about itself.

The following example shows a Zookeeper client:

@SpringBootApplication
+@RestController
+public class Application {
+
+    @RequestMapping("/")
+    public String home() {
+        return "Hello world";
+    }
+
+    public static void main(String[] args) {
+        new SpringApplicationBuilder(Application.class).web(true).run(args);
+    }
+
+}
[Note]Note

The preceding example is a normal Spring Boot application.

If Zookeeper is located somewhere other than localhost:2181, the configuration must +provide the location of the server, as shown in the following example:

application.yml.  +

spring:
+  cloud:
+    zookeeper:
+      connect-string: localhost:2181

+

[Caution]Caution

If you use Spring Cloud Zookeeper Config, the +values shown in the preceding example need to be in bootstrap.yml instead of +application.yml.

The default service name, instance ID, and port (taken from the Environment) are +${spring.application.name}, the Spring Context ID, and ${server.port}, respectively.

Having spring-cloud-starter-zookeeper-discovery on the classpath makes the app into both +a Zookeeper “service” (that is, it registers itself) and a “client” (that is, it can +query Zookeeper to locate other services).

If you would like to disable the Zookeeper Discovery Client, you can set +spring.cloud.zookeeper.discovery.enabled to false.

2.3 Using the DiscoveryClient

Spring Cloud has support for +Feign +(a REST client builder) and +Spring +RestTemplate, using logical service names instead of physical URLs.

You can also use the org.springframework.cloud.client.discovery.DiscoveryClient, which +provides a simple API for discovery clients that is not specific to Netflix, as shown in +the following example:

@Autowired
+private DiscoveryClient discoveryClient;
+
+public String serviceUrl() {
+    List<ServiceInstance> list = discoveryClient.getInstances("STORES");
+    if (list != null && list.size() > 0 ) {
+        return list.get(0).getUri().toString();
+    }
+    return null;
+}
Prev   Next
1. Install Zookeeper Home 3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-install.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-install.html new file mode 100644 index 00000000..50b542ea --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-install.html @@ -0,0 +1,40 @@ + + + 1. Install Zookeeper
1. Install Zookeeper
Prev   Next

1. Install Zookeeper

See the installation +documentation for instructions on how to install Zookeeper.

Spring Cloud Zookeeper uses Apache Curator behind the scenes. +While Zookeeper 3.5.x is still considered "beta" by the Zookeeper development team, +the reality is that it is used in production by many users. +However, Zookeeper 3.4.x is also used in production. +Prior to Apache Curator 4.0, both versions of Zookeeper were supported via two versions of Apache Curator. +Starting with Curator 4.0 both versions of Zookeeper are supported via the same Curator libraries.

In case you are integrating with version 3.4 you need to change the Zookeeper dependency +that comes shipped with curator, and thus spring-cloud-zookeeper. +To do so simply exclude that dependency and add the 3.4.x version like shown below.

maven.  +

<dependency>
+    <groupId>org.springframework.cloud</groupId>
+    <artifactId>spring-cloud-starter-zookeeper-all</artifactId>
+    <exclusions>
+        <exclusion>
+            <groupId>org.apache.zookeeper</groupId>
+            <artifactId>zookeeper</artifactId>
+        </exclusion>
+    </exclusions>
+</dependency>
+<dependency>
+    <groupId>org.apache.zookeeper</groupId>
+    <artifactId>zookeeper</artifactId>
+    <version>3.4.12</version>
+    <exclusions>
+        <exclusion>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+        </exclusion>
+    </exclusions>
+</dependency>

+

gradle.  +

compile('org.springframework.cloud:spring-cloud-starter-zookeeper-all') {
+  exclude group: 'org.apache.zookeeper', module: 'zookeeper'
+}
+compile('org.apache.zookeeper:zookeeper:3.4.12') {
+  exclude group: 'org.slf4j', module: 'slf4j-log4j12'
+}

+

Prev   Next
 Home 2. Service Discovery with Zookeeper
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-netflix.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-netflix.html new file mode 100644 index 00000000..bc1ab5e4 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-netflix.html @@ -0,0 +1,7 @@ + + + 3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components
3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components
Prev   Next

3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components

Spring Cloud Netflix supplies useful tools that work regardless of which DiscoveryClient +implementation you use. Feign, Turbine, Ribbon, and Zuul all work with Spring Cloud +Zookeeper.

3.1 Ribbon with Zookeeper

Spring Cloud Zookeeper provides an implementation of Ribbon’s ServerList. When you use +the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfigured to use the +ZookeeperServerList by default.

Prev   Next
2. Service Discovery with Zookeeper Home 4. Spring Cloud Zookeeper and Service Registry
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-service-registry.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-service-registry.html new file mode 100644 index 00000000..450975a1 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper-service-registry.html @@ -0,0 +1,26 @@ + + + 4. Spring Cloud Zookeeper and Service Registry
4. Spring Cloud Zookeeper and Service Registry
Prev   Next

4. Spring Cloud Zookeeper and Service Registry

Spring Cloud Zookeeper implements the ServiceRegistry interface, letting developers +register arbitrary services in a programmatic way.

The ServiceInstanceRegistration class offers a builder() method to create a +Registration object that can be used by the ServiceRegistry, as shown in the following +example:

@Autowired
+private ZookeeperServiceRegistry serviceRegistry;
+
+public void registerThings() {
+    ZookeeperRegistration registration = ServiceInstanceRegistration.builder()
+            .defaultUriSpec()
+            .address("anyUrl")
+            .port(10)
+            .name("/a/b/c/d/anotherservice")
+            .build();
+    this.serviceRegistry.register(registration);
+}

4.1 Instance Status

Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the +server. These instances are not returned as active service instances. This is useful for +behaviors such as blue/green deployments. (Note that the Curator Service Discovery recipe +does not support this behavior.) Taking advantage of the flexible payload has let Spring +Cloud Zookeeper implement OUT_OF_SERVICE by updating some specific metadata and then +filtering on that metadata in the Ribbon ZookeeperServerList. The ZookeeperServerList +filters out all non-null instance statuses that do not equal UP. If the instance status +field is empty, it is considered to be UP for backwards compatibility. To change the +status of an instance, make a POST with OUT_OF_SERVICE to the ServiceRegistry +instance status actuator endpoint, as shown in the following example:

$ http POST http://localhost:8081/service-registry status=OUT_OF_SERVICE
[Note]Note

The preceding example uses the http command from https://httpie.org.

Prev   Next
3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components Home 5. Zookeeper Dependencies
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper.html b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper.html new file mode 100644 index 00000000..2e0a72f3 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/multi/multi_spring-cloud-zookeeper.html @@ -0,0 +1,3 @@ + + + Spring Cloud Zookeeper
Spring Cloud Zookeeper
   Next

Spring Cloud Zookeeper

Table of Contents

1. Install Zookeeper
2. Service Discovery with Zookeeper
2.1. Activating
2.2. Registering with Zookeeper
2.3. Using the DiscoveryClient
3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components
3.1. Ribbon with Zookeeper
4. Spring Cloud Zookeeper and Service Registry
4.1. Instance Status
5. Zookeeper Dependencies
5.1. Using the Zookeeper Dependencies
5.2. Activating Zookeeper Dependencies
5.3. Setting up Zookeeper Dependencies
5.3.1. Aliases
5.3.2. Path
5.3.3. Load Balancer Type
5.3.4. Content-Type Template and Version
5.3.5. Default Headers
5.3.6. Required Dependencies
5.3.7. Stubs
5.4. Configuring Spring Cloud Zookeeper Dependencies
6. Spring Cloud Zookeeper Dependency Watcher
6.1. Activating
6.2. Registering a Listener
6.3. Using the Presence Checker
7. Distributed Configuration with Zookeeper
7.1. Activating
7.2. Customizing
7.3. Access Control Lists (ACLs)
   Next
   
\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/highlight.css b/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/highlight.css new file mode 100644 index 00000000..3850f8b9 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/highlight.css @@ -0,0 +1,35 @@ +/* + code highlight CSS resemblign the Eclipse IDE default color schema + @author Costin Leau +*/ + +.hl-keyword { + color: #7F0055; + font-weight: bold; +} + +.hl-comment { + color: #3F5F5F; + font-style: italic; +} + +.hl-multiline-comment { + color: #3F5FBF; + font-style: italic; +} + +.hl-tag { + color: #3F7F7F; +} + +.hl-attribute { + color: #7F007F; +} + +.hl-value { + color: #2A00FF; +} + +.hl-string { + color: #2A00FF; +} \ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual-multipage.css b/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual-multipage.css new file mode 100644 index 00000000..b790654b --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual-multipage.css @@ -0,0 +1,9 @@ +@IMPORT url("manual.css"); + +body.firstpage { + background: url("../images/background.png") no-repeat center top; +} + +div.part h1 { + border-top: none; +} diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual-singlepage.css b/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual-singlepage.css new file mode 100644 index 00000000..303192a8 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual-singlepage.css @@ -0,0 +1,6 @@ +@IMPORT url("manual.css"); + +body { + background: url("../images/background.png") no-repeat center top; +} + diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual.css b/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual.css new file mode 100644 index 00000000..20cf07da --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/single/css/manual.css @@ -0,0 +1,342 @@ +@IMPORT url("highlight.css"); + +html { + padding: 0pt; + margin: 0pt; +} + +body { + color: #333333; + margin: 15px 30px; + font-family: Helvetica, Arial, Freesans, Clean, Sans-serif; + line-height: 1.6; + -webkit-font-smoothing: antialiased; +} + +code { + font-size: 16px; + font-family: Consolas, "Liberation Mono", Courier, monospace; +} + +:not(a) > code { + color: #6D180B; +} + +:not(pre) > code { + background-color: #F2F2F2; + border: 1px solid #CCCCCC; + border-radius: 4px; + padding: 1px 3px 0; + text-shadow: none; + white-space: nowrap; +} + +body > *:first-child { + margin-top: 0 !important; +} + +div { + margin: 0pt; +} + +hr { + border: 1px solid #CCCCCC; + background: #CCCCCC; +} + +h1, h2, h3, h4, h5, h6 { + color: #000000; + cursor: text; + font-weight: bold; + margin: 30px 0 10px; + padding: 0; +} + +h1, h2, h3 { + margin: 40px 0 10px; +} + +h1 { + margin: 70px 0 30px; + padding-top: 20px; +} + +div.part h1 { + border-top: 1px dotted #CCCCCC; +} + +h1, h1 code { + font-size: 32px; +} + +h2, h2 code { + font-size: 24px; +} + +h3, h3 code { + font-size: 20px; +} + +h4, h1 code, h5, h5 code, h6, h6 code { + font-size: 18px; +} + +div.book, div.chapter, div.appendix, div.part, div.preface { + min-width: 300px; + max-width: 1200px; + margin: 0 auto; +} + +p.releaseinfo { + font-weight: bold; + margin-bottom: 40px; + margin-top: 40px; +} + +div.authorgroup { + line-height: 1; +} + +p.copyright { + line-height: 1; + margin-bottom: -5px; +} + +.legalnotice p { + font-style: italic; + font-size: 14px; + line-height: 1; +} + +div.titlepage + p, div.titlepage + p { + margin-top: 0; +} + +pre { + line-height: 1.0; + color: black; +} + +a { + color: #4183C4; + text-decoration: none; +} + +p { + margin: 15px 0; + text-align: left; +} + +ul, ol { + padding-left: 30px; +} + +li p { + margin: 0; +} + +div.table { + margin: 1em; + padding: 0.5em; + text-align: center; +} + +div.table table, div.informaltable table { + display: table; + width: 100%; +} + +div.table td { + padding-left: 7px; + padding-right: 7px; +} + +.sidebar { + line-height: 1.4; + padding: 0 20px; + background-color: #F8F8F8; + border: 1px solid #CCCCCC; + border-radius: 3px 3px 3px 3px; +} + +.sidebar p.title { + color: #6D180B; +} + +pre.programlisting, pre.screen { + font-size: 15px; + padding: 6px 10px; + background-color: #F8F8F8; + border: 1px solid #CCCCCC; + border-radius: 3px 3px 3px 3px; + clear: both; + overflow: auto; + line-height: 1.4; + font-family: Consolas, "Liberation Mono", Courier, monospace; +} + +table { + border-collapse: collapse; + border-spacing: 0; + border: 1px solid #DDDDDD !important; + border-radius: 4px !important; + border-collapse: separate !important; + line-height: 1.6; +} + +table thead { + background: #F5F5F5; +} + +table tr { + border: none; + border-bottom: none; +} + +table th { + font-weight: bold; +} + +table th, table td { + border: none !important; + padding: 6px 13px; +} + +table tr:nth-child(2n) { + background-color: #F8F8F8; +} + +td p { + margin: 0 0 15px 0; +} + +div.table-contents td p { + margin: 0; +} + +div.important *, div.note *, div.tip *, div.warning *, div.navheader *, div.navfooter *, div.calloutlist * { + border: none !important; + background: none !important; + margin: 0; +} + +div.important p, div.note p, div.tip p, div.warning p { + color: #6F6F6F; + line-height: 1.6; +} + +div.important code, div.note code, div.tip code, div.warning code { + background-color: #F2F2F2 !important; + border: 1px solid #CCCCCC !important; + border-radius: 4px !important; + padding: 1px 3px 0 !important; + text-shadow: none !important; + white-space: nowrap !important; +} + +.note th, .tip th, .warning th { + display: none; +} + +.note tr:first-child td, .tip tr:first-child td, .warning tr:first-child td { + border-right: 1px solid #CCCCCC !important; + padding-top: 10px; +} + +div.calloutlist p, div.calloutlist td { + padding: 0; + margin: 0; +} + +div.calloutlist > table > tbody > tr > td:first-child { + padding-left: 10px; + width: 30px !important; +} + +div.important, div.note, div.tip, div.warning { + margin-left: 0px !important; + margin-right: 20px !important; + margin-top: 20px; + margin-bottom: 20px; + padding-top: 10px; + padding-bottom: 10px; +} + +div.toc { + line-height: 1.2; +} + +dl, dt { + margin-top: 1px; + margin-bottom: 0; +} + +div.toc > dl > dt { + font-size: 32px; + font-weight: bold; + margin: 30px 0 10px 0; + display: block; +} + +div.toc > dl > dd > dl > dt { + font-size: 24px; + font-weight: bold; + margin: 20px 0 10px 0; + display: block; +} + +div.toc > dl > dd > dl > dd > dl > dt { + font-weight: bold; + font-size: 20px; + margin: 10px 0 0 0; +} + +tbody.footnotes * { + border: none !important; +} + +div.footnote p { + margin: 0; + line-height: 1; +} + +div.footnote p sup { + margin-right: 6px; + vertical-align: middle; +} + +div.navheader { + border-bottom: 1px solid #CCCCCC; +} + +div.navfooter { + border-top: 1px solid #CCCCCC; +} + +.title { + margin-left: -1em; + padding-left: 1em; +} + +.title > a { + position: absolute; + visibility: hidden; + display: block; + font-size: 0.85em; + margin-top: 0.05em; + margin-left: -1em; + vertical-align: text-top; + color: black; +} + +.title > a:before { + content: "\00A7"; +} + +.title:hover > a, .title > a:hover, .title:hover > a:hover { + visibility: visible; +} + +.title:focus > a, .title > a:focus, .title:focus > a:focus { + outline: 0; +} diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/background.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/background.png new file mode 100644 index 00000000..15dca6fb Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/background.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/1.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/1.png new file mode 100644 index 00000000..7d473430 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/1.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/2.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/2.png new file mode 100644 index 00000000..5d09341b Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/2.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/3.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/3.png new file mode 100644 index 00000000..ef7b7004 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/callouts/3.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/caution.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/caution.png new file mode 100644 index 00000000..8a5e4fca Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/caution.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/important.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/important.png new file mode 100644 index 00000000..ec54df65 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/important.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/logo.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/logo.png new file mode 100644 index 00000000..ade2ce6e Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/logo.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/note.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/note.png new file mode 100644 index 00000000..88d997b1 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/note.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/tip.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/tip.png new file mode 100644 index 00000000..6530abb4 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/tip.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/warning.png b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/warning.png new file mode 100644 index 00000000..0d5b5244 Binary files /dev/null and b/spring-cloud-zookeeper/2.1.4.RELEASE/single/images/warning.png differ diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/single/spring-cloud-zookeeper.html b/spring-cloud-zookeeper/2.1.4.RELEASE/single/spring-cloud-zookeeper.html new file mode 100644 index 00000000..dbe1884d --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/single/spring-cloud-zookeeper.html @@ -0,0 +1,282 @@ + + + Spring Cloud Zookeeper

Spring Cloud Zookeeper

Table of Contents

1. Install Zookeeper
2. Service Discovery with Zookeeper
2.1. Activating
2.2. Registering with Zookeeper
2.3. Using the DiscoveryClient
3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components
3.1. Ribbon with Zookeeper
4. Spring Cloud Zookeeper and Service Registry
4.1. Instance Status
5. Zookeeper Dependencies
5.1. Using the Zookeeper Dependencies
5.2. Activating Zookeeper Dependencies
5.3. Setting up Zookeeper Dependencies
5.3.1. Aliases
5.3.2. Path
5.3.3. Load Balancer Type
5.3.4. Content-Type Template and Version
5.3.5. Default Headers
5.3.6. Required Dependencies
5.3.7. Stubs
5.4. Configuring Spring Cloud Zookeeper Dependencies
6. Spring Cloud Zookeeper Dependency Watcher
6.1. Activating
6.2. Registering a Listener
6.3. Using the Presence Checker
7. Distributed Configuration with Zookeeper
7.1. Activating
7.2. Customizing
7.3. Access Control Lists (ACLs)

This project provides Zookeeper integrations for Spring Boot applications through +autoconfiguration and binding to the Spring Environment and other Spring programming model +idioms. With a few annotations, you can quickly enable and configure the common patterns +inside your application and build large distributed systems with Zookeeper based +components. The provided patterns include Service Discovery and Configuration. Integration +with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load Balancing +(Ribbon), and Circuit Breaker (Hystrix).

1. Install Zookeeper

See the installation +documentation for instructions on how to install Zookeeper.

Spring Cloud Zookeeper uses Apache Curator behind the scenes. +While Zookeeper 3.5.x is still considered "beta" by the Zookeeper development team, +the reality is that it is used in production by many users. +However, Zookeeper 3.4.x is also used in production. +Prior to Apache Curator 4.0, both versions of Zookeeper were supported via two versions of Apache Curator. +Starting with Curator 4.0 both versions of Zookeeper are supported via the same Curator libraries.

In case you are integrating with version 3.4 you need to change the Zookeeper dependency +that comes shipped with curator, and thus spring-cloud-zookeeper. +To do so simply exclude that dependency and add the 3.4.x version like shown below.

maven.  +

<dependency>
+    <groupId>org.springframework.cloud</groupId>
+    <artifactId>spring-cloud-starter-zookeeper-all</artifactId>
+    <exclusions>
+        <exclusion>
+            <groupId>org.apache.zookeeper</groupId>
+            <artifactId>zookeeper</artifactId>
+        </exclusion>
+    </exclusions>
+</dependency>
+<dependency>
+    <groupId>org.apache.zookeeper</groupId>
+    <artifactId>zookeeper</artifactId>
+    <version>3.4.12</version>
+    <exclusions>
+        <exclusion>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+        </exclusion>
+    </exclusions>
+</dependency>

+

gradle.  +

compile('org.springframework.cloud:spring-cloud-starter-zookeeper-all') {
+  exclude group: 'org.apache.zookeeper', module: 'zookeeper'
+}
+compile('org.apache.zookeeper:zookeeper:3.4.12') {
+  exclude group: 'org.slf4j', module: 'slf4j-log4j12'
+}

+

2. Service Discovery with Zookeeper

Service Discovery is one of the key tenets of a microservice based architecture. Trying to +hand-configure each client or some form of convention can be difficult to do and can be +brittle. Curator(A Java library for Zookeeper) provides Service +Discovery through a Service Discovery +Extension. Spring Cloud Zookeeper uses this extension for service registration and +discovery.

2.1 Activating

Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables +autoconfiguration that sets up Spring Cloud Zookeeper Discovery.

[Note]Note

For web functionality, you still need to include +org.springframework.boot:spring-boot-starter-web.

[Caution]Caution

When working with version 3.4 of Zookeeper you need to change +the way you include the dependency as described here.

2.2 Registering with Zookeeper

When a client registers with Zookeeper, it provides metadata (such as host and port, ID, +and name) about itself.

The following example shows a Zookeeper client:

@SpringBootApplication
+@RestController
+public class Application {
+
+    @RequestMapping("/")
+    public String home() {
+        return "Hello world";
+    }
+
+    public static void main(String[] args) {
+        new SpringApplicationBuilder(Application.class).web(true).run(args);
+    }
+
+}
[Note]Note

The preceding example is a normal Spring Boot application.

If Zookeeper is located somewhere other than localhost:2181, the configuration must +provide the location of the server, as shown in the following example:

application.yml.  +

spring:
+  cloud:
+    zookeeper:
+      connect-string: localhost:2181

+

[Caution]Caution

If you use Spring Cloud Zookeeper Config, the +values shown in the preceding example need to be in bootstrap.yml instead of +application.yml.

The default service name, instance ID, and port (taken from the Environment) are +${spring.application.name}, the Spring Context ID, and ${server.port}, respectively.

Having spring-cloud-starter-zookeeper-discovery on the classpath makes the app into both +a Zookeeper “service” (that is, it registers itself) and a “client” (that is, it can +query Zookeeper to locate other services).

If you would like to disable the Zookeeper Discovery Client, you can set +spring.cloud.zookeeper.discovery.enabled to false.

2.3 Using the DiscoveryClient

Spring Cloud has support for +Feign +(a REST client builder) and +Spring +RestTemplate, using logical service names instead of physical URLs.

You can also use the org.springframework.cloud.client.discovery.DiscoveryClient, which +provides a simple API for discovery clients that is not specific to Netflix, as shown in +the following example:

@Autowired
+private DiscoveryClient discoveryClient;
+
+public String serviceUrl() {
+    List<ServiceInstance> list = discoveryClient.getInstances("STORES");
+    if (list != null && list.size() > 0 ) {
+        return list.get(0).getUri().toString();
+    }
+    return null;
+}

3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components

Spring Cloud Netflix supplies useful tools that work regardless of which DiscoveryClient +implementation you use. Feign, Turbine, Ribbon, and Zuul all work with Spring Cloud +Zookeeper.

3.1 Ribbon with Zookeeper

Spring Cloud Zookeeper provides an implementation of Ribbon’s ServerList. When you use +the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfigured to use the +ZookeeperServerList by default.

4. Spring Cloud Zookeeper and Service Registry

Spring Cloud Zookeeper implements the ServiceRegistry interface, letting developers +register arbitrary services in a programmatic way.

The ServiceInstanceRegistration class offers a builder() method to create a +Registration object that can be used by the ServiceRegistry, as shown in the following +example:

@Autowired
+private ZookeeperServiceRegistry serviceRegistry;
+
+public void registerThings() {
+    ZookeeperRegistration registration = ServiceInstanceRegistration.builder()
+            .defaultUriSpec()
+            .address("anyUrl")
+            .port(10)
+            .name("/a/b/c/d/anotherservice")
+            .build();
+    this.serviceRegistry.register(registration);
+}

4.1 Instance Status

Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the +server. These instances are not returned as active service instances. This is useful for +behaviors such as blue/green deployments. (Note that the Curator Service Discovery recipe +does not support this behavior.) Taking advantage of the flexible payload has let Spring +Cloud Zookeeper implement OUT_OF_SERVICE by updating some specific metadata and then +filtering on that metadata in the Ribbon ZookeeperServerList. The ZookeeperServerList +filters out all non-null instance statuses that do not equal UP. If the instance status +field is empty, it is considered to be UP for backwards compatibility. To change the +status of an instance, make a POST with OUT_OF_SERVICE to the ServiceRegistry +instance status actuator endpoint, as shown in the following example:

$ http POST http://localhost:8081/service-registry status=OUT_OF_SERVICE
[Note]Note

The preceding example uses the http command from https://httpie.org.

5. Zookeeper Dependencies

The following topics cover how to work with Spring Cloud Zookeeper dependencies:

5.1 Using the Zookeeper Dependencies

Spring Cloud Zookeeper gives you a possibility to provide dependencies of your application +as properties. As dependencies, you can understand other applications that are registered +in Zookeeper and which you would like to call through +Feign +(a REST client builder) and Spring RestTemplate.

You can also use the Zookeeper Dependency Watchers functionality to control and monitor +the state of your dependencies.

5.2 Activating Zookeeper Dependencies

Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables +autoconfiguration that sets up Spring Cloud Zookeeper Dependencies. Even if you provide +the dependencies in your properties, you can turn off the dependencies. To do so, set the +spring.cloud.zookeeper.dependency.enabled property to false (it defaults to true).

5.3 Setting up Zookeeper Dependencies

Consider the following example of dependency representation:

application.yml.  +

spring.application.name: yourServiceName
+spring.cloud.zookeeper:
+  dependencies:
+    newsletter:
+      path: /path/where/newsletter/has/registered/in/zookeeper
+      loadBalancerType: ROUND_ROBIN
+      contentTypeTemplate: application/vnd.newsletter.$version+json
+      version: v1
+      headers:
+        header1:
+            - value1
+        header2:
+            - value2
+      required: false
+      stubs: org.springframework:foo:stubs
+    mailing:
+      path: /path/where/mailing/has/registered/in/zookeeper
+      loadBalancerType: ROUND_ROBIN
+      contentTypeTemplate: application/vnd.mailing.$version+json
+      version: v1
+      required: true

+

The next few sections go through each part of the dependency one by one. The root property +name is spring.cloud.zookeeper.dependencies.

5.3.1 Aliases

Below the root property you have to represent each dependency as an alias. This is due to +the constraints of Ribbon, which requires that the application ID be placed in the URL. +Consequently, you cannot pass any complex path, suchas /myApp/myRoute/name). The alias +is the name you use instead of the serviceId for DiscoveryClient, Feign, or +RestTemplate.

In the previous examples, the aliases are newsletter and mailing. The following +example shows Feign usage with a newsletter alias:

@FeignClient("newsletter")
+public interface NewsletterService {
+        @RequestMapping(method = RequestMethod.GET, value = "/newsletter")
+        String getNewsletters();
+}

5.3.2 Path

The path is represented by the path YAML property and is the path under which the +dependency is registered under Zookeeper. As described in the +previous section, Ribbon +operates on URLs. As a result, this path is not compliant with its requirement. +That is why Spring Cloud Zookeeper maps the alias to the proper path.

5.3.3 Load Balancer Type

The load balancer type is represented by loadBalancerType YAML property.

If you know what kind of load-balancing strategy has to be applied when calling this +particular dependency, you can provide it in the YAML file, and it is automatically +applied. You can choose one of the following load balancing strategies:

  • STICKY: Once chosen, the instance is always called.
  • RANDOM: Picks an instance randomly.
  • ROUND_ROBIN: Iterates over instances over and over again.

5.3.4 Content-Type Template and Version

The Content-Type template and version are represented by the contentTypeTemplate and +version YAML properties.

If you version your API in the Content-Type header, you do not want to add this header +to each of your requests. Also, if you want to call a new version of the API, you do not +want to roam around your code to bump up the API version. That is why you can provide a +contentTypeTemplate with a special $version placeholder. That placeholder will be filled by the value of the +version YAML property. Consider the following example of a contentTypeTemplate:

application/vnd.newsletter.$version+json

Further consider the following version:

v1

The combination of contentTypeTemplate and version results in the creation of a +Content-Type header for each request, as follows:

application/vnd.newsletter.v1+json

5.3.5 Default Headers

Default headers are represented by the headers map in YAML.

Sometimes, each call to a dependency requires setting up of some default headers. To not +do that in code, you can set them up in the YAML file, as shown in the following example +headers section:

headers:
+    Accept:
+        - text/html
+        - application/xhtml+xml
+    Cache-Control:
+        - no-cache

That headers section results in adding the Accept and Cache-Control headers with +appropriate list of values in your HTTP request.

5.3.6 Required Dependencies

Required dependencies are represented by required property in YAML.

If one of your dependencies is required to be up when your application boots, you can set +the required: true property in the YAML file.

If your application cannot localize the required dependency during boot time, it throws an +exception, and the Spring Context fails to set up. In other words, your application cannot +start if the required dependency is not registered in Zookeeper.

You can read more about Spring Cloud Zookeeper Presence Checker +later in this document.

5.3.7 Stubs

You can provide a colon-separated path to the JAR containing stubs of the dependency, as +shown in the following example:

stubs: org.springframework:myApp:stubs

where:

  • org.springframework is the groupId.
  • myApp is the artifactId.
  • stubs is the classifier. (Note that stubs is the default value.)

Because stubs is the default classifier, the preceding example is equal to the following +example:

stubs: org.springframework:myApp

5.4 Configuring Spring Cloud Zookeeper Dependencies

You can set the following properties to enable or disable parts of Zookeeper Dependencies +functionalities:

  • spring.cloud.zookeeper.dependencies: If you do not set this property, you cannot use +Zookeeper Dependencies.
  • spring.cloud.zookeeper.dependency.ribbon.enabled (enabled by default): Ribbon requires +either explicit global configuration or a particular one for a dependency. By turning on +this property, runtime load balancing strategy resolution is possible, and you can use the +loadBalancerType section of the Zookeeper Dependencies. The configuration that needs +this property has an implementation of LoadBalancerClient that delegates to the +ILoadBalancer presented in the next bullet.
  • spring.cloud.zookeeper.dependency.ribbon.loadbalancer (enabled by default): Thanks to +this property, the custom ILoadBalancer knows that the part of the URI passed to Ribbon +might actually be the alias that has to be resolved to a proper path in Zookeeper. Without +this property, you cannot register applications under nested paths.
  • spring.cloud.zookeeper.dependency.headers.enabled (enabled by default): This property +registers a RibbonClient that automatically appends appropriate headers and content +types with their versions, as presented in the Dependency configuration. Without this +setting, those two parameters do not work.
  • spring.cloud.zookeeper.dependency.resttemplate.enabled (enabled by default): When +enabled, this property modifies the request headers of a @LoadBalanced-annotated +RestTemplate such that it passes headers and content type with the version set in +dependency configuration. Without this setting, those two parameters do not work.

6. Spring Cloud Zookeeper Dependency Watcher

The Dependency Watcher mechanism lets you register listeners to your dependencies. The +functionality is, in fact, an implementation of the Observator pattern. When a +dependency changes, its state (to either UP or DOWN), some custom logic can be applied.

6.1 Activating

Spring Cloud Zookeeper Dependencies functionality needs to be enabled for you to use the +Dependency Watcher mechanism.

6.2 Registering a Listener

To register a listener, you must implement an interface called +org.springframework.cloud.zookeeper.discovery.watcher.DependencyWatcherListener and +register it as a bean. The interface gives you one method:

void stateChanged(String dependencyName, DependencyState newState);

If you want to register a listener for a particular dependency, the dependencyName would +be the discriminator for your concrete implementation. newState provides you with +information about whether your dependency has changed to CONNECTED or DISCONNECTED.

6.3 Using the Presence Checker

Bound with the Dependency Watcher is the functionality called Presence Checker. It lets +you provide custom behavior when your application boots, to react according to the state +of your dependencies.

The default implementation of the abstract +org.springframework.cloud.zookeeper.discovery.watcher.presence.DependencyPresenceOnStartupVerifier +class is the +org.springframework.cloud.zookeeper.discovery.watcher.presence.DefaultDependencyPresenceOnStartupVerifier, +which works in the following way.

  1. If the dependency is marked us required and is not in Zookeeper, when your application +boots, it throws an exception and shuts down.
  2. If the dependency is not required, the +org.springframework.cloud.zookeeper.discovery.watcher.presence.LogMissingDependencyChecker +logs that the dependency is missing at the WARN level.

Because the DefaultDependencyPresenceOnStartupVerifier is registered only when there is +no bean of type DependencyPresenceOnStartupVerifier, this functionality can be +overridden.

7. Distributed Configuration with Zookeeper

Zookeeper provides a +hierarchical namespace +that lets clients store arbitrary data, such as configuration data. Spring Cloud Zookeeper +Config is an alternative to the +Config Server and Client. +Configuration is loaded into the Spring Environment during the special “bootstrap” +phase. Configuration is stored in the /config namespace by default. Multiple +PropertySource instances are created, based on the application’s name and the active +profiles, to mimic the Spring Cloud Config order of resolving properties. For example, an +application with a name of testApp and with the dev profile has the following property +sources created for it:

  • config/testApp,dev
  • config/testApp
  • config/application,dev
  • config/application

The most specific property source is at the top, with the least specific at the bottom. +Properties in the config/application namespace apply to all applications that use +zookeeper for configuration. Properties in the config/testApp namespace are available +only to the instances of the service named testApp.

Configuration is currently read on startup of the application. Sending a HTTP POST +request to /refresh causes the configuration to be reloaded. Watching the configuration +namespace (which Zookeeper supports) is not currently implemented.

7.1 Activating

Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-config enables +autoconfiguration that sets up Spring Cloud Zookeeper Config.

[Caution]Caution

When working with version 3.4 of Zookeeper you need to change +the way you include the dependency as described here.

7.2 Customizing

Zookeeper Config may be customized by setting the following properties:

bootstrap.yml.  +

spring:
+  cloud:
+    zookeeper:
+      config:
+        enabled: true
+        root: configuration
+        defaultContext: apps
+        profileSeparator: '::'

+

  • enabled: Setting this value to false disables Zookeeper Config.
  • root: Sets the base namespace for configuration values.
  • defaultContext: Sets the name used by all applications.
  • profileSeparator: Sets the value of the separator used to separate the profile name in +property sources with profiles.

7.3 Access Control Lists (ACLs)

You can add authentication information for Zookeeper ACLs by calling the addAuthInfo +method of a CuratorFramework bean. One way to accomplish this is to provide your own +CuratorFramework bean, as shown in the following example:

@BoostrapConfiguration
+public class CustomCuratorFrameworkConfig {
+
+  @Bean
+  public CuratorFramework curatorFramework() {
+    CuratorFramework curator = new CuratorFramework();
+    curator.addAuthInfo("digest", "user:password".getBytes());
+    return curator;
+  }
+
+}

Consult +the ZookeeperAutoConfiguration class +to see how the CuratorFramework bean’s default configuration.

Alternatively, you can add your credentials from a class that depends on the existing +CuratorFramework bean, as shown in the following example:

@BoostrapConfiguration
+public class DefaultCuratorFrameworkConfig {
+
+  public ZookeeperConfig(CuratorFramework curator) {
+    curator.addAuthInfo("digest", "user:password".getBytes());
+  }
+
+}

The creation of this bean must occur during the boostrapping phase. You can register +configuration classes to run during this phase by annotating them with +@BootstrapConfiguration and including them in a comma-separated list that you set as the +value of the org.springframework.cloud.bootstrap.BootstrapConfiguration property in the +resources/META-INF/spring.factories file, as shown in the following example:

resources/META-INF/spring.factories.  +

org.springframework.cloud.bootstrap.BootstrapConfiguration=\
+my.project.CustomCuratorFrameworkConfig,\
+my.project.DefaultCuratorFrameworkConfig

+

\ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/spring-cloud-zookeeper.html b/spring-cloud-zookeeper/2.1.4.RELEASE/spring-cloud-zookeeper.html new file mode 100644 index 00000000..f59e668f --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/spring-cloud-zookeeper.html @@ -0,0 +1,117 @@ + + + + + + + +spring-cloud-zookeeper + + + + + + + + +
+
+
+
+

2.1.4.RELEASE

+
+
+
+
+

Pick The Documentation Option

+
+
+ +
+
+
+
+ + + + + \ No newline at end of file diff --git a/spring-cloud-zookeeper/2.1.4.RELEASE/spring-cloud-zookeeper.xml b/spring-cloud-zookeeper/2.1.4.RELEASE/spring-cloud-zookeeper.xml new file mode 100644 index 00000000..7d64cc52 --- /dev/null +++ b/spring-cloud-zookeeper/2.1.4.RELEASE/spring-cloud-zookeeper.xml @@ -0,0 +1,584 @@ + + + + + +Spring Cloud Zookeeper +2019-11-18 + + + +This project provides Zookeeper integrations for Spring Boot applications through +autoconfiguration and binding to the Spring Environment and other Spring programming model +idioms. With a few annotations, you can quickly enable and configure the common patterns +inside your application and build large distributed systems with Zookeeper based +components. The provided patterns include Service Discovery and Configuration. Integration +with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load Balancing +(Ribbon), and Circuit Breaker (Hystrix). + + +Install Zookeeper +See the installation +documentation for instructions on how to install Zookeeper. +Spring Cloud Zookeeper uses Apache Curator behind the scenes. +While Zookeeper 3.5.x is still considered "beta" by the Zookeeper development team, +the reality is that it is used in production by many users. +However, Zookeeper 3.4.x is also used in production. +Prior to Apache Curator 4.0, both versions of Zookeeper were supported via two versions of Apache Curator. +Starting with Curator 4.0 both versions of Zookeeper are supported via the same Curator libraries. +In case you are integrating with version 3.4 you need to change the Zookeeper dependency +that comes shipped with curator, and thus spring-cloud-zookeeper. +To do so simply exclude that dependency and add the 3.4.x version like shown below. + +maven + +<dependency> + <groupId>org.springframework.cloud</groupId> + <artifactId>spring-cloud-starter-zookeeper-all</artifactId> + <exclusions> + <exclusion> + <groupId>org.apache.zookeeper</groupId> + <artifactId>zookeeper</artifactId> + </exclusion> + </exclusions> +</dependency> +<dependency> + <groupId>org.apache.zookeeper</groupId> + <artifactId>zookeeper</artifactId> + <version>3.4.12</version> + <exclusions> + <exclusion> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + </exclusion> + </exclusions> +</dependency> + + + +gradle + +compile('org.springframework.cloud:spring-cloud-starter-zookeeper-all') { + exclude group: 'org.apache.zookeeper', module: 'zookeeper' +} +compile('org.apache.zookeeper:zookeeper:3.4.12') { + exclude group: 'org.slf4j', module: 'slf4j-log4j12' +} + + + + +Service Discovery with Zookeeper +Service Discovery is one of the key tenets of a microservice based architecture. Trying to +hand-configure each client or some form of convention can be difficult to do and can be +brittle. Curator(A Java library for Zookeeper) provides Service +Discovery through a Service Discovery +Extension. Spring Cloud Zookeeper uses this extension for service registration and +discovery. +
+Activating +Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables +autoconfiguration that sets up Spring Cloud Zookeeper Discovery. + +For web functionality, you still need to include +org.springframework.boot:spring-boot-starter-web. + + +When working with version 3.4 of Zookeeper you need to change +the way you include the dependency as described here. + +
+
+Registering with Zookeeper +When a client registers with Zookeeper, it provides metadata (such as host and port, ID, +and name) about itself. +The following example shows a Zookeeper client: +@SpringBootApplication +@RestController +public class Application { + + @RequestMapping("/") + public String home() { + return "Hello world"; + } + + public static void main(String[] args) { + new SpringApplicationBuilder(Application.class).web(true).run(args); + } + +} + +The preceding example is a normal Spring Boot application. + +If Zookeeper is located somewhere other than localhost:2181, the configuration must +provide the location of the server, as shown in the following example: + +application.yml + +spring: + cloud: + zookeeper: + connect-string: localhost:2181 + + + +If you use Spring Cloud Zookeeper Config, the +values shown in the preceding example need to be in bootstrap.yml instead of +application.yml. + +The default service name, instance ID, and port (taken from the Environment) are +${spring.application.name}, the Spring Context ID, and ${server.port}, respectively. +Having spring-cloud-starter-zookeeper-discovery on the classpath makes the app into both +a Zookeeper service (that is, it registers itself) and a client (that is, it can +query Zookeeper to locate other services). +If you would like to disable the Zookeeper Discovery Client, you can set +spring.cloud.zookeeper.discovery.enabled to false. +
+
+Using the DiscoveryClient +Spring Cloud has support for +Feign +(a REST client builder) and +Spring +RestTemplate, using logical service names instead of physical URLs. +You can also use the org.springframework.cloud.client.discovery.DiscoveryClient, which +provides a simple API for discovery clients that is not specific to Netflix, as shown in +the following example: +@Autowired +private DiscoveryClient discoveryClient; + +public String serviceUrl() { + List<ServiceInstance> list = discoveryClient.getInstances("STORES"); + if (list != null && list.size() > 0 ) { + return list.get(0).getUri().toString(); + } + return null; +} +
+ + +Using Spring Cloud Zookeeper with Spring Cloud Netflix Components +Spring Cloud Netflix supplies useful tools that work regardless of which DiscoveryClient +implementation you use. Feign, Turbine, Ribbon, and Zuul all work with Spring Cloud +Zookeeper. +
+Ribbon with Zookeeper +Spring Cloud Zookeeper provides an implementation of Ribbon’s ServerList. When you use +the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfigured to use the +ZookeeperServerList by default. +
+ + +Spring Cloud Zookeeper and Service Registry +Spring Cloud Zookeeper implements the ServiceRegistry interface, letting developers +register arbitrary services in a programmatic way. +The ServiceInstanceRegistration class offers a builder() method to create a +Registration object that can be used by the ServiceRegistry, as shown in the following +example: +@Autowired +private ZookeeperServiceRegistry serviceRegistry; + +public void registerThings() { + ZookeeperRegistration registration = ServiceInstanceRegistration.builder() + .defaultUriSpec() + .address("anyUrl") + .port(10) + .name("/a/b/c/d/anotherservice") + .build(); + this.serviceRegistry.register(registration); +} +
+Instance Status +Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the +server. These instances are not returned as active service instances. This is useful for +behaviors such as blue/green deployments. (Note that the Curator Service Discovery recipe +does not support this behavior.) Taking advantage of the flexible payload has let Spring +Cloud Zookeeper implement OUT_OF_SERVICE by updating some specific metadata and then +filtering on that metadata in the Ribbon ZookeeperServerList. The ZookeeperServerList +filters out all non-null instance statuses that do not equal UP. If the instance status +field is empty, it is considered to be UP for backwards compatibility. To change the +status of an instance, make a POST with OUT_OF_SERVICE to the ServiceRegistry +instance status actuator endpoint, as shown in the following example: +$ http POST http://localhost:8081/service-registry status=OUT_OF_SERVICE + +The preceding example uses the http command from https://httpie.org. + +
+ + +Zookeeper Dependencies +The following topics cover how to work with Spring Cloud Zookeeper dependencies: + + + + + + + + + + + + + + +
+Using the Zookeeper Dependencies +Spring Cloud Zookeeper gives you a possibility to provide dependencies of your application +as properties. As dependencies, you can understand other applications that are registered +in Zookeeper and which you would like to call through +Feign +(a REST client builder) and Spring RestTemplate. +You can also use the Zookeeper Dependency Watchers functionality to control and monitor +the state of your dependencies. +
+
+Activating Zookeeper Dependencies +Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables +autoconfiguration that sets up Spring Cloud Zookeeper Dependencies. Even if you provide +the dependencies in your properties, you can turn off the dependencies. To do so, set the +spring.cloud.zookeeper.dependency.enabled property to false (it defaults to true). +
+
+Setting up Zookeeper Dependencies +Consider the following example of dependency representation: + +application.yml + +spring.application.name: yourServiceName +spring.cloud.zookeeper: + dependencies: + newsletter: + path: /path/where/newsletter/has/registered/in/zookeeper + loadBalancerType: ROUND_ROBIN + contentTypeTemplate: application/vnd.newsletter.$version+json + version: v1 + headers: + header1: + - value1 + header2: + - value2 + required: false + stubs: org.springframework:foo:stubs + mailing: + path: /path/where/mailing/has/registered/in/zookeeper + loadBalancerType: ROUND_ROBIN + contentTypeTemplate: application/vnd.mailing.$version+json + version: v1 + required: true + + +The next few sections go through each part of the dependency one by one. The root property +name is spring.cloud.zookeeper.dependencies. +
+Aliases +Below the root property you have to represent each dependency as an alias. This is due to +the constraints of Ribbon, which requires that the application ID be placed in the URL. +Consequently, you cannot pass any complex path, suchas /myApp/myRoute/name). The alias +is the name you use instead of the serviceId for DiscoveryClient, Feign, or +RestTemplate. +In the previous examples, the aliases are newsletter and mailing. The following +example shows Feign usage with a newsletter alias: +@FeignClient("newsletter") +public interface NewsletterService { + @RequestMapping(method = RequestMethod.GET, value = "/newsletter") + String getNewsletters(); +} +
+
+Path +The path is represented by the path YAML property and is the path under which the +dependency is registered under Zookeeper. As described in the +previous section, Ribbon +operates on URLs. As a result, this path is not compliant with its requirement. +That is why Spring Cloud Zookeeper maps the alias to the proper path. +
+
+Load Balancer Type +The load balancer type is represented by loadBalancerType YAML property. +If you know what kind of load-balancing strategy has to be applied when calling this +particular dependency, you can provide it in the YAML file, and it is automatically +applied. You can choose one of the following load balancing strategies: + + +STICKY: Once chosen, the instance is always called. + + +RANDOM: Picks an instance randomly. + + +ROUND_ROBIN: Iterates over instances over and over again. + + +
+
+<literal>Content-Type</literal> Template and Version +The Content-Type template and version are represented by the contentTypeTemplate and +version YAML properties. +If you version your API in the Content-Type header, you do not want to add this header +to each of your requests. Also, if you want to call a new version of the API, you do not +want to roam around your code to bump up the API version. That is why you can provide a +contentTypeTemplate with a special $version placeholder. That placeholder will be filled by the value of the +version YAML property. Consider the following example of a contentTypeTemplate: +application/vnd.newsletter.$version+json +Further consider the following version: +v1 +The combination of contentTypeTemplate and version results in the creation of a +Content-Type header for each request, as follows: +application/vnd.newsletter.v1+json +
+
+Default Headers +Default headers are represented by the headers map in YAML. +Sometimes, each call to a dependency requires setting up of some default headers. To not +do that in code, you can set them up in the YAML file, as shown in the following example +headers section: +headers: + Accept: + - text/html + - application/xhtml+xml + Cache-Control: + - no-cache +That headers section results in adding the Accept and Cache-Control headers with +appropriate list of values in your HTTP request. +
+
+Required Dependencies +Required dependencies are represented by required property in YAML. +If one of your dependencies is required to be up when your application boots, you can set +the required: true property in the YAML file. +If your application cannot localize the required dependency during boot time, it throws an +exception, and the Spring Context fails to set up. In other words, your application cannot +start if the required dependency is not registered in Zookeeper. +You can read more about Spring Cloud Zookeeper Presence Checker +later in this document. +
+
+Stubs +You can provide a colon-separated path to the JAR containing stubs of the dependency, as +shown in the following example: +stubs: org.springframework:myApp:stubs +where: + + +org.springframework is the groupId. + + +myApp is the artifactId. + + +stubs is the classifier. (Note that stubs is the default value.) + + +Because stubs is the default classifier, the preceding example is equal to the following +example: +stubs: org.springframework:myApp +
+
+
+Configuring Spring Cloud Zookeeper Dependencies +You can set the following properties to enable or disable parts of Zookeeper Dependencies +functionalities: + + +spring.cloud.zookeeper.dependencies: If you do not set this property, you cannot use +Zookeeper Dependencies. + + +spring.cloud.zookeeper.dependency.ribbon.enabled (enabled by default): Ribbon requires +either explicit global configuration or a particular one for a dependency. By turning on +this property, runtime load balancing strategy resolution is possible, and you can use the +loadBalancerType section of the Zookeeper Dependencies. The configuration that needs +this property has an implementation of LoadBalancerClient that delegates to the +ILoadBalancer presented in the next bullet. + + +spring.cloud.zookeeper.dependency.ribbon.loadbalancer (enabled by default): Thanks to +this property, the custom ILoadBalancer knows that the part of the URI passed to Ribbon +might actually be the alias that has to be resolved to a proper path in Zookeeper. Without +this property, you cannot register applications under nested paths. + + +spring.cloud.zookeeper.dependency.headers.enabled (enabled by default): This property +registers a RibbonClient that automatically appends appropriate headers and content +types with their versions, as presented in the Dependency configuration. Without this +setting, those two parameters do not work. + + +spring.cloud.zookeeper.dependency.resttemplate.enabled (enabled by default): When +enabled, this property modifies the request headers of a @LoadBalanced-annotated +RestTemplate such that it passes headers and content type with the version set in +dependency configuration. Without this setting, those two parameters do not work. + + +
+ + +Spring Cloud Zookeeper Dependency Watcher +The Dependency Watcher mechanism lets you register listeners to your dependencies. The +functionality is, in fact, an implementation of the Observator pattern. When a +dependency changes, its state (to either UP or DOWN), some custom logic can be applied. +
+Activating +Spring Cloud Zookeeper Dependencies functionality needs to be enabled for you to use the +Dependency Watcher mechanism. +
+
+Registering a Listener +To register a listener, you must implement an interface called +org.springframework.cloud.zookeeper.discovery.watcher.DependencyWatcherListener and +register it as a bean. The interface gives you one method: +void stateChanged(String dependencyName, DependencyState newState); +If you want to register a listener for a particular dependency, the dependencyName would +be the discriminator for your concrete implementation. newState provides you with +information about whether your dependency has changed to CONNECTED or DISCONNECTED. +
+
+Using the Presence Checker +Bound with the Dependency Watcher is the functionality called Presence Checker. It lets +you provide custom behavior when your application boots, to react according to the state +of your dependencies. +The default implementation of the abstract +org.springframework.cloud.zookeeper.discovery.watcher.presence.DependencyPresenceOnStartupVerifier +class is the +org.springframework.cloud.zookeeper.discovery.watcher.presence.DefaultDependencyPresenceOnStartupVerifier, +which works in the following way. + + +If the dependency is marked us required and is not in Zookeeper, when your application +boots, it throws an exception and shuts down. + + +If the dependency is not required, the +org.springframework.cloud.zookeeper.discovery.watcher.presence.LogMissingDependencyChecker +logs that the dependency is missing at the WARN level. + + +Because the DefaultDependencyPresenceOnStartupVerifier is registered only when there is +no bean of type DependencyPresenceOnStartupVerifier, this functionality can be +overridden. +
+ + +Distributed Configuration with Zookeeper +Zookeeper provides a +hierarchical namespace +that lets clients store arbitrary data, such as configuration data. Spring Cloud Zookeeper +Config is an alternative to the +Config Server and Client. +Configuration is loaded into the Spring Environment during the special bootstrap +phase. Configuration is stored in the /config namespace by default. Multiple +PropertySource instances are created, based on the application’s name and the active +profiles, to mimic the Spring Cloud Config order of resolving properties. For example, an +application with a name of testApp and with the dev profile has the following property +sources created for it: + + +config/testApp,dev + + +config/testApp + + +config/application,dev + + +config/application + + +The most specific property source is at the top, with the least specific at the bottom. +Properties in the config/application namespace apply to all applications that use +zookeeper for configuration. Properties in the config/testApp namespace are available +only to the instances of the service named testApp. +Configuration is currently read on startup of the application. Sending a HTTP POST +request to /refresh causes the configuration to be reloaded. Watching the configuration +namespace (which Zookeeper supports) is not currently implemented. +
+Activating +Including a dependency on +org.springframework.cloud:spring-cloud-starter-zookeeper-config enables +autoconfiguration that sets up Spring Cloud Zookeeper Config. + +When working with version 3.4 of Zookeeper you need to change +the way you include the dependency as described here. + +
+
+Customizing +Zookeeper Config may be customized by setting the following properties: + +bootstrap.yml + +spring: + cloud: + zookeeper: + config: + enabled: true + root: configuration + defaultContext: apps + profileSeparator: '::' + + + + +enabled: Setting this value to false disables Zookeeper Config. + + +root: Sets the base namespace for configuration values. + + +defaultContext: Sets the name used by all applications. + + +profileSeparator: Sets the value of the separator used to separate the profile name in +property sources with profiles. + + +
+
+Access Control Lists (ACLs) +You can add authentication information for Zookeeper ACLs by calling the addAuthInfo +method of a CuratorFramework bean. One way to accomplish this is to provide your own +CuratorFramework bean, as shown in the following example: +@BoostrapConfiguration +public class CustomCuratorFrameworkConfig { + + @Bean + public CuratorFramework curatorFramework() { + CuratorFramework curator = new CuratorFramework(); + curator.addAuthInfo("digest", "user:password".getBytes()); + return curator; + } + +} +Consult +the ZookeeperAutoConfiguration class +to see how the CuratorFramework bean’s default configuration. +Alternatively, you can add your credentials from a class that depends on the existing +CuratorFramework bean, as shown in the following example: +@BoostrapConfiguration +public class DefaultCuratorFrameworkConfig { + + public ZookeeperConfig(CuratorFramework curator) { + curator.addAuthInfo("digest", "user:password".getBytes()); + } + +} +The creation of this bean must occur during the boostrapping phase. You can register +configuration classes to run during this phase by annotating them with +@BootstrapConfiguration and including them in a comma-separated list that you set as the +value of the org.springframework.cloud.bootstrap.BootstrapConfiguration property in the +resources/META-INF/spring.factories file, as shown in the following example: + +resources/META-INF/spring.factories + +org.springframework.cloud.bootstrap.BootstrapConfiguration=\ +my.project.CustomCuratorFrameworkConfig,\ +my.project.DefaultCuratorFrameworkConfig + + +
+ + \ No newline at end of file