Skip to content

Commit 24bdecb

Browse files
author
Frank Natividad
committed
Copying updates made to endpoints-framework-v2/backend to java8
1 parent caf31ce commit 24bdecb

File tree

6 files changed

+424
-5
lines changed

6 files changed

+424
-5
lines changed

‎appengine-java8/endpoints-v2-backend/README.md

+94-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
This sample demonstrates how to use Google Cloud Endpoints Frameworks using
44
Java on App Engine Standard.
55

6-
## Adding the project ID to the sample API code
6+
## Build with Maven
7+
8+
### Adding the project ID to the sample API code
79

810
You must add the project ID obtained when you created your project to the
911
sample's `pom.xml` before you can deploy the code.
@@ -21,19 +23,19 @@ your project ID.
2123

2224
0. Save your changes.
2325

24-
## Building the sample project
26+
### Building the sample project
2527

2628
To build the project:
2729

2830
mvn clean package
2931

30-
## Generating the openapi.json file
32+
### Generating the openapi.json file
3133

3234
To generate the required configuration file `openapi.json`:
3335

3436
mvn exec:java -DGetSwaggerDoc
3537

36-
## Deploying the sample API to App Engine
38+
### Deploying the sample API to App Engine
3739

3840
To deploy the sample API:
3941

@@ -51,7 +53,94 @@ To deploy the sample API:
5153

5254
0. Wait for the upload to finish.
5355

54-
## Sending a request to the sample API
56+
### Sending a request to the sample API
57+
58+
After you deploy the API and its configuration file, you can send requests
59+
to the API.
60+
61+
To send a request to the API, from a command line, invoke the following `cURL`
62+
command:
63+
64+
curl \
65+
-H "Content-Type: application/json" \
66+
-X POST \
67+
-d '{"message":"echo"}' \
68+
https://$PROJECT_ID.appspot.com/_ah/api/echo/v1/echo
69+
70+
You will get a 200 response with the following data:
71+
72+
{
73+
"message": "echo"
74+
}
75+
76+
## Build with gradle
77+
78+
### Adding the project ID to the sample API code
79+
80+
0. Edit the file `build.gradle`.
81+
82+
0. For `def projectId = 'YOUR_PROJECT_ID'`, replace the value `YOUR_PROJECT_ID`
83+
with your project ID.
84+
85+
0. Edit the file `src/main/java/com/example/echo/Echo.java
86+
87+
0. Replace the value `YOUR-PROJECT-ID` with your project ID.
88+
89+
0. Save your changes.
90+
91+
### Building the sample project
92+
93+
To build the project on unix-based systems:
94+
95+
./gradlew build
96+
97+
Windows users: Use `gradlew.bat` instead of `./gradlew`
98+
99+
<details>
100+
<summary>more details</summary>
101+
The project contains the standard java and war plugins and in addition to that it contains the following plugins:
102+
https://github.com/GoogleCloudPlatform/endpoints-framework-gradle-plugin for the endpoint related tasks and
103+
https://github.com/GoogleCloudPlatform/app-gradle-plugin for the appengine standard related tasks.
104+
105+
Check the links for details about the available Plugin Goals and Parameters.
106+
</details>
107+
108+
### Generating the openapi.json file
109+
110+
To generate the required configuration file `openapi.json`:
111+
112+
./gradlew endpointsOpenApiDocs
113+
114+
This results in a file in build/endpointsOpenApiDocs/openapi.json
115+
116+
### Deploying the sample API to App Engine
117+
118+
To deploy the sample API:
119+
120+
0. Invoke the `gcloud` command to deploy the API configuration file:
121+
122+
gcloud service-management deploy build/endpointsOpenApiDocs/openapi.json
123+
124+
0. Deploy the API implementation code by invoking:
125+
126+
./gradlew appengineDeploy
127+
128+
The first time you upload a sample app, you may be prompted to authorize the
129+
deployment. Follow the prompts: when you are presented with a browser window
130+
containing a code, copy it to the terminal window.
131+
132+
<details>
133+
<summary>ERROR: (gcloud.app.deploy) The current Google Cloud project [...] does not contain an App Engine application.</summary>
134+
If you create a fresh cloud project that doesn't contain a appengine application you may receive this Error:
135+
136+
ERROR: (gcloud.app.deploy) The current Google Cloud project [...] does not contain an App Engine application. Use `gcloud app create` to initialize an App Engine application within the project.
137+
138+
In that case just execute `gcloud app create`, you will be asked to select a region and the app will be created. Then run gradle appengineDeploy again.
139+
</details>
140+
141+
0. Wait for the upload to finish.
142+
143+
### Sending a request to the sample API
55144

56145
After you deploy the API and its configuration file, you can send requests
57146
to the API.

‎appengine-java8/endpoints-v2-backend/build.gradle

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
// Copyright 2017 Google Inc.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.import org.apache.tools.ant.filters.ReplaceTokens
14+
15+
buildscript {
16+
repositories {
17+
mavenCentral()
18+
}
19+
20+
dependencies {
21+
classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:+'
22+
classpath 'com.google.cloud.tools:appengine-gradle-plugin:+'
23+
}
24+
}
25+
26+
repositories {
27+
maven {
28+
url 'https://maven-central.storage.googleapis.com'
29+
}
30+
jcenter()
31+
mavenCentral()
32+
}
33+
34+
task wrapper(type: Wrapper) {
35+
gradleVersion = '3.5'
36+
}
37+
38+
def projectId = 'YOUR_PROJECT_ID'
39+
40+
apply plugin: 'java'
41+
apply plugin: 'war'
42+
apply plugin: 'com.google.cloud.tools.endpoints-framework-server'
43+
apply plugin: 'com.google.cloud.tools.appengine'
44+
45+
dependencies {
46+
// For real projects: use concrete versions here instead of the '+' to make your build consistent
47+
compile 'com.google.endpoints:endpoints-framework:+'
48+
compile 'com.google.endpoints:endpoints-management-control-appengine:+'
49+
compile 'com.google.endpoints:endpoints-framework-auth:+'
50+
}
51+
52+
endpointsServer {
53+
// Endpoints Framework Plugin server-side configuration
54+
hostname = "echo-api.endpoints.${projectId}.cloud.goog"
55+
}
56+
57+
sourceCompatibility = 1.7 // App Engine Standard uses Java 7
58+
targetCompatibility = 1.7 // App Engine Standard uses Java 7
59+
60+
// this replaces the ${endpoints.project.id} in appengine-web.xml and web.xml
61+
task replaceProjectId(type: Copy) {
62+
from 'src/main/webapp/WEB-INF/'
63+
include '*.xml'
64+
into 'build/exploded-backend/WEB-INF'
65+
expand(endpoints:[project:[id:projectId]])
66+
filteringCharset = 'UTF-8'
67+
}
68+
assemble.dependsOn replaceProjectId

‎appengine-java8/endpoints-v2-backend/gradle/wrapper/gradle-wrapper.jar

53.5 KB
Binary file not shown.

‎appengine-java8/endpoints-v2-backend/gradle/wrapper/gradle-wrapper.properties

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#Thu Jun 01 15:23:25 PDT 2017
2+
distributionBase=GRADLE_USER_HOME
3+
distributionPath=wrapper/dists
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists
6+
distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-bin.zip

‎appengine-java8/endpoints-v2-backend/gradlew

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#!/usr/bin/env sh
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Attempt to set APP_HOME
10+
# Resolve links: $0 may be a link
11+
PRG="$0"
12+
# Need this for relative symlinks.
13+
while [ -h "$PRG" ] ; do
14+
ls=`ls -ld "$PRG"`
15+
link=`expr "$ls" : '.*-> \(.*\)$'`
16+
if expr "$link" : '/.*' > /dev/null; then
17+
PRG="$link"
18+
else
19+
PRG=`dirname "$PRG"`"/$link"
20+
fi
21+
done
22+
SAVED="`pwd`"
23+
cd "`dirname \"$PRG\"`/" >/dev/null
24+
APP_HOME="`pwd -P`"
25+
cd "$SAVED" >/dev/null
26+
27+
APP_NAME="Gradle"
28+
APP_BASE_NAME=`basename "$0"`
29+
30+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31+
DEFAULT_JVM_OPTS=""
32+
33+
# Use the maximum available, or set MAX_FD != -1 to use that value.
34+
MAX_FD="maximum"
35+
36+
warn ( ) {
37+
echo "$*"
38+
}
39+
40+
die ( ) {
41+
echo
42+
echo "$*"
43+
echo
44+
exit 1
45+
}
46+
47+
# OS specific support (must be 'true' or 'false').
48+
cygwin=false
49+
msys=false
50+
darwin=false
51+
nonstop=false
52+
case "`uname`" in
53+
CYGWIN* )
54+
cygwin=true
55+
;;
56+
Darwin* )
57+
darwin=true
58+
;;
59+
MINGW* )
60+
msys=true
61+
;;
62+
NONSTOP* )
63+
nonstop=true
64+
;;
65+
esac
66+
67+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68+
69+
# Determine the Java command to use to start the JVM.
70+
if [ -n "$JAVA_HOME" ] ; then
71+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72+
# IBM's JDK on AIX uses strange locations for the executables
73+
JAVACMD="$JAVA_HOME/jre/sh/java"
74+
else
75+
JAVACMD="$JAVA_HOME/bin/java"
76+
fi
77+
if [ ! -x "$JAVACMD" ] ; then
78+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79+
80+
Please set the JAVA_HOME variable in your environment to match the
81+
location of your Java installation."
82+
fi
83+
else
84+
JAVACMD="java"
85+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86+
87+
Please set the JAVA_HOME variable in your environment to match the
88+
location of your Java installation."
89+
fi
90+
91+
# Increase the maximum file descriptors if we can.
92+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93+
MAX_FD_LIMIT=`ulimit -H -n`
94+
if [ $? -eq 0 ] ; then
95+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96+
MAX_FD="$MAX_FD_LIMIT"
97+
fi
98+
ulimit -n $MAX_FD
99+
if [ $? -ne 0 ] ; then
100+
warn "Could not set maximum file descriptor limit: $MAX_FD"
101+
fi
102+
else
103+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104+
fi
105+
fi
106+
107+
# For Darwin, add options to specify how the application appears in the dock
108+
if $darwin; then
109+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110+
fi
111+
112+
# For Cygwin, switch paths to Windows format before running java
113+
if $cygwin ; then
114+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116+
JAVACMD=`cygpath --unix "$JAVACMD"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Escape application args
158+
save ( ) {
159+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160+
echo " "
161+
}
162+
APP_ARGS=$(save "$@")
163+
164+
# Collect all arguments for the java command, following the shell quoting and substitution rules
165+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166+
167+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169+
cd "$(dirname "$0")"
170+
fi
171+
172+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)