├── .github ├── FUNDING.yml └── workflows │ └── build.yml ├── .gitignore ├── .mvn └── wrapper │ ├── MavenWrapperDownloader.java │ └── maven-wrapper.properties ├── LICENSE ├── README.md ├── docker-compose-fix-port.yml ├── docker-compose.yml ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main ├── java │ └── com │ │ └── madadipouya │ │ └── elasticsearch │ │ └── springdata │ │ └── example │ │ ├── Application.java │ │ ├── config │ │ └── SwaggerConfig.java │ │ ├── controller │ │ ├── BookController.java │ │ ├── Redirect.java │ │ └── exception │ │ │ └── handler │ │ │ └── BookControllerExceptionHandler.java │ │ ├── metadata │ │ └── PublicationYear.java │ │ ├── model │ │ └── Book.java │ │ ├── repository │ │ └── BookRepository.java │ │ ├── service │ │ ├── BookService.java │ │ ├── exception │ │ │ ├── BookNotFoundException.java │ │ │ └── DuplicateIsbnException.java │ │ └── impl │ │ │ └── DefaultBookService.java │ │ └── validator │ │ └── PublicationYearValidator.java └── resources │ └── application.properties └── test └── java └── com └── madadipouya └── elasticsearch └── springdata ├── BookElasticsearchContainer.java └── example └── service └── impl └── DefaultBookServiceIT.java /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: kasramp 2 | custom: https://paypal.me/Madadipouya 3 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Java CI 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v3 10 | - name: Cache 11 | uses: actions/cache@v3 12 | with: 13 | path: ~/.m2/repository 14 | key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} 15 | restore-keys: | 16 | ${{ runner.os }}-maven- 17 | - name: Set up JDK 17 18 | uses: actions/setup-java@v3 19 | with: 20 | distribution: zulu 21 | java-version: 17 22 | - name: Run tests 23 | run: mvn clean verify 24 | - name: Build with Maven 25 | run: mvn -B package --file pom.xml 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | *.jar 15 | *.war 16 | *.ear 17 | *.zip 18 | *.tar.gz 19 | *.rar 20 | 21 | # Maven 22 | target/ 23 | 24 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 25 | hs_err_pid* 26 | 27 | # Intellij 28 | *.iml 29 | .idea/ 30 | 31 | # Eclipse 32 | *.pydevproject 33 | .project 34 | .metadata 35 | tmp/ 36 | *.tmp 37 | *.bak 38 | *.swp 39 | *~.nib 40 | local.properties 41 | .classpath 42 | .settings/ 43 | .loadpath 44 | 45 | -------------------------------------------------------------------------------- /.mvn/wrapper/MavenWrapperDownloader.java: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | https://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | import java.io.File; 21 | import java.io.FileInputStream; 22 | import java.io.FileOutputStream; 23 | import java.io.IOException; 24 | import java.net.URL; 25 | import java.nio.channels.Channels; 26 | import java.nio.channels.ReadableByteChannel; 27 | import java.util.Properties; 28 | 29 | public class MavenWrapperDownloader { 30 | 31 | /** 32 | * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided. 33 | */ 34 | private static final String DEFAULT_DOWNLOAD_URL = 35 | "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"; 36 | 37 | /** 38 | * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to 39 | * use instead of the default one. 40 | */ 41 | private static final String MAVEN_WRAPPER_PROPERTIES_PATH = 42 | ".mvn/wrapper/maven-wrapper.properties"; 43 | 44 | /** 45 | * Path where the maven-wrapper.jar will be saved to. 46 | */ 47 | private static final String MAVEN_WRAPPER_JAR_PATH = 48 | ".mvn/wrapper/maven-wrapper.jar"; 49 | 50 | /** 51 | * Name of the property which should be used to override the default download url for the wrapper. 52 | */ 53 | private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl"; 54 | 55 | public static void main(String args[]) { 56 | System.out.println("- Downloader started"); 57 | File baseDirectory = new File(args[0]); 58 | System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath()); 59 | 60 | // If the maven-wrapper.properties exists, read it and check if it contains a custom 61 | // wrapperUrl parameter. 62 | File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH); 63 | String url = DEFAULT_DOWNLOAD_URL; 64 | if(mavenWrapperPropertyFile.exists()) { 65 | FileInputStream mavenWrapperPropertyFileInputStream = null; 66 | try { 67 | mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile); 68 | Properties mavenWrapperProperties = new Properties(); 69 | mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream); 70 | url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url); 71 | } catch (IOException e) { 72 | System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'"); 73 | } finally { 74 | try { 75 | if(mavenWrapperPropertyFileInputStream != null) { 76 | mavenWrapperPropertyFileInputStream.close(); 77 | } 78 | } catch (IOException e) { 79 | // Ignore ... 80 | } 81 | } 82 | } 83 | System.out.println("- Downloading from: : " + url); 84 | 85 | File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH); 86 | if(!outputFile.getParentFile().exists()) { 87 | if(!outputFile.getParentFile().mkdirs()) { 88 | System.out.println( 89 | "- ERROR creating output direcrory '" + outputFile.getParentFile().getAbsolutePath() + "'"); 90 | } 91 | } 92 | System.out.println("- Downloading to: " + outputFile.getAbsolutePath()); 93 | try { 94 | downloadFileFromURL(url, outputFile); 95 | System.out.println("Done"); 96 | System.exit(0); 97 | } catch (Throwable e) { 98 | System.out.println("- Error downloading"); 99 | e.printStackTrace(); 100 | System.exit(1); 101 | } 102 | } 103 | 104 | private static void downloadFileFromURL(String urlString, File destination) throws Exception { 105 | URL website = new URL(urlString); 106 | ReadableByteChannel rbc; 107 | rbc = Channels.newChannel(website.openStream()); 108 | FileOutputStream fos = new FileOutputStream(destination); 109 | fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE); 110 | fos.close(); 111 | rbc.close(); 112 | } 113 | 114 | } 115 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.0/apache-maven-3.6.0-bin.zip 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring Data Elasticsearch Example with Spring Boot 3 and ElasticSearch 8 2 | 3 | ## Introduction 4 | 5 | This example demonstrates how to use Spring Data Elasticsearch to do simple CRUD operations. 6 | 7 | You can find the tutorial about this example at this link: [Getting started with Spring Data Elasticsearch](https://www.geekyhacker.com/getting-started-with-spring-data-elasticsearch/) 8 | 9 | For this example, we created a Book controller that allows doing the following operations with Elasticsearch: 10 | 11 | - Get the list of all books 12 | - Create a book 13 | - Update a book by Id 14 | - Delete a book by Id 15 | - Search for a book by ISBN 16 | - Fuzzy search for books by author and title 17 | 18 | ## How to run 19 | 20 | ### Spring Boot 3.1 21 | 22 | Since this project uses Spring Boot 3.1, all you need to do is to run the application: 23 | 24 | ```bash 25 | $ ./mvnw spring-boot:run 26 | ``` 27 | 28 | Spring Boot automatically detects the `docker-compose` file and starts the Elasticsearch container. 29 | 30 | ### Spring Boot 3.0 and prior 31 | 32 | The older version of this project uses Spring Boot 3.0 which does not have Spring Boot Docker Compose integration. 33 | 34 | To run an older version of the application, the first thing to do is to start Elasticsearch. For that, you can use the `docker-compose` file in this project and run it like this: 35 | 36 | ```bash 37 | $ docker-compose -f docker-compose up -d 38 | ``` 39 | 40 | It brings Elasticsearch up on a single node cluster with the cluster name `elasticsearch`. 41 | 42 | Then you can run the application like below: 43 | 44 | ```bash 45 | $ ./mvnw spring-boot:run 46 | ``` 47 | 48 | If your Elasticsearch URI is not `localhost` is different simply override the following environment variable: 49 | 50 | - `ES_URI` 51 | 52 | Once everything is up and running open the browser and go to [http://localhost:8080](http://localhost:8080). You should see Swagger to interact with. 53 | 54 | ## Run Testcontainers tests 55 | 56 | The integration tests are written relying on [Testcontainers](https://www.testcontainers.org/) to spin up Elasticsearch on the spot and run tests against it. 57 | To know more about container testing read this tutorial: [Integration test with Testcontainers in Java](https://www.geekyhacker.com/integration-test-with-testcontainers-in-java/) 58 | 59 | To run the integration test (using Testcontainers) just run the below command: 60 | 61 | ```bash 62 | $ mvn clean verify 63 | ``` 64 | 65 | Make sure you have your docker running. 66 | -------------------------------------------------------------------------------- /docker-compose-fix-port.yml: -------------------------------------------------------------------------------- 1 | services: 2 | elasticsearch: 3 | image: elasticsearch:8.11.3 4 | container_name: elasticsearch 5 | ports: 6 | - "9200:9200" 7 | environment: 8 | - discovery.type=single-node 9 | - cluster.name=elasticsearch 10 | # Since ES 8, SSL is on by default, disabling on local 11 | - xpack.security.enabled=false -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | elasticsearch: 3 | image: elasticsearch:8.11.3 4 | container_name: elasticsearch 5 | ports: 6 | # Map the 9200 port to a random port on host 7 | - "9200" 8 | environment: 9 | - discovery.type=single-node 10 | - cluster.name=elasticsearch 11 | # Since ES 8, SSL is on by default, disabling on local 12 | - xpack.security.enabled=false -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Mingw, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | # TODO classpath? 118 | fi 119 | 120 | if [ -z "$JAVA_HOME" ]; then 121 | javaExecutable="`which javac`" 122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 123 | # readlink(1) is not available as standard on Solaris 10. 124 | readLink=`which readlink` 125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 126 | if $darwin ; then 127 | javaHome="`dirname \"$javaExecutable\"`" 128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 129 | else 130 | javaExecutable="`readlink -f \"$javaExecutable\"`" 131 | fi 132 | javaHome="`dirname \"$javaExecutable\"`" 133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 134 | JAVA_HOME="$javaHome" 135 | export JAVA_HOME 136 | fi 137 | fi 138 | fi 139 | 140 | if [ -z "$JAVACMD" ] ; then 141 | if [ -n "$JAVA_HOME" ] ; then 142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 143 | # IBM's JDK on AIX uses strange locations for the executables 144 | JAVACMD="$JAVA_HOME/jre/sh/java" 145 | else 146 | JAVACMD="$JAVA_HOME/bin/java" 147 | fi 148 | else 149 | JAVACMD="`which java`" 150 | fi 151 | fi 152 | 153 | if [ ! -x "$JAVACMD" ] ; then 154 | echo "Error: JAVA_HOME is not defined correctly." >&2 155 | echo " We cannot execute $JAVACMD" >&2 156 | exit 1 157 | fi 158 | 159 | if [ -z "$JAVA_HOME" ] ; then 160 | echo "Warning: JAVA_HOME environment variable is not set." 161 | fi 162 | 163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 164 | 165 | # traverses directory structure from process work directory to filesystem root 166 | # first directory with .mvn subdirectory is considered project base directory 167 | find_maven_basedir() { 168 | 169 | if [ -z "$1" ] 170 | then 171 | echo "Path not specified to find_maven_basedir" 172 | return 1 173 | fi 174 | 175 | basedir="$1" 176 | wdir="$1" 177 | while [ "$wdir" != '/' ] ; do 178 | if [ -d "$wdir"/.mvn ] ; then 179 | basedir=$wdir 180 | break 181 | fi 182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 183 | if [ -d "${wdir}" ]; then 184 | wdir=`cd "$wdir/.."; pwd` 185 | fi 186 | # end of workaround 187 | done 188 | echo "${basedir}" 189 | } 190 | 191 | # concatenates all lines of a file 192 | concat_lines() { 193 | if [ -f "$1" ]; then 194 | echo "$(tr -s '\n' ' ' < "$1")" 195 | fi 196 | } 197 | 198 | BASE_DIR=`find_maven_basedir "$(pwd)"` 199 | if [ -z "$BASE_DIR" ]; then 200 | exit 1; 201 | fi 202 | 203 | ########################################################################################## 204 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 205 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 206 | ########################################################################################## 207 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 208 | if [ "$MVNW_VERBOSE" = true ]; then 209 | echo "Found .mvn/wrapper/maven-wrapper.jar" 210 | fi 211 | else 212 | if [ "$MVNW_VERBOSE" = true ]; then 213 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 214 | fi 215 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 216 | while IFS="=" read key value; do 217 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 218 | esac 219 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Downloading from: $jarUrl" 222 | fi 223 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 224 | 225 | if command -v wget > /dev/null; then 226 | if [ "$MVNW_VERBOSE" = true ]; then 227 | echo "Found wget ... using wget" 228 | fi 229 | wget "$jarUrl" -O "$wrapperJarPath" 230 | elif command -v curl > /dev/null; then 231 | if [ "$MVNW_VERBOSE" = true ]; then 232 | echo "Found curl ... using curl" 233 | fi 234 | curl -o "$wrapperJarPath" "$jarUrl" 235 | else 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Falling back to using Java to download" 238 | fi 239 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 240 | if [ -e "$javaClass" ]; then 241 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 242 | if [ "$MVNW_VERBOSE" = true ]; then 243 | echo " - Compiling MavenWrapperDownloader.java ..." 244 | fi 245 | # Compiling the Java class 246 | ("$JAVA_HOME/bin/javac" "$javaClass") 247 | fi 248 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 249 | # Running the downloader 250 | if [ "$MVNW_VERBOSE" = true ]; then 251 | echo " - Running MavenWrapperDownloader.java ..." 252 | fi 253 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 254 | fi 255 | fi 256 | fi 257 | fi 258 | ########################################################################################## 259 | # End of extension 260 | ########################################################################################## 261 | 262 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 263 | if [ "$MVNW_VERBOSE" = true ]; then 264 | echo $MAVEN_PROJECTBASEDIR 265 | fi 266 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 267 | 268 | # For Cygwin, switch paths to Windows format before running java 269 | if $cygwin; then 270 | [ -n "$M2_HOME" ] && 271 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 272 | [ -n "$JAVA_HOME" ] && 273 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 274 | [ -n "$CLASSPATH" ] && 275 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 276 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 277 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 278 | fi 279 | 280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 281 | 282 | exec "$JAVACMD" \ 283 | $MAVEN_OPTS \ 284 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 285 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 286 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 287 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 124 | FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO ( 125 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | echo Found %WRAPPER_JAR% 132 | ) else ( 133 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 134 | echo Downloading from: %DOWNLOAD_URL% 135 | powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')" 136 | echo Finished downloading %WRAPPER_JAR% 137 | ) 138 | @REM End of extension 139 | 140 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 141 | if ERRORLEVEL 1 goto error 142 | goto end 143 | 144 | :error 145 | set ERROR_CODE=1 146 | 147 | :end 148 | @endlocal & set ERROR_CODE=%ERROR_CODE% 149 | 150 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 151 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 152 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 153 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 154 | :skipRcPost 155 | 156 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 157 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 158 | 159 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 160 | 161 | exit /B %ERROR_CODE% 162 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 3.2.1 9 | 10 | com.madadipouya.elasticsearch.springdata.example 11 | elasticsearch-springdata 12 | 0.0.2 13 | Elasticsearch SpringData 14 | Elasticsearch SpringData 15 | 16 | 17 | 17 18 | 5.8.0 19 | 1.19.3 20 | 21 | 22 | 23 | 24 | org.springframework.boot 25 | spring-boot-starter-data-elasticsearch 26 | 27 | 28 | org.springframework.boot 29 | spring-boot-starter-web 30 | 31 | 32 | org.springframework.boot 33 | spring-boot-starter-actuator 34 | 35 | 36 | org.springdoc 37 | springdoc-openapi-starter-webmvc-ui 38 | 2.3.0 39 | 40 | 41 | org.springframework.boot 42 | spring-boot-docker-compose 43 | true 44 | 45 | 46 | org.springframework.boot 47 | spring-boot-starter-test 48 | test 49 | 50 | 51 | org.junit.jupiter 52 | junit-jupiter-engine 53 | 5.10.1 54 | test 55 | 56 | 57 | org.mockito 58 | mockito-core 59 | ${mockito.version} 60 | test 61 | 62 | 63 | org.mockito 64 | mockito-junit-jupiter 65 | ${mockito.version} 66 | test 67 | 68 | 69 | org.testcontainers 70 | testcontainers 71 | ${testcontainers.version} 72 | test 73 | 74 | 75 | org.testcontainers 76 | junit-jupiter 77 | ${testcontainers.version} 78 | test 79 | 80 | 81 | org.testcontainers 82 | elasticsearch 83 | ${testcontainers.version} 84 | test 85 | 86 | 87 | 88 | 89 | 90 | org.springframework.boot 91 | spring-boot-maven-plugin 92 | 93 | 94 | org.apache.maven.plugins 95 | maven-surefire-plugin 96 | 3.2.3 97 | 98 | 99 | org.apache.maven.plugins 100 | maven-failsafe-plugin 101 | 3.2.3 102 | 103 | false 104 | 3 105 | 106 | **/*IT.java 107 | 108 | 109 | 110 | 111 | 112 | integration-test 113 | verify 114 | 115 | 116 | 117 | 118 | 119 | 120 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/Application.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class Application { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(Application.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/config/SwaggerConfig.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.config; 2 | 3 | import org.springframework.context.annotation.Bean; 4 | import org.springframework.context.annotation.Configuration; 5 | 6 | import io.swagger.v3.oas.models.OpenAPI; 7 | import io.swagger.v3.oas.models.info.Contact; 8 | import io.swagger.v3.oas.models.info.Info; 9 | import io.swagger.v3.oas.models.info.License; 10 | 11 | @Configuration 12 | public class SwaggerConfig { 13 | 14 | @Bean 15 | public OpenAPI apiInfo() { 16 | return new OpenAPI().info(new Info().title("Spring Data Elasticsearch example") 17 | .description("Spring Data Elasticsearch example with Testcontainers") 18 | .version("v0.0.2") 19 | .contact(getContactDetails()) 20 | .license(getLicenseDetails())); 21 | } 22 | 23 | private Contact getContactDetails() { 24 | return new Contact().name("Kasra Madadipouya") 25 | .email("kasra@madadipouya.com") 26 | .url("https://geekyhacker.com"); 27 | } 28 | 29 | private License getLicenseDetails() { 30 | return new License().name("GNU General Public License v3.0") 31 | .url("https://github.com/kasramp/Spring-Data-ElasticSearch-Example/blob/master/LICENSE"); 32 | } 33 | } -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/controller/BookController.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.controller; 2 | 3 | import com.madadipouya.elasticsearch.springdata.example.metadata.PublicationYear; 4 | import com.madadipouya.elasticsearch.springdata.example.service.exception.BookNotFoundException; 5 | import com.madadipouya.elasticsearch.springdata.example.model.Book; 6 | import com.madadipouya.elasticsearch.springdata.example.service.BookService; 7 | import com.madadipouya.elasticsearch.springdata.example.service.exception.DuplicateIsbnException; 8 | import org.springframework.http.HttpStatus; 9 | import org.springframework.web.bind.annotation.*; 10 | 11 | import jakarta.validation.Valid; 12 | import jakarta.validation.constraints.NotBlank; 13 | import jakarta.validation.constraints.Positive; 14 | import java.util.List; 15 | 16 | @RestController 17 | @RequestMapping("/v1/books") 18 | public class BookController { 19 | 20 | private final BookService bookService; 21 | 22 | public BookController(BookService bookService) { 23 | this.bookService = bookService; 24 | } 25 | 26 | @ResponseStatus(HttpStatus.OK) 27 | @GetMapping 28 | public List getAllBooks() { 29 | return bookService.getAll(); 30 | } 31 | 32 | @ResponseStatus(HttpStatus.ACCEPTED) 33 | @PostMapping 34 | public Book createBook(@Valid @RequestBody BookDto book) throws DuplicateIsbnException { 35 | return bookService.create(BookDto.transform(book)); 36 | } 37 | 38 | @ResponseStatus(HttpStatus.OK) 39 | @GetMapping(value = "/{isbn}") 40 | public Book getBookByIsbn(@PathVariable String isbn) throws BookNotFoundException { 41 | return bookService.getByIsbn(isbn).orElseThrow(() -> new BookNotFoundException("The given isbn is invalid")); 42 | } 43 | 44 | @ResponseStatus(HttpStatus.OK) 45 | @GetMapping(value = "/query") 46 | public List getBooksByAuthorAndTitle(@RequestParam(value = "title") String title, @RequestParam(value = "author") String author) { 47 | return bookService.findByTitleAndAuthor(title, author); 48 | } 49 | 50 | @ResponseStatus(HttpStatus.OK) 51 | @PutMapping(value = "/{id}") 52 | public Book updateBook(@PathVariable String id, @RequestBody BookDto book) throws BookNotFoundException { 53 | return bookService.update(id, BookDto.transform(book)); 54 | } 55 | 56 | @ResponseStatus(HttpStatus.NO_CONTENT) 57 | @DeleteMapping(value = "/{id}") 58 | public void deleteBook(@PathVariable String id) { 59 | bookService.deleteById(id); 60 | } 61 | 62 | public static class BookDto { 63 | 64 | @NotBlank 65 | private String title; 66 | 67 | @Positive 68 | @PublicationYear 69 | private Integer publicationYear; 70 | 71 | @NotBlank 72 | private String authorName; 73 | 74 | @NotBlank 75 | private String isbn; 76 | 77 | static Book transform(BookDto bookDto) { 78 | Book book = new Book(); 79 | book.setTitle(bookDto.title); 80 | book.setPublicationYear(bookDto.publicationYear); 81 | book.setAuthorName(bookDto.authorName); 82 | book.setIsbn(bookDto.isbn); 83 | return book; 84 | } 85 | 86 | public String getTitle() { 87 | return title; 88 | } 89 | 90 | public void setTitle(String title) { 91 | this.title = title; 92 | } 93 | 94 | public Integer getPublicationYear() { 95 | return publicationYear; 96 | } 97 | 98 | public void setPublicationYear(Integer publicationYear) { 99 | this.publicationYear = publicationYear; 100 | } 101 | 102 | public String getAuthorName() { 103 | return authorName; 104 | } 105 | 106 | public void setAuthorName(String authorName) { 107 | this.authorName = authorName; 108 | } 109 | 110 | public String getIsbn() { 111 | return isbn; 112 | } 113 | 114 | public void setIsbn(String isbn) { 115 | this.isbn = isbn; 116 | } 117 | } 118 | } 119 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/controller/Redirect.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.controller; 2 | 3 | import org.springframework.web.bind.annotation.GetMapping; 4 | import org.springframework.web.bind.annotation.RestController; 5 | import org.springframework.web.servlet.ModelAndView; 6 | 7 | @RestController 8 | public class Redirect { 9 | 10 | @GetMapping(value = "/") 11 | public ModelAndView redirectToDocPage() { 12 | return new ModelAndView("redirect:/swagger-ui/index.html"); 13 | } 14 | 15 | @GetMapping(value = "/apidocs") 16 | public ModelAndView redirectToApiPage() { 17 | return new ModelAndView("redirect:/swagger-ui/index.html"); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/controller/exception/handler/BookControllerExceptionHandler.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.controller.exception.handler; 2 | 3 | import com.madadipouya.elasticsearch.springdata.example.service.exception.BookNotFoundException; 4 | import com.madadipouya.elasticsearch.springdata.example.service.exception.DuplicateIsbnException; 5 | import org.springframework.http.HttpStatus; 6 | import org.springframework.http.ResponseEntity; 7 | import org.springframework.web.bind.annotation.ExceptionHandler; 8 | import org.springframework.web.bind.annotation.RestControllerAdvice; 9 | 10 | 11 | @RestControllerAdvice 12 | public class BookControllerExceptionHandler { 13 | 14 | @ExceptionHandler(value = {BookNotFoundException.class, DuplicateIsbnException.class}) 15 | public ResponseEntity doHandleBookExceptions(Exception ex) { 16 | return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(new Body(ex.getMessage())); 17 | } 18 | 19 | public static class Body { 20 | 21 | private String message; 22 | 23 | public Body(String message) { 24 | this.message = message; 25 | } 26 | 27 | public String getMessage() { 28 | return message; 29 | } 30 | 31 | public void setMessage(String message) { 32 | this.message = message; 33 | } 34 | } 35 | } -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/metadata/PublicationYear.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.metadata; 2 | 3 | import com.madadipouya.elasticsearch.springdata.example.validator.PublicationYearValidator; 4 | 5 | import jakarta.validation.Constraint; 6 | import jakarta.validation.Payload; 7 | import java.lang.annotation.Documented; 8 | import java.lang.annotation.Retention; 9 | import java.lang.annotation.Target; 10 | 11 | import static java.lang.annotation.ElementType.*; 12 | import static java.lang.annotation.RetentionPolicy.RUNTIME; 13 | 14 | 15 | @Documented 16 | @Retention(RUNTIME) 17 | @Target({FIELD, ANNOTATION_TYPE, PARAMETER}) 18 | @Constraint(validatedBy = PublicationYearValidator.class) 19 | public @interface PublicationYear { 20 | 21 | String message() default "Publication year cannot be future year"; 22 | 23 | Class[] groups() default {}; 24 | 25 | Class[] payload() default {}; 26 | } -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/model/Book.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.model; 2 | 3 | import org.springframework.data.annotation.Id; 4 | import org.springframework.data.elasticsearch.annotations.Document; 5 | 6 | @Document(indexName = "books") 7 | public class Book { 8 | 9 | @Id 10 | private String id; 11 | 12 | private String title; 13 | 14 | private int publicationYear; 15 | 16 | private String authorName; 17 | 18 | private String isbn; 19 | 20 | public String getId() { 21 | return id; 22 | } 23 | 24 | public String getTitle() { 25 | return title; 26 | } 27 | 28 | public void setTitle(String title) { 29 | this.title = title; 30 | } 31 | 32 | public int getPublicationYear() { 33 | return publicationYear; 34 | } 35 | 36 | public void setPublicationYear(int publicationYear) { 37 | this.publicationYear = publicationYear; 38 | } 39 | 40 | public String getAuthorName() { 41 | return authorName; 42 | } 43 | 44 | public void setAuthorName(String authorName) { 45 | this.authorName = authorName; 46 | } 47 | 48 | public String getIsbn() { 49 | return isbn; 50 | } 51 | 52 | public void setIsbn(String isbn) { 53 | this.isbn = isbn; 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/repository/BookRepository.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.repository; 2 | 3 | import com.madadipouya.elasticsearch.springdata.example.model.Book; 4 | 5 | import org.springframework.data.elasticsearch.repository.ElasticsearchRepository; 6 | import org.springframework.stereotype.Repository; 7 | 8 | import java.util.List; 9 | import java.util.Optional; 10 | 11 | @Repository 12 | public interface BookRepository extends ElasticsearchRepository { 13 | 14 | List findByAuthorName(String authorName); 15 | 16 | Optional findByIsbn(String isbn); 17 | } -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/service/BookService.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.service; 2 | 3 | import com.madadipouya.elasticsearch.springdata.example.model.Book; 4 | import com.madadipouya.elasticsearch.springdata.example.service.exception.BookNotFoundException; 5 | import com.madadipouya.elasticsearch.springdata.example.service.exception.DuplicateIsbnException; 6 | 7 | import java.util.List; 8 | import java.util.Optional; 9 | 10 | public interface BookService { 11 | 12 | Optional getByIsbn(String isbn); 13 | 14 | List getAll(); 15 | 16 | List findByAuthor(String authorName); 17 | 18 | List findByTitleAndAuthor(String title, String author); 19 | 20 | Book create(Book book) throws DuplicateIsbnException; 21 | 22 | void deleteById(String id); 23 | 24 | Book update(String id, Book book) throws BookNotFoundException; 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/service/exception/BookNotFoundException.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.service.exception; 2 | 3 | public class BookNotFoundException extends Exception { 4 | 5 | public BookNotFoundException(String message) { 6 | super(message); 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/service/exception/DuplicateIsbnException.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.service.exception; 2 | 3 | public class DuplicateIsbnException extends Exception { 4 | 5 | public DuplicateIsbnException(String message) { 6 | super(message); 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/service/impl/DefaultBookService.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.service.impl; 2 | 3 | import static co.elastic.clients.elasticsearch._types.query_dsl.QueryBuilders.match; 4 | 5 | import java.util.ArrayList; 6 | import java.util.List; 7 | import java.util.Optional; 8 | 9 | import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate; 10 | import org.springframework.data.elasticsearch.client.elc.NativeQuery; 11 | import org.springframework.data.elasticsearch.core.SearchHit; 12 | import org.springframework.stereotype.Service; 13 | 14 | import com.madadipouya.elasticsearch.springdata.example.model.Book; 15 | import com.madadipouya.elasticsearch.springdata.example.repository.BookRepository; 16 | import com.madadipouya.elasticsearch.springdata.example.service.BookService; 17 | import com.madadipouya.elasticsearch.springdata.example.service.exception.BookNotFoundException; 18 | import com.madadipouya.elasticsearch.springdata.example.service.exception.DuplicateIsbnException; 19 | 20 | import co.elastic.clients.elasticsearch._types.query_dsl.QueryBuilders; 21 | 22 | @Service 23 | public class DefaultBookService implements BookService { 24 | 25 | private final BookRepository bookRepository; 26 | 27 | private final ElasticsearchTemplate elasticsearchTemplate; 28 | 29 | public DefaultBookService(BookRepository bookRepository, ElasticsearchTemplate elasticsearchTemplate) { 30 | this.bookRepository = bookRepository; 31 | this.elasticsearchTemplate = elasticsearchTemplate; 32 | } 33 | 34 | @Override 35 | public Optional getByIsbn(String isbn) { 36 | return bookRepository.findByIsbn(isbn); 37 | } 38 | 39 | @Override 40 | public List getAll() { 41 | List books = new ArrayList<>(); 42 | bookRepository.findAll() 43 | .forEach(books::add); 44 | return books; 45 | } 46 | 47 | @Override 48 | public List findByAuthor(String authorName) { 49 | return bookRepository.findByAuthorName(authorName); 50 | } 51 | 52 | @Override 53 | public List findByTitleAndAuthor(String title, String author) { 54 | var criteria = QueryBuilders.bool(builder -> builder.must( 55 | match(queryAuthor -> queryAuthor.field("authorName").query(author)), 56 | match(queryTitle -> queryTitle.field("title").query(title)) 57 | )); 58 | 59 | return elasticsearchTemplate.search(NativeQuery.builder().withQuery(criteria).build(), Book.class) 60 | .stream().map(SearchHit::getContent).toList(); 61 | } 62 | 63 | @Override 64 | public Book create(Book book) throws DuplicateIsbnException { 65 | if (getByIsbn(book.getIsbn()).isEmpty()) { 66 | return bookRepository.save(book); 67 | } 68 | throw new DuplicateIsbnException(String.format("The provided ISBN: %s already exists. Use update instead!", book.getIsbn())); 69 | } 70 | 71 | @Override 72 | public void deleteById(String id) { 73 | bookRepository.deleteById(id); 74 | } 75 | 76 | @Override 77 | public Book update(String id, Book book) throws BookNotFoundException { 78 | Book oldBook = bookRepository.findById(id) 79 | .orElseThrow(() -> new BookNotFoundException("There is not book associated with the given id")); 80 | oldBook.setIsbn(book.getIsbn()); 81 | oldBook.setAuthorName(book.getAuthorName()); 82 | oldBook.setPublicationYear(book.getPublicationYear()); 83 | oldBook.setTitle(book.getTitle()); 84 | return bookRepository.save(oldBook); 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /src/main/java/com/madadipouya/elasticsearch/springdata/example/validator/PublicationYearValidator.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.validator; 2 | 3 | import com.madadipouya.elasticsearch.springdata.example.metadata.PublicationYear; 4 | 5 | import jakarta.validation.ConstraintValidator; 6 | import jakarta.validation.ConstraintValidatorContext; 7 | import java.time.Year; 8 | 9 | public class PublicationYearValidator implements ConstraintValidator { 10 | 11 | @Override 12 | public boolean isValid(Integer value, ConstraintValidatorContext context) { 13 | return !Year.of(value).isAfter(Year.now()); 14 | } 15 | } -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | spring.data.elasticsearch.repositories.enabled=true 2 | # comma-separated list of the Elasticsearch instances to use. 3 | # since Spring Boot 3.1 with docker-compose support, the properties override automatically 4 | # documentation: https://spring.io/blog/2023/06/21/docker-compose-support-in-spring-boot-3-1 5 | spring.elasticsearch.uris=${ES_URI:localhost}:9200 6 | 7 | management.endpoints.web.base-path=/ 8 | management.endpoints.jmx.exposure.include=* 9 | management.endpoint.health.show-details=always 10 | management.health.elasticsearch.enabled=false 11 | 12 | # custom docker compose file 13 | # spring.docker.compose.file=./docker-compose-fix-port.yml 14 | # to disable docker compose 15 | # spring.docker.compose.enabled=false 16 | -------------------------------------------------------------------------------- /src/test/java/com/madadipouya/elasticsearch/springdata/BookElasticsearchContainer.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata; 2 | 3 | import org.testcontainers.elasticsearch.ElasticsearchContainer; 4 | import org.testcontainers.utility.DockerImageName; 5 | 6 | public class BookElasticsearchContainer extends ElasticsearchContainer { 7 | 8 | private static final String ELASTIC_SEARCH_DOCKER = "elasticsearch:8.7.0"; 9 | private static final String CLUSTER_NAME = "cluster.name"; 10 | private static final String ELASTIC_SEARCH = "elasticsearch"; 11 | private static final String DISCOVERY_TYPE = "discovery.type"; 12 | private static final String DISCOVERY_TYPE_SINGLE_NODE = "single-node"; 13 | private static final String XPACK_SECURITY_ENABLED = "xpack.security.enabled"; 14 | 15 | public BookElasticsearchContainer() { 16 | super(DockerImageName.parse(ELASTIC_SEARCH_DOCKER) 17 | .asCompatibleSubstituteFor("docker.elastic.co/elasticsearch/elasticsearch")); 18 | addFixedExposedPort(9200, 9200); 19 | addEnv(DISCOVERY_TYPE, DISCOVERY_TYPE_SINGLE_NODE); 20 | addEnv(XPACK_SECURITY_ENABLED, Boolean.FALSE.toString()); 21 | addEnv(CLUSTER_NAME, ELASTIC_SEARCH); 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/test/java/com/madadipouya/elasticsearch/springdata/example/service/impl/DefaultBookServiceIT.java: -------------------------------------------------------------------------------- 1 | package com.madadipouya.elasticsearch.springdata.example.service.impl; 2 | 3 | import com.madadipouya.elasticsearch.springdata.BookElasticsearchContainer; 4 | import com.madadipouya.elasticsearch.springdata.example.model.Book; 5 | import com.madadipouya.elasticsearch.springdata.example.service.BookService; 6 | import com.madadipouya.elasticsearch.springdata.example.service.exception.BookNotFoundException; 7 | import com.madadipouya.elasticsearch.springdata.example.service.exception.DuplicateIsbnException; 8 | import org.junit.jupiter.api.AfterAll; 9 | import org.junit.jupiter.api.BeforeAll; 10 | import org.junit.jupiter.api.BeforeEach; 11 | import org.junit.jupiter.api.Test; 12 | import org.junit.jupiter.api.extension.ExtendWith; 13 | import org.springframework.beans.factory.annotation.Autowired; 14 | import org.springframework.boot.test.context.SpringBootTest; 15 | import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate; 16 | import org.springframework.test.context.junit.jupiter.SpringExtension; 17 | import org.testcontainers.elasticsearch.ElasticsearchContainer; 18 | import org.testcontainers.junit.jupiter.Container; 19 | import org.testcontainers.junit.jupiter.Testcontainers; 20 | 21 | import java.util.List; 22 | import java.util.Optional; 23 | 24 | import static org.junit.jupiter.api.Assertions.*; 25 | 26 | 27 | @Testcontainers 28 | @ExtendWith(SpringExtension.class) 29 | @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) 30 | class DefaultBookServiceIT { 31 | 32 | @Autowired 33 | private BookService bookService; 34 | 35 | @Autowired 36 | private ElasticsearchTemplate template; 37 | 38 | @Container 39 | private static final ElasticsearchContainer elasticsearchContainer = new BookElasticsearchContainer(); 40 | 41 | @BeforeAll 42 | static void setUp() { 43 | elasticsearchContainer.start(); 44 | } 45 | 46 | @BeforeEach 47 | void testIsContainerRunning() { 48 | assertTrue(elasticsearchContainer.isRunning()); 49 | recreateIndex(); 50 | } 51 | 52 | @Test 53 | void testGetBookByIsbn() throws DuplicateIsbnException { 54 | bookService.create(createBook("12 rules for life", "Jordan Peterson", 2018, "978-0345816023")); 55 | Optional result = bookService.getByIsbn("978-0345816023"); 56 | assertTrue(result.isPresent()); 57 | Book createdBook = result.get(); 58 | assertNotNull(createdBook); 59 | assertEquals("12 rules for life", createdBook.getTitle()); 60 | assertEquals("Jordan Peterson", createdBook.getAuthorName()); 61 | assertEquals(2018, createdBook.getPublicationYear()); 62 | assertEquals("978-0345816023", createdBook.getIsbn()); 63 | } 64 | 65 | @Test 66 | void testGetAllBooks() throws DuplicateIsbnException { 67 | bookService.create(createBook("12 rules for life", "Jordan Peterson", 2018, "978-0345816023")); 68 | bookService.create(createBook("The Cathedral and the Bazaar", "Eric Raymond", 1999, "9780596106386")); 69 | List books = bookService.getAll(); 70 | 71 | assertNotNull(books); 72 | assertEquals(2, books.size()); 73 | } 74 | 75 | @Test 76 | void testFindByAuthor() throws DuplicateIsbnException { 77 | bookService.create(createBook("12 rules for life", "Jordan Peterson", 2018, "978-0345816023")); 78 | bookService.create(createBook("Maps of Meaning", "Jordan Peterson", 1999, "9781280407253")); 79 | 80 | List books = bookService.findByAuthor("Jordan Peterson"); 81 | 82 | assertNotNull(books); 83 | assertEquals(2, books.size()); 84 | } 85 | 86 | @Test 87 | void testFindByTitleAndAuthor() throws DuplicateIsbnException { 88 | bookService.create(createBook("12 rules for life", "Jordan Peterson", 2018, "978-0345816023")); 89 | bookService.create(createBook("Rules or not rules?", "Jordan Miller", 2010, "978128000000")); 90 | bookService.create(createBook("Poor economy", "Jordan Miller", 2006, "9781280789000")); 91 | bookService.create(createBook("The Cathedral and the Bazaar", "Eric Raymond", 1999, "9780596106386")); 92 | 93 | List books = bookService.findByTitleAndAuthor("rules", "jordan"); 94 | 95 | assertNotNull(books); 96 | assertEquals(2, books.size()); 97 | } 98 | 99 | @Test 100 | void testCreateBook() throws DuplicateIsbnException { 101 | Book createdBook = bookService.create(createBook("12 rules for life", "Jordan Peterson", 2018, "978-0345816023")); 102 | assertNotNull(createdBook); 103 | assertNotNull(createdBook.getId()); 104 | assertEquals("12 rules for life", createdBook.getTitle()); 105 | assertEquals("Jordan Peterson", createdBook.getAuthorName()); 106 | assertEquals(2018, createdBook.getPublicationYear()); 107 | assertEquals("978-0345816023", createdBook.getIsbn()); 108 | } 109 | 110 | @Test 111 | void testCreateBookWithDuplicateISBNThrowsException() throws DuplicateIsbnException { 112 | Book createdBook = bookService.create(createBook("12 rules for life", "Jordan Peterson", 2018, "978-0345816023")); 113 | assertNotNull(createdBook); 114 | assertThrows(DuplicateIsbnException.class, () -> { 115 | bookService.create(createBook("Test title", "Test author", 2010, "978-0345816023")); 116 | }); 117 | } 118 | 119 | @Test 120 | void testDeleteBookById() throws DuplicateIsbnException { 121 | Book createdBook = bookService.create(createBook("12 rules for life", "Jordan Peterson", 2018, "978-0345816023")); 122 | 123 | assertNotNull(createdBook); 124 | assertNotNull(createdBook.getId()); 125 | 126 | bookService.deleteById(createdBook.getId()); 127 | List books = bookService.findByAuthor("Jordan Peterson"); 128 | 129 | assertTrue(books.isEmpty()); 130 | } 131 | 132 | @Test 133 | void testUpdateBook() throws DuplicateIsbnException, BookNotFoundException { 134 | Book bookToUpdate = bookService.create(createBook("12 rules for life", "Jordan Peterson", 2000, "978-0345816023")); 135 | 136 | assertNotNull(bookToUpdate); 137 | assertNotNull(bookToUpdate.getId()); 138 | 139 | bookToUpdate.setPublicationYear(2018); 140 | Book updatedBook = bookService.update(bookToUpdate.getId(), bookToUpdate); 141 | 142 | assertNotNull(updatedBook); 143 | assertNotNull(updatedBook.getId()); 144 | assertEquals("12 rules for life", updatedBook.getTitle()); 145 | assertEquals("Jordan Peterson", updatedBook.getAuthorName()); 146 | assertEquals(2018, updatedBook.getPublicationYear()); 147 | assertEquals("978-0345816023", updatedBook.getIsbn()); 148 | } 149 | 150 | @Test 151 | void testUpdateBookThrowsExceptionIfCannotFindBook() { 152 | Book updatedBook = createBook("12 rules for life", "Jordan Peterson", 2000, "978-0345816023"); 153 | 154 | assertThrows(BookNotFoundException.class, () -> { 155 | bookService.update("1A2B3C", updatedBook); 156 | }); 157 | } 158 | 159 | private Book createBook(String title, String authorName, int publicationYear, String isbn) { 160 | Book book = new Book(); 161 | book.setTitle(title); 162 | book.setAuthorName(authorName); 163 | book.setPublicationYear(publicationYear); 164 | book.setIsbn(isbn); 165 | return book; 166 | } 167 | 168 | private void recreateIndex() { 169 | if (template.indexOps(Book.class).exists()) { 170 | template.indexOps(Book.class).delete(); 171 | template.indexOps(Book.class).create(); 172 | } 173 | } 174 | 175 | @AfterAll 176 | static void destroy() { 177 | elasticsearchContainer.stop(); 178 | } 179 | } 180 | --------------------------------------------------------------------------------