-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding Search API sample code. (#167)
* Adding Search API sample code. * Added tests, correct style checks. Change-Id: Ib568b0ae397501f4b437478b2f6c1564fb50e0b1
- Loading branch information
Showing
18 changed files
with
1,163 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Eclipse files | ||
.project | ||
.classpath | ||
.settings | ||
|
||
# Target folders | ||
target/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Google App Engine Standard Environment Search API Sample | ||
|
||
This sample demonstrates how to use App Engine Search API. | ||
|
||
See the [Google App Engine Search API documentation][search-api-docs] for more | ||
detailed instructions. | ||
|
||
[search-api-docs]: https://cloud.google.com/appengine/docs/java/search/ | ||
|
||
## Setup | ||
1. Update the `<application>` tag in `src/main/webapp/WEB-INF/appengine-web.xml` | ||
with your project name. | ||
1. Update the `<version>` tag in `src/main/webapp/WEB-INF/appengine-web.xml` | ||
with your version name. | ||
|
||
## Running locally | ||
$ mvn appengine:devserver | ||
|
||
## Deploying | ||
$ mvn appengine:update |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,223 @@ | ||
<?xml version="1.0"?> | ||
<!DOCTYPE module PUBLIC | ||
"-//Puppy Crawl//DTD Check Configuration 1.3//EN" | ||
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> | ||
<!-- | ||
Copyright 2016 Google Inc. All Rights Reserved. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
|
||
<!-- | ||
Checkstyle configuration that checks the Google coding conventions from: | ||
- Google Java Style | ||
https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html | ||
Checkstyle is very configurable. Be sure to read the documentation at | ||
http://checkstyle.sf.net (or in your downloaded distribution). | ||
Most Checks are configurable, be sure to consult the documentation. | ||
To completely disable a check, just comment it out or delete it from the file. | ||
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. | ||
--> | ||
<module name = "Checker"> | ||
<property name="charset" value="UTF-8"/> | ||
|
||
<property name="severity" value="error"/> | ||
|
||
<property name="fileExtensions" value="java, properties, xml"/> | ||
<!-- Checks for whitespace --> | ||
<!-- See http://checkstyle.sf.net/config_whitespace.html --> | ||
<module name="FileTabCharacter"> | ||
<property name="eachLine" value="true"/> | ||
</module> | ||
|
||
<module name="TreeWalker"> | ||
<!-- Make @SuppressWarnings available to checkstyle http://stackoverflow.com/a/22556386/101923 --> | ||
<module name="SuppressWarningsHolder" /> | ||
<module name="UnusedImports"/> | ||
<module name="OuterTypeFilename"/> | ||
<module name="IllegalTokenText"> | ||
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/> | ||
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/> | ||
<property name="message" value="Avoid using corresponding octal or Unicode escape."/> | ||
</module> | ||
<module name="AvoidEscapedUnicodeCharacters"> | ||
<property name="allowEscapesForControlCharacters" value="true"/> | ||
<property name="allowByTailComment" value="true"/> | ||
<property name="allowNonPrintableEscapes" value="true"/> | ||
</module> | ||
<module name="LineLength"> | ||
<property name="max" value="100"/> | ||
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> | ||
</module> | ||
<module name="AvoidStarImport"/> | ||
<module name="OneTopLevelClass"/> | ||
<module name="NoLineWrap"/> | ||
<module name="EmptyBlock"> | ||
<property name="option" value="TEXT"/> | ||
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/> | ||
</module> | ||
<module name="NeedBraces"/> | ||
<module name="LeftCurly"> | ||
<property name="maxLineLength" value="100"/> | ||
</module> | ||
<module name="RightCurly"/> | ||
<module name="RightCurly"> | ||
<property name="option" value="alone"/> | ||
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/> | ||
</module> | ||
<module name="WhitespaceAround"> | ||
<property name="allowEmptyConstructors" value="true"/> | ||
<property name="allowEmptyMethods" value="true"/> | ||
<property name="allowEmptyTypes" value="true"/> | ||
<property name="allowEmptyLoops" value="true"/> | ||
<message key="ws.notFollowed" | ||
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/> | ||
<message key="ws.notPreceded" | ||
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/> | ||
</module> | ||
<module name="OneStatementPerLine"/> | ||
<module name="MultipleVariableDeclarations"/> | ||
<module name="ArrayTypeStyle"/> | ||
<module name="MissingSwitchDefault"/> | ||
<module name="FallThrough"/> | ||
<module name="UpperEll"/> | ||
<module name="ModifierOrder"/> | ||
<module name="EmptyLineSeparator"> | ||
<property name="allowNoEmptyLineBetweenFields" value="true"/> | ||
<property name="tokens" value="CLASS_DEF, ENUM_DEF, INTERFACE_DEF, CTOR_DEF, METHOD_DEF, STATIC_INIT, INSTANCE_INIT, VARIABLE_DEF" /> | ||
</module> | ||
<module name="SeparatorWrap"> | ||
<property name="tokens" value="DOT"/> | ||
<property name="option" value="nl"/> | ||
</module> | ||
<module name="SeparatorWrap"> | ||
<property name="tokens" value="COMMA"/> | ||
<property name="option" value="EOL"/> | ||
</module> | ||
<module name="PackageName"> | ||
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/> | ||
<message key="name.invalidPattern" | ||
value="Package name ''{0}'' must match pattern ''{1}''."/> | ||
</module> | ||
<module name="TypeName"> | ||
<message key="name.invalidPattern" | ||
value="Type name ''{0}'' must match pattern ''{1}''."/> | ||
</module> | ||
<module name="MemberName"> | ||
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> | ||
<message key="name.invalidPattern" | ||
value="Member name ''{0}'' must match pattern ''{1}''."/> | ||
</module> | ||
<module name="ParameterName"> | ||
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> | ||
<message key="name.invalidPattern" | ||
value="Parameter name ''{0}'' must match pattern ''{1}''."/> | ||
</module> | ||
<module name="LocalVariableName"> | ||
<property name="tokens" value="VARIABLE_DEF"/> | ||
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> | ||
<property name="allowOneCharVarInForLoop" value="true"/> | ||
<message key="name.invalidPattern" | ||
value="Local variable name ''{0}'' must match pattern ''{1}''."/> | ||
</module> | ||
<module name="ClassTypeParameterName"> | ||
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> | ||
<message key="name.invalidPattern" | ||
value="Class type name ''{0}'' must match pattern ''{1}''."/> | ||
</module> | ||
<module name="MethodTypeParameterName"> | ||
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> | ||
<message key="name.invalidPattern" | ||
value="Method type name ''{0}'' must match pattern ''{1}''."/> | ||
</module> | ||
<module name="NoFinalizer"/> | ||
<module name="GenericWhitespace"> | ||
<message key="ws.followed" | ||
value="GenericWhitespace ''{0}'' is followed by whitespace."/> | ||
<message key="ws.preceded" | ||
value="GenericWhitespace ''{0}'' is preceded with whitespace."/> | ||
<message key="ws.illegalFollow" | ||
value="GenericWhitespace ''{0}'' should followed by whitespace."/> | ||
<message key="ws.notPreceded" | ||
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/> | ||
</module> | ||
<module name="Indentation"> | ||
<property name="basicOffset" value="2"/> | ||
<property name="braceAdjustment" value="0"/> | ||
<property name="caseIndent" value="2"/> | ||
<property name="throwsIndent" value="4"/> | ||
<property name="lineWrappingIndentation" value="4"/> | ||
<property name="arrayInitIndent" value="2"/> | ||
</module> | ||
<module name="AbbreviationAsWordInName"> | ||
<property name="ignoreFinal" value="false"/> | ||
<property name="allowedAbbreviationLength" value="1"/> | ||
</module> | ||
<module name="OverloadMethodsDeclarationOrder"/> | ||
<module name="CustomImportOrder"> | ||
<property name="specialImportsRegExp" value="^javax\."/> | ||
<property name="sortImportsInGroupAlphabetically" value="true"/> | ||
<property name="customImportOrderRules" value="STATIC###SAME_PACKAGE(2)###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS"/> | ||
</module> | ||
<module name="MethodParamPad"/> | ||
<module name="OperatorWrap"> | ||
<property name="option" value="NL"/> | ||
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/> | ||
</module> | ||
<module name="AnnotationLocation"> | ||
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/> | ||
</module> | ||
<module name="AnnotationLocation"> | ||
<property name="tokens" value="VARIABLE_DEF"/> | ||
<property name="allowSamelineMultipleAnnotations" value="true"/> | ||
</module> | ||
<module name="NonEmptyAtclauseDescription"/> | ||
<module name="JavadocTagContinuationIndentation"/> | ||
<module name="SummaryJavadocCheck"> | ||
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/> | ||
</module> | ||
<module name="AtclauseOrder"> | ||
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/> | ||
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> | ||
</module> | ||
<module name="JavadocMethod"> | ||
<property name="scope" value="public"/> | ||
<property name="allowMissingJavadoc" value="true"/> | ||
<property name="allowMissingParamTags" value="true"/> | ||
<property name="allowMissingThrowsTags" value="true"/> | ||
<property name="allowMissingReturnTag" value="true"/> | ||
<property name="minLineCount" value="2"/> | ||
<property name="allowedAnnotations" value="Override, Test"/> | ||
<property name="allowThrowsTagsForSubclasses" value="true"/> | ||
</module> | ||
<module name="MethodName"> | ||
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/> | ||
<message key="name.invalidPattern" | ||
value="Method name ''{0}'' must match pattern ''{1}''."/> | ||
</module> | ||
<module name="SingleLineJavadoc"> | ||
<property name="ignoreInlineTags" value="false"/> | ||
</module> | ||
<module name="EmptyCatchBlock"> | ||
<property name="exceptionVariableName" value="expected"/> | ||
</module> | ||
<module name="FileContentsHolder"/> | ||
</module> | ||
|
||
<!-- Allow silencing rules with annotations http://stackoverflow.com/a/22556386/101923 --> | ||
<module name="SuppressWarningsFilter" /> | ||
<!-- Allow silencing with comment http://stackoverflow.com/questions/4023185 --> | ||
<module name="SuppressionCommentFilter" /> | ||
</module> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
<!-- | ||
Copyright 2015 Google Inc. All Rights Reserved. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
<project> | ||
<modelVersion>4.0.0</modelVersion> | ||
<packaging>war</packaging> | ||
<version>1.0-SNAPSHOT</version> | ||
<groupId>com.example.appengine</groupId> | ||
<artifactId>appengine-search</artifactId> | ||
<parent> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>doc-samples</artifactId> | ||
<version>1.0.0</version> | ||
<relativePath>../..</relativePath> | ||
</parent> | ||
<dependencies> | ||
<dependency> | ||
<groupId>com.google.appengine</groupId> | ||
<artifactId>appengine-api-1.0-sdk</artifactId> | ||
<version>${appengine.sdk.version}</version> | ||
</dependency> | ||
<dependency> | ||
<groupId>javax.servlet</groupId> | ||
<artifactId>servlet-api</artifactId> | ||
<version>2.5</version> | ||
<type>jar</type> | ||
<scope>provided</scope> | ||
</dependency> | ||
|
||
<!-- Test Dependencies --> | ||
<dependency> | ||
<groupId>junit</groupId> | ||
<artifactId>junit</artifactId> | ||
<version>4.10</version> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.mockito</groupId> | ||
<artifactId>mockito-all</artifactId> | ||
<version>1.10.19</version> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.google.appengine</groupId> | ||
<artifactId>appengine-testing</artifactId> | ||
<version>${appengine.sdk.version}</version> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.google.appengine</groupId> | ||
<artifactId>appengine-api-stubs</artifactId> | ||
<version>${appengine.sdk.version}</version> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.google.appengine</groupId> | ||
<artifactId>appengine-tools-sdk</artifactId> | ||
<version>${appengine.sdk.version}</version> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.google.truth</groupId> | ||
<artifactId>truth</artifactId> | ||
<version>0.28</version> | ||
<scope>test</scope> | ||
</dependency> | ||
</dependencies> | ||
<build> | ||
<!-- for hot reload of the web application --> | ||
<outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory> | ||
<plugins> | ||
<plugin> | ||
<groupId>org.apache.maven.plugins</groupId> | ||
<artifactId>maven-checkstyle-plugin</artifactId> | ||
<version>2.17</version> | ||
<configuration> | ||
<configLocation>google-checks.xml</configLocation> | ||
<consoleOutput>true</consoleOutput> | ||
<failOnViolation>true</failOnViolation> | ||
<failsOnError>true</failsOnError> | ||
<includeTestSourceDirectory>true</includeTestSourceDirectory> | ||
<suppressionsLocation>suppressions.xml</suppressionsLocation> | ||
</configuration> | ||
<executions> | ||
<execution><goals><goal>check</goal></goals></execution> | ||
</executions> | ||
</plugin> | ||
<plugin> | ||
<groupId>org.apache.maven.plugins</groupId> | ||
<version>3.3</version> | ||
<artifactId>maven-compiler-plugin</artifactId> | ||
<configuration> | ||
<source>1.7</source> | ||
<target>1.7</target> | ||
</configuration> | ||
</plugin> | ||
<!-- Parent POM defines ${appengine.sdk.version} (updates frequently). --> | ||
<plugin> | ||
<groupId>com.google.appengine</groupId> | ||
<artifactId>appengine-maven-plugin</artifactId> | ||
<version>${appengine.sdk.version}</version> | ||
</plugin> | ||
</plugins> | ||
</build> | ||
</project> |
Oops, something went wrong.