├── .gitignore ├── LICENSE ├── LICENSE.txt ├── README.adoc ├── README.md ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── src └── main ├── java └── org │ └── springframework │ └── data │ └── rest │ └── shell │ ├── RestShellBannerProvider.java │ ├── RestShellPromptProvider.java │ ├── StringToMapConverter.java │ ├── commands │ ├── AuthCommands.java │ ├── ConfigurationCommands.java │ ├── ContextCommands.java │ ├── DiscoveryCommands.java │ ├── DotRcReader.java │ ├── HierarchyCommands.java │ ├── HistoryCommands.java │ ├── HttpCommands.java │ ├── Links.java │ ├── PathOrRel.java │ ├── PathOrRelConverter.java │ └── SslCommands.java │ ├── context │ ├── BaseUriChangedEvent.java │ ├── HeaderSetEvent.java │ ├── ResponseEvent.java │ └── UserConfig.java │ ├── formatter │ ├── FormatProvider.java │ ├── Formatter.java │ ├── FormatterSupport.java │ ├── JsonFormatter.java │ ├── NoOpFormatter.java │ └── XmlFormatter.java │ └── resources │ ├── PagableResources.java │ └── Page.java └── resources ├── META-INF └── spring │ └── spring-shell-plugin.xml └── logback.xml /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .gradle 3 | *.i* 4 | build 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2015-Present Pivotal Software Inc. 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | 204 | 205 | 206 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | # rest-shell is no longer actively maintained by VMware, Inc. 2 | 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring HATEOAS-compliant REST shell 2 | 3 | # Installing the binaries 4 | 5 | Using Homebrew: 6 | 7 | brew install rest-shell 8 | 9 | Download the binary .tar.gz package: 10 | 11 | [https://github.com/spring-projects/rest-shell/downloads](https://github.com/spring-projects/rest-shell/downloads) 12 | 13 | tar -zxvf rest-shell-1.2.0.RELEASE.tar.gz 14 | cd rest-shell-1.2.0.RELEASE 15 | bin/rest-shell 16 | 17 | # Building and Running 18 | 19 | git clone git://github.com/spring-projects/rest-shell.git 20 | cd rest-shell 21 | ./gradlew installApp 22 | cd build/install/rest-shell-1.2.0.RELEASE 23 | bin/rest-shell 24 | 25 | # Getting Started 26 | 27 | This project is a command-line shell that aims to make writing REST-based applications easier. It is based on [spring-shell](http://github.com/springsource/spring-shell) and integrated with [Spring HATEOAS](https://github.com/springsource/spring-hateoas) in such a way that REST resources that output JSON compliant with Spring HATEOAS can be discovered by the shell and interactions with the REST resources become much easier than by manipulating the URLs in bash using a tool like `curl`. 28 | 29 | The rest-shell provides a number of useful commands for discovering and interacting with REST resources. For example `discover` will discover what resources are available and print out an easily-readable table of rels and URIs that relate to those resources. Once these resources have been discovered, the `rel` of those URIs can be used in place of the URI itself in most operations, thus cutting down on the amount of typing needed to issue HTTP requests to your REST resources. 30 | 31 | ### Discovering resources 32 | 33 | The rest-shell is aimed at making it easier to interact with REST resources by managing the session `baseUri` much like a directory in a filesystem. Whenever resources are `discover`ed, you can then `follow` to a new baseUri, which means you can then use relative URIs. Here's an example of discovering resources, then following a link by referencing its `rel` value, and then using a relative URI to access resources under that new baseUri: 34 | 35 | http://localhost:8080:> discover 36 | rel href 37 | ======================================================== 38 | address http://localhost:8080/address 39 | family http://localhost:8080/family 40 | people http://localhost:8080/person 41 | profile http://localhost:8080/profile 42 | 43 | http://localhost:8080:> follow people 44 | http://localhost:8080/person:> list 45 | rel href 46 | =================================================== 47 | people.Person http://localhost:8080/person/1 48 | people.Person http://localhost:8080/person/2 49 | people.search http://localhost:8080/person/search 50 | 51 | http://localhost:8080/person:> get 1 52 | > GET http://localhost:8080/person/1 53 | 54 | < 200 OK 55 | < ETag: "2" 56 | < Content-Type: application/json 57 | < 58 | { 59 | "links" : [ { 60 | "rel" : "self", 61 | "href" : "http://localhost:8080/person/1" 62 | }, { 63 | "rel" : "peeps.Person.profiles", 64 | "href" : "http://localhost:8080/person/1/profiles" 65 | }, { 66 | "rel" : "peeps.Person.addresses", 67 | "href" : "http://localhost:8080/person/1/addresses" 68 | } ], 69 | "name" : "John Doe" 70 | } 71 | 72 | _NOTE: If you want tab completion of discovered rels, just use the `--rel` flag._ 73 | 74 | ### Creating new resources 75 | 76 | The rest-shell can do basic parsing of JSON data within the shell (though there are some limitations due to the nature of the command line parsing being sensitive to whitespace). This makes it easy to create new resources by including JSON data directly in the shell: 77 | 78 | http://localhost:8080/person:> post --data "{name: 'John Doe'}" 79 | > POST http://localhost:8080/person/ 80 | 81 | < 201 CREATED 82 | < Location: http://localhost:8080/person/8 83 | < Content-Length: 0 84 | < 85 | 86 | http://localhost:8080/person:> get 8 87 | > GET http://localhost:8080/person/8 88 | 89 | < 200 OK 90 | < ETag: "0" 91 | < Content-Type: application/json 92 | < 93 | { 94 | "links" : [ { 95 | "rel" : "self", 96 | "href" : "http://localhost:8080/person/8" 97 | }, { 98 | "rel" : "people.Person.addresses", 99 | "href" : "http://localhost:8080/person/8/addresses" 100 | }, { 101 | "rel" : "people.Person.profiles", 102 | "href" : "http://localhost:8080/person/8/profiles" 103 | } ], 104 | "name" : "John Doe" 105 | } 106 | 107 | If your needs of representing JSON get more complicated than what the spring-shell interface can handle, you can create a directory somewhere with `.json` files in it, one file per entitiy, and use the `--from` option to the `post` command. This will walk the directory and make a `POST` request for each `.json` file found. 108 | 109 | http://localhost:8080/person:> post --from work/people_to_load 110 | 128 items uploaded to the server using POST. 111 | http://localhost:8080/person:> 112 | 113 | You can also reference a specific file rather than an entire directory. 114 | 115 | http://localhost:8080/person:> post --from work/people_to_load/someone.json 116 | 1 items uploaded to the server using POST. 117 | http://localhost:8080/person:> 118 | 119 | ### Passing query parameters 120 | 121 | If you're calling URLs that require query parameters, you'll need to pass those as a JSON-like fragment in the `--params` parameter to the `get` and `list` commands. Here's an example of calling a URL that expects parameter input: 122 | 123 | http://localhost:8080/person:> get search/byName --params "{name: 'John Doe'}" 124 | 125 | ### Outputing results to a file 126 | 127 | It's not always desirable to output the results of an HTTP request to the screen. It's handy for debugging but sometimes you want to save the results of a request because they're not easily reproducible or any number of other equally valid reasons. All the HTTP commands take an `--output` parameter that writes the results of an HTTP operation to the given file. For example, to output the above search to a file: 128 | 129 | http://localhost:8080/person:> get search/byName --params "{name: 'John Doe'}" --output by_name.txt 130 | >> by_name.txt 131 | http://localhost:8080/person:> 132 | 133 | ### Sending complex JSON 134 | 135 | Because the `rest-shell` uses the [spring-shell](http://github.com/springsource/spring-shell) underneath, there are limitations on the format of the JSON data you can enter directly into the command line. If your JSON is too complex for the simplistic limitations of the shell `--data` parameter, you can simply load the JSON from a file or from all the files in a directory. 136 | 137 | When doing a `post` or `put`, you can optionally pass the `--from` parameter. The value of this parameter should either be a file or a directory. If the value is a directory, the shell will read each file that ends with `.json` and make a POST or PUT with the contents of that file. If the parameter is a file, then the `rest-shell` will simpy load that file and POST/PUT that data in that individual file. 138 | 139 | ### Shelling out to bash 140 | 141 | One of the nice things about spring-shell is that you can directly shell out commands to the underlying terminal shell. This is useful for doing things like load a JSON file in an editor. For instance, assume I have the Sublime Text 2 command `subl` in my path. I can then load a JSON file for editing from the rest-shell like this: 142 | 143 | http://localhost:8080/person:> ! subl test.json 144 | http://localhost:8080/person:> 145 | 146 | I then edit the file as I wish. When I'm ready to POST that data to the server, I can do so using the `--from` parameter: 147 | 148 | http://localhost:8080/person:> post --from test.json 149 | 1 items uploaded to the server using POST. 150 | http://localhost:8080/person:> 151 | 152 | ### Setting context variables 153 | 154 | Starting with rest-shell version 1.1, you can also work with context variables during your shell session. This is useful for saving settings you might reference often. The rest-shell now integrates Spring Expression Language support, so these context variables are usable in expressions within the shell. 155 | 156 | ##### Working with variables 157 | 158 | http://localhost:8080/person:> var set --name specialUri --value http://longdomainname.com/api 159 | http://localhost:8080/person:> var get --name specialUri 160 | http://longdomainname.com/api 161 | http://localhost:8080/person:> var list 162 | { 163 | "responseHeaders" : { 164 | ... HTTP headers from last request 165 | }, 166 | "responseBody" : { 167 | ... Body from the last request 168 | }, 169 | "specialUri" : "http://longdomainname.com/api", 170 | "requestUrl" : ... URL from the last request, 171 | "env" : { 172 | ... System properties and environment variables 173 | } 174 | } 175 | 176 | The variables are accessible from SpEL expressions which are valid in a number of different contexts, most importantly in the `path` argument to the HTTP and discover commands, and in the `data` argument to the `put` and `post` commands. 177 | 178 | Since the rest-shell is aware of environment variables and system properties, you can incorporate external parameters into your interaction with the shell. For example, to externally define a baseUri, you could set a system property before invoking the shell. The shell will incorporate anything defined in the `JAVA_OPTS` environment variable, so you could parameterize your interaction with a REST service. 179 | 180 | JAVA_OPTS="-DbaseUri=http://mylongdomain.com/api" rest-shell 181 | 182 | http://localhost:8080:> discover #{env.baseUri} 183 | rel href 184 | ================================================================= 185 | ... resources for this URL 186 | http://mylongdomain.com/api:> 187 | 188 | ### Per-user shell initialization 189 | 190 | The rest-shell supports a "dotrc" type of initialization by reading in all files found in the `$HOME/.rest-shell/` directory and assuming they have shell commands in them. The rest-shell will execute these commands on startup. This makes it easy to set variables for commonly-used URIs or possibly set a `baseUri`. 191 | 192 | echo "var set --name svcuri --value http://api.myservice.com/v1" > ~/.rest-shell/00-vars 193 | echo "discover #{svcuri}" > ~/.rest-shell/01-baseUri 194 | 195 | > rest-shell 196 | 197 | INFO: No resources found... 198 | INFO: Base URI set to 'http://api.myservice.com/v1' 199 | 200 | ___ ___ __ _____ __ _ _ _ _ __ 201 | | _ \ __/' _/_ _/' _/| || | / / | \ \ 202 | | v / _|`._`. | | `._`.| >< | / / / > > 203 | |_|_\___|___/ |_| |___/|_||_| |_/_/ /_/ 204 | 1.2.0.RELEASE 205 | 206 | Welcome to the REST shell. For assistance hit TAB or type "help". 207 | http://api.myservice.com/v1:> 208 | 209 | ### SSL Certificate Validation 210 | 211 | If you generate a self-signed certificate for your server, by default the rest-shell will complain and refuse to connect. This is the default behavior of RestTemplate. To turn off certificate and hostname checking, use the `ssl validate --enabled false` command. 212 | 213 | ### HTTP Basic authentication 214 | 215 | There is also a convenience command for setting an HTTP Basic authentication header. Use `auth basic --username user --password passwd` to set a username and password to base64 encode and place into the Authorization header that will be part of the current session's headers. 216 | 217 | You can clear the authentication by using the `auth clear` command or by removing the Authorization header using the `headers clear` command. 218 | 219 | ### Commands 220 | 221 | The rest-shell provides the following commands: 222 | 223 | * `discover` - Find out what resources are available at the given URI. If no URI is given, use the baseUri. 224 | * `follow` - Set the baseUri to the URI assigned to this given `rel` but do not discover resources. 225 | * `list` - Discover the resources available at the current baseUri. 226 | * `baseUri` - Set the base URI used for this point forward in the session. Relative URIs will be calculated relative to this setting. 227 | * `headers set` - Set an HTTP header by passing this command a `--name` and `--value` parameter. 228 | * `headers clear` - Clear all HTTP headers set in this session. 229 | * `headers list` - Print out the currently-set HTTP headers for this session. 230 | * `history list` - List the URIs previously set as baseUris during this session. 231 | * `history go` - Jump to a URI by pulling one from the history. 232 | * `var clear` - Clear this shell's variable context. 233 | * `var get` - Get a variable in this shell's context. 234 | * `var list` - List variables currently set in this shell's context. 235 | * `var set` - Set a variable in this shell's context. 236 | * `up` - Traverse one level up in the URL hierarchy. 237 | * `get` - HTTP GET from the given path. 238 | * `post` - HTTP POST to the given path, passing JSON given in the `--data` parameter. 239 | * `put` - HTTP PUT to the given path, passing JSON given in the `--data` parameter. 240 | * `delete` - HTTP DELETE to the given path. 241 | * `auth basic` - Set an HTTP Basic authentication token for use in this session. 242 | * `auth clear` - Clear the Authorization header currently in use. 243 | * `ssl validate` - Disable certificate checking to work with self-signed certificates. 244 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: "java" 2 | apply plugin: "idea" 3 | apply plugin: "eclipse" 4 | apply plugin: "maven" 5 | apply plugin: "application" 6 | 7 | // Library versions 8 | ext { 9 | slf4jVersion = "1.7.2" 10 | logbackVersion = "1.0.9" 11 | 12 | springVersion = "3.2.2.RELEASE" 13 | springShellVersion = "1.1.0.RELEASE" 14 | hateoasVersion = "0.4.0.RELEASE" 15 | jacksonVersion = "1.9.12" 16 | 17 | junitVersion = "4.11" 18 | } 19 | 20 | installApp { 21 | into "build/install/rest-shell-$version" 22 | } 23 | 24 | group = "org.springframework.data.rest.shell" 25 | mainClassName = "org.springframework.shell.Bootstrap" 26 | 27 | // Build Configuration 28 | configurations.all { 29 | exclude group: "commons-logging" 30 | //exclude module: "slf4j-log4j12" 31 | } 32 | configurations { 33 | compile.extendsFrom providedCompile 34 | } 35 | [compileJava, compileTestJava]*.options*.compilerArgs = ["-Xlint:none"] 36 | project.sourceCompatibility = 1.6 37 | project.targetCompatibility = 1.6 38 | 39 | // Repositories 40 | repositories { 41 | //maven { url "http://repo.springsource.org/libs-snapshot" } 42 | //maven { url "http://repo.springsource.org/libs-milestone" } 43 | maven { url "http://repo.springsource.org/libs-release" } 44 | maven { url "http://spring-roo-repository.springsource.org/release" } 45 | mavenLocal() 46 | } 47 | 48 | // Artifact Configuration 49 | javadoc { 50 | options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED 51 | options.author = true 52 | options.header = name 53 | //options.overview = "${projectDir}/src/main/java/overview.html" 54 | } 55 | task sourcesJar(type: Jar, dependsOn: classes) { 56 | classifier = "sources" 57 | from sourceSets.main.allJava 58 | } 59 | task javadocJar(type: Jar) { 60 | classifier = "javadoc" 61 | from javadoc 62 | } 63 | artifacts { 64 | archives sourcesJar 65 | archives javadocJar 66 | } 67 | 68 | // Dependencies 69 | dependencies { 70 | 71 | // Logging 72 | compile "org.slf4j:slf4j-api:$slf4jVersion" 73 | runtime "org.slf4j:jcl-over-slf4j:$slf4jVersion" 74 | runtime "ch.qos.logback:logback-classic:$logbackVersion" 75 | 76 | // Spring 77 | compile("org.springframework:spring-aop:$springVersion") { force = true } 78 | compile("org.springframework:spring-beans:$springVersion") { force = true } 79 | compile("org.springframework:spring-context:$springVersion") { force = true } 80 | compile("org.springframework:spring-context-support:$springVersion") { force = true } 81 | compile("org.springframework:spring-core:$springVersion") { force = true } 82 | compile("org.springframework:spring-web:$springVersion") { force = true } 83 | compile("org.springframework:spring-webmvc:$springVersion") { force = true } 84 | 85 | // Spring HATEOAS 86 | compile "org.springframework.hateoas:spring-hateoas:$hateoasVersion" 87 | 88 | // Spring Shell 89 | compile "org.springframework.shell:spring-shell:$springShellVersion" 90 | 91 | // Jackson JSON 92 | compile "org.codehaus.jackson:jackson-mapper-asl:$jacksonVersion" 93 | 94 | // Commons 95 | compile "commons-codec:commons-codec:1.7" 96 | // TODO Add multipart upload support 97 | //compile "commons-fileupload:commons-fileupload:1.2.2" 98 | 99 | // Testing 100 | testCompile "junit:junit:$junitVersion" 101 | testCompile "org.hamcrest:hamcrest-library:1.3" 102 | testCompile("org.springframework:spring-test:$springVersion") { force = true } 103 | testRuntime("org.springframework:spring-context-support:$springVersion") { force = true } 104 | } 105 | 106 | // Gradle Wrapper 107 | task wrapper(type: Wrapper) { gradleVersion = "1.3" } 108 | 109 | task shell(type: JavaExec) { 110 | classpath = configurations.runtime 111 | main = "org.springframework.shell.Bootstrap" 112 | } 113 | 114 | // IDEA project configuration 115 | idea { 116 | module { 117 | downloadJavadoc = false 118 | downloadSources = true 119 | } 120 | project { 121 | languageLevel = "1.6" 122 | ipr { 123 | withXml { xml -> 124 | xml.node.component.find { it.@name == "VcsDirectoryMappings" }.mapping.@vcs = "Git" 125 | xml.node.component.find { it.@name == "ProjectRootManager" }.output.@url = "file://\$PROJECT_DIR\$/build" 126 | } 127 | } 128 | } 129 | } 130 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | version = 1.2.2.RELEASE 2 | 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/spring-attic/rest-shell/825ccbaa9130815ebdead83b20bf0fa66f922b0c/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Wed Dec 05 13:08:13 CST 2012 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=http\://services.gradle.org/distributions/gradle-1.3-bin.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # For Cygwin, ensure paths are in UNIX format before anything is touched. 46 | if $cygwin ; then 47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 48 | fi 49 | 50 | # Attempt to set APP_HOME 51 | # Resolve links: $0 may be a link 52 | PRG="$0" 53 | # Need this for relative symlinks. 54 | while [ -h "$PRG" ] ; do 55 | ls=`ls -ld "$PRG"` 56 | link=`expr "$ls" : '.*-> \(.*\)$'` 57 | if expr "$link" : '/.*' > /dev/null; then 58 | PRG="$link" 59 | else 60 | PRG=`dirname "$PRG"`"/$link" 61 | fi 62 | done 63 | SAVED="`pwd`" 64 | cd "`dirname \"$PRG\"`/" 65 | APP_HOME="`pwd -P`" 66 | cd "$SAVED" 67 | 68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 69 | 70 | # Determine the Java command to use to start the JVM. 71 | if [ -n "$JAVA_HOME" ] ; then 72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 73 | # IBM's JDK on AIX uses strange locations for the executables 74 | JAVACMD="$JAVA_HOME/jre/sh/java" 75 | else 76 | JAVACMD="$JAVA_HOME/bin/java" 77 | fi 78 | if [ ! -x "$JAVACMD" ] ; then 79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 80 | 81 | Please set the JAVA_HOME variable in your environment to match the 82 | location of your Java installation." 83 | fi 84 | else 85 | JAVACMD="java" 86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 87 | 88 | Please set the JAVA_HOME variable in your environment to match the 89 | location of your Java installation." 90 | fi 91 | 92 | # Increase the maximum file descriptors if we can. 93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 94 | MAX_FD_LIMIT=`ulimit -H -n` 95 | if [ $? -eq 0 ] ; then 96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 97 | MAX_FD="$MAX_FD_LIMIT" 98 | fi 99 | ulimit -n $MAX_FD 100 | if [ $? -ne 0 ] ; then 101 | warn "Could not set maximum file descriptor limit: $MAX_FD" 102 | fi 103 | else 104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 105 | fi 106 | fi 107 | 108 | # For Darwin, add options to specify how the application appears in the dock 109 | if $darwin; then 110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 111 | fi 112 | 113 | # For Cygwin, switch paths to Windows format before running java 114 | if $cygwin ; then 115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/RestShellBannerProvider.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell; 2 | 3 | import org.springframework.core.annotation.Order; 4 | import org.springframework.shell.plugin.BannerProvider; 5 | import org.springframework.stereotype.Component; 6 | 7 | /** 8 | * Banner provider for the REST shell. 9 | * 10 | * @author Jon Brisbin 11 | */ 12 | @Component 13 | @Order(Integer.MIN_VALUE) 14 | public class RestShellBannerProvider implements BannerProvider { 15 | 16 | private static final String VERSION = "1.2.2"; 17 | private static final String BANNER = "\n ___ ___ __ _____ __ _ _ _ _ __ \n" + 18 | "| _ \\ __/' _/_ _/' _/| || | / / | \\ \\ \n" + 19 | "| v / _|`._`. | | `._`.| >< | / / / > > \n" + 20 | "|_|_\\___|___/ |_| |___/|_||_| |_/_/ /_/ \n"; 21 | private static final String WELCOME = "Welcome to the REST shell. For assistance hit TAB or type \"help\"."; 22 | 23 | @Override public String getBanner() { 24 | return BANNER + getVersion() + "\n"; 25 | } 26 | 27 | @Override public String getVersion() { 28 | return VERSION; 29 | } 30 | 31 | @Override public String getWelcomeMessage() { 32 | return WELCOME; 33 | } 34 | 35 | @Override public String getProviderName() { 36 | return "rest-shell"; 37 | } 38 | 39 | } 40 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/RestShellPromptProvider.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell; 2 | 3 | import org.springframework.beans.factory.annotation.Autowired; 4 | import org.springframework.core.annotation.Order; 5 | import org.springframework.data.rest.shell.commands.ConfigurationCommands; 6 | import org.springframework.data.rest.shell.commands.DotRcReader; 7 | import org.springframework.shell.plugin.PromptProvider; 8 | import org.springframework.stereotype.Component; 9 | 10 | /** 11 | * Provides the prompt for the shell, which should take the form of: 12 | *

13 | * baseUri:> (e.g. http://localhost:8080:/ >) 14 | * 15 | * @author Jon Brisbin 16 | */ 17 | @Component 18 | @Order(Integer.MIN_VALUE) 19 | public class RestShellPromptProvider implements PromptProvider { 20 | 21 | @Autowired 22 | private ConfigurationCommands configCmds; 23 | @Autowired 24 | private DotRcReader dotRcReader; 25 | private boolean readDotRc = false; 26 | 27 | @Override public String getPrompt() { 28 | if(!readDotRc) { 29 | try { 30 | dotRcReader.readDotRc(); 31 | } catch(Exception e) { 32 | throw new IllegalStateException(e); 33 | } 34 | } 35 | return configCmds.getBaseUri().toString() + ":" + "> "; 36 | } 37 | 38 | @Override public String getProviderName() { 39 | return configCmds.getBaseUri().toString(); 40 | } 41 | 42 | } 43 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/StringToMapConverter.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell; 2 | 3 | import java.io.IOException; 4 | import java.util.List; 5 | import java.util.Map; 6 | 7 | import org.codehaus.jackson.JsonParser; 8 | import org.codehaus.jackson.map.ObjectMapper; 9 | import org.springframework.shell.core.Completion; 10 | import org.springframework.shell.core.Converter; 11 | import org.springframework.shell.core.MethodTarget; 12 | import org.springframework.stereotype.Component; 13 | 14 | /** 15 | * @author Jon Brisbin 16 | */ 17 | @Component 18 | public class StringToMapConverter implements Converter { 19 | 20 | private ObjectMapper mapper = new ObjectMapper(); 21 | 22 | { 23 | mapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true); 24 | } 25 | 26 | @Override public boolean supports(Class type, 27 | String optionContext) { 28 | return Map.class.isAssignableFrom(type); 29 | } 30 | 31 | @Override public Map convertFromText(String value, 32 | Class targetType, 33 | String optionContext) { 34 | try { 35 | return (Map)mapper.readValue(value.replaceAll("\\\\", "").replaceAll("'", "\""), targetType); 36 | } catch(IOException e) { 37 | throw new IllegalArgumentException(e); 38 | } 39 | } 40 | 41 | @Override 42 | public boolean getAllPossibleValues(List completions, 43 | Class targetType, 44 | String existingData, 45 | String optionContext, 46 | MethodTarget target) { 47 | System.out 48 | .println("getAllPossibleValues: " + completions + ", ex: " + existingData + ", ctx: " + optionContext + ", tgt: " + target); 49 | return false; 50 | } 51 | 52 | } 53 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/AuthCommands.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.io.IOException; 4 | 5 | import org.apache.commons.codec.binary.Base64; 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.shell.core.CommandMarker; 8 | import org.springframework.shell.core.annotation.CliCommand; 9 | import org.springframework.shell.core.annotation.CliOption; 10 | import org.springframework.stereotype.Component; 11 | 12 | /** 13 | * Commands for managing user authentication. 14 | * 15 | * @author Jon Brisbin 16 | */ 17 | @Component 18 | public class AuthCommands implements CommandMarker { 19 | 20 | private static final String AUTHORIZATION = "Authorization"; 21 | private static final String BASIC = "Basic "; 22 | private static final String HEADER = AUTHORIZATION + ": "; 23 | 24 | @Autowired 25 | private ConfigurationCommands configCmds; 26 | 27 | /** 28 | * Set a Basic authentication header for use throughout this session. 29 | * 30 | * @param username 31 | * @param password 32 | * 33 | * @return 34 | * 35 | * @throws IOException 36 | */ 37 | @CliCommand(value = "auth basic", help = "Set the Authorization header value for Basic auth for this session.") 38 | public String basic( 39 | @CliOption( 40 | key = "username", 41 | mandatory = true, 42 | help = "The username to use") String username, 43 | @CliOption( 44 | key = "password", 45 | mandatory = true, 46 | help = "The password to use") String password) throws IOException { 47 | 48 | String token = BASIC + Base64.encodeBase64String((username + ":" + password).getBytes()); 49 | configCmds.setHeader(AUTHORIZATION, token); 50 | return HEADER + token; 51 | } 52 | 53 | @CliCommand(value = "auth clear", help = "Clear all authentication tokens for this session.") 54 | public void clear() { 55 | configCmds.getHeaders().remove(AUTHORIZATION); 56 | } 57 | 58 | } 59 | 60 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/ConfigurationCommands.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.io.IOException; 4 | import java.net.URI; 5 | import java.net.URISyntaxException; 6 | 7 | import org.codehaus.jackson.map.ObjectMapper; 8 | import org.codehaus.jackson.map.SerializationConfig; 9 | import org.springframework.beans.factory.annotation.Autowired; 10 | import org.springframework.context.ApplicationEventPublisher; 11 | import org.springframework.context.ApplicationEventPublisherAware; 12 | import org.springframework.data.rest.shell.context.BaseUriChangedEvent; 13 | import org.springframework.data.rest.shell.context.HeaderSetEvent; 14 | import org.springframework.http.HttpHeaders; 15 | import org.springframework.shell.core.CommandMarker; 16 | import org.springframework.shell.core.annotation.CliAvailabilityIndicator; 17 | import org.springframework.shell.core.annotation.CliCommand; 18 | import org.springframework.shell.core.annotation.CliOption; 19 | import org.springframework.stereotype.Component; 20 | import org.springframework.web.util.UriComponentsBuilder; 21 | 22 | /** 23 | * Configuration commands responsible for changing the settings of the session. 24 | * 25 | * @author Jon Brisbin 26 | */ 27 | @Component 28 | public class ConfigurationCommands implements CommandMarker, ApplicationEventPublisherAware { 29 | 30 | @Autowired 31 | private ContextCommands contextCmds; 32 | private URI baseUri = URI.create("http://localhost:8080"); 33 | private ApplicationEventPublisher ctx = null; 34 | private HttpHeaders headers = new HttpHeaders(); 35 | private ObjectMapper mapper = new ObjectMapper(); 36 | 37 | { 38 | mapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true); 39 | } 40 | 41 | @Override public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) { 42 | this.ctx = applicationEventPublisher; 43 | } 44 | 45 | /** 46 | * Get the current baseUri property. 47 | * 48 | * @return 49 | */ 50 | public URI getBaseUri() { 51 | return baseUri; 52 | } 53 | 54 | /** 55 | * Get the current set of HTTP headers. 56 | * 57 | * @return 58 | */ 59 | public HttpHeaders getHeaders() { 60 | return headers; 61 | } 62 | 63 | @CliAvailabilityIndicator({"baseUri", "headers list", "headers set", "headers clear"}) 64 | public boolean isBaseUriAvailable() { 65 | return true; 66 | } 67 | 68 | /** 69 | * Set the session's baseUri to use from this point forward. 70 | * 71 | * @param baseUri 72 | * Base URI to use for future relative URI calculations. 73 | * 74 | * @return 75 | * 76 | * @throws URISyntaxException 77 | */ 78 | @CliCommand(value = "baseUri", help = "Set the base URI to use from this point forward.") 79 | public String setBaseUri( 80 | @CliOption(key = "", 81 | mandatory = true, 82 | help = "The base URI to use from this point forward.", 83 | unspecifiedDefaultValue = "http://localhost:8080") String baseUri) throws URISyntaxException { 84 | if(baseUri.contains("#{")) { 85 | baseUri = contextCmds.evalAsString(baseUri); 86 | } 87 | if(baseUri.endsWith("/")) { 88 | baseUri = baseUri.substring(0, baseUri.length() - 1); 89 | } 90 | // Check whether absolute or relative URI 91 | if(baseUri.startsWith("http")) { 92 | // Absolute 93 | this.baseUri = URI.create(baseUri); 94 | } else if("/".equals(this.baseUri.getPath())) { 95 | // Relative to the root 96 | this.baseUri = UriComponentsBuilder.fromUri(this.baseUri) 97 | .path(baseUri) 98 | .build() 99 | .toUri(); 100 | } else { 101 | // Relative 102 | this.baseUri = UriComponentsBuilder.fromUri(this.baseUri) 103 | .pathSegment(baseUri) 104 | .build() 105 | .toUri(); 106 | } 107 | ctx.publishEvent(new BaseUriChangedEvent(this.baseUri)); 108 | return "Base URI set to '" + this.baseUri + "'"; 109 | } 110 | 111 | /** 112 | * Print out the current HTTP headers. 113 | * 114 | * @return 115 | * 116 | * @throws IOException 117 | */ 118 | @CliCommand(value = "headers list", help = "Print all HTTP headers in use this session.") 119 | public String headers() throws IOException { 120 | return mapper.writeValueAsString(headers.toSingleValueMap()); 121 | } 122 | 123 | /** 124 | * Set an HTTP header to use from this point forward in the session. 125 | * 126 | * @param name 127 | * Name of the HTTP header. 128 | * @param value 129 | * Value of this header. 130 | * 131 | * @return 132 | * 133 | * @throws IOException 134 | */ 135 | @CliCommand(value = "headers set", help = "Set an HTTP header for use this session.") 136 | public String setHeader( 137 | @CliOption(key = "name", 138 | mandatory = true, 139 | help = "The name of the HTTP header.") String name, 140 | @CliOption(key = "value", 141 | mandatory = true, 142 | help = "The value of the HTTP header.") String value) throws IOException { 143 | if(value.contains("#{")) { 144 | value = contextCmds.evalAsString(value); 145 | } 146 | headers.set(name, value); 147 | ctx.publishEvent(new HeaderSetEvent(name, headers)); 148 | return mapper.writeValueAsString(headers.toSingleValueMap()); 149 | } 150 | 151 | /** 152 | * Clear the HTTP headers for this session. 153 | * 154 | * @return 155 | */ 156 | @CliCommand(value = "headers clear", help = "Clear the current HTTP headers.") 157 | public String clearHeaders() { 158 | headers.clear(); 159 | return "HTTP headers cleared..."; 160 | } 161 | 162 | } 163 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/ContextCommands.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.io.IOException; 4 | import java.util.ArrayList; 5 | import java.util.HashMap; 6 | import java.util.List; 7 | import java.util.Map; 8 | 9 | import org.codehaus.jackson.map.ObjectMapper; 10 | import org.codehaus.jackson.map.SerializationConfig; 11 | import org.slf4j.Logger; 12 | import org.slf4j.LoggerFactory; 13 | import org.springframework.beans.factory.InitializingBean; 14 | import org.springframework.context.ApplicationContext; 15 | import org.springframework.context.expression.BeanFactoryResolver; 16 | import org.springframework.context.expression.EnvironmentAccessor; 17 | import org.springframework.context.expression.MapAccessor; 18 | import org.springframework.context.support.ClassPathXmlApplicationContext; 19 | import org.springframework.core.env.Environment; 20 | import org.springframework.core.env.StandardEnvironment; 21 | import org.springframework.expression.BeanResolver; 22 | import org.springframework.expression.ParserContext; 23 | import org.springframework.expression.PropertyAccessor; 24 | import org.springframework.expression.common.TemplateParserContext; 25 | import org.springframework.expression.spel.standard.SpelExpressionParser; 26 | import org.springframework.expression.spel.support.ReflectivePropertyAccessor; 27 | import org.springframework.expression.spel.support.StandardEvaluationContext; 28 | import org.springframework.shell.core.CommandMarker; 29 | import org.springframework.shell.core.annotation.CliAvailabilityIndicator; 30 | import org.springframework.shell.core.annotation.CliCommand; 31 | import org.springframework.shell.core.annotation.CliOption; 32 | import org.springframework.stereotype.Component; 33 | 34 | /** 35 | * @author Jon Brisbin 36 | */ 37 | @Component 38 | public class ContextCommands implements CommandMarker, InitializingBean { 39 | 40 | private static final Logger LOG = LoggerFactory.getLogger(ContextCommands.class); 41 | 42 | private static final PropertyAccessor MAP_ACCESOR = new MapAccessor(); 43 | private static final PropertyAccessor BEAN_ACCESOR = new ReflectivePropertyAccessor(); 44 | private static final PropertyAccessor ENV_ACCESSOR = new EnvironmentAccessor(); 45 | private static final Environment ENV = new StandardEnvironment(); 46 | 47 | final Map variables = new HashMap(); 48 | StandardEvaluationContext evalCtx; 49 | 50 | private final SpelExpressionParser parser = new SpelExpressionParser(); 51 | private final ParserContext parserContext = new TemplateParserContext(); 52 | private final ObjectMapper mapper = new ObjectMapper(); 53 | private BeanResolver beanFactoryResolver = null; 54 | 55 | private ApplicationContext userAppCtx; 56 | 57 | { 58 | mapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true); 59 | mapper.configure(SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS, false); 60 | } 61 | 62 | @Override public void afterPropertiesSet() throws Exception { 63 | userAppCtx = new ClassPathXmlApplicationContext("classpath*:META-INF/rest-shell/**/*.xml"); 64 | beanFactoryResolver = new BeanFactoryResolver(userAppCtx); 65 | clear(); 66 | } 67 | 68 | @CliAvailabilityIndicator({"var clear", "var set", "var get", "var list"}) 69 | public boolean available() { 70 | return true; 71 | } 72 | 73 | @CliCommand(value = "var clear", help = "Clear this shell's variable context") 74 | public void clear() { 75 | if(variables.containsKey("links")) { 76 | evalCtx.removePropertyAccessor(((Links)variables.get("links")).getPropertyAccessor()); 77 | } 78 | variables.clear(); 79 | setup(); 80 | if(LOG.isDebugEnabled()) { 81 | LOG.debug("Cleared context variables..."); 82 | } 83 | } 84 | 85 | @CliCommand(value = "var set", help = "Set a variable in this shell's context") 86 | public void set( 87 | @CliOption( 88 | key = "name", 89 | mandatory = true, 90 | help = "The name of the variable to set") String name, 91 | @CliOption( 92 | key = "value", 93 | mandatory = false, 94 | help = "The value of the variable to set") String value) { 95 | 96 | if(null == value) { 97 | variables.remove(name); 98 | return; 99 | } 100 | 101 | if(value.contains("#{")) { 102 | Object val = eval(value); 103 | variables.put(name, val); 104 | } else if(value.startsWith("{")) { 105 | try { 106 | variables.put(name, mapper.readValue(value.replaceAll("\\\\", "").replaceAll("'", "\""), Map.class)); 107 | } catch(IOException e) { 108 | throw new IllegalArgumentException(e); 109 | } 110 | } else if(value.startsWith("[")) { 111 | try { 112 | variables.put(name, mapper.readValue(value.replaceAll("\\\\", "").replaceAll("'", "\""), List.class)); 113 | } catch(IOException e) { 114 | throw new IllegalArgumentException(e); 115 | } 116 | } else if(userAppCtx.containsBean(value)) { 117 | variables.put(name, userAppCtx.getBean(value)); 118 | } else { 119 | variables.put(name, value); 120 | } 121 | 122 | if(LOG.isDebugEnabled()) { 123 | LOG.debug("Set context variable '" + name + "' to " + variables.get(name)); 124 | } 125 | } 126 | 127 | @CliCommand(value = "var get", help = "Get a variable in this shell's context") 128 | public Object get( 129 | @CliOption( 130 | key = "name", 131 | mandatory = false, 132 | help = "The name of the variable to get") String name, 133 | @CliOption( 134 | key = "value", 135 | mandatory = false, 136 | help = "The expression to evaluate") String value) { 137 | 138 | if(null != name) { 139 | if(variables.containsKey(name)) { 140 | return variables.get(name); 141 | } else if(userAppCtx.containsBean(name)) { 142 | return userAppCtx.getBean(name); 143 | } 144 | } 145 | 146 | if(null != value && value.contains("#{")) { 147 | return eval(value); 148 | } 149 | 150 | return null; 151 | } 152 | 153 | @CliCommand(value = "var list", help = "List variables currently set in this shell's context") 154 | public String list() { 155 | try { 156 | variables.remove("env"); 157 | return mapper.writeValueAsString(variables); 158 | } catch(IOException e) { 159 | throw new IllegalStateException(e); 160 | } finally { 161 | variables.put("env", ENV); 162 | } 163 | } 164 | 165 | public Object eval(String expr) { 166 | if(null == expr || !expr.contains("#{")) { 167 | return expr; 168 | } 169 | return parser.parseExpression(expr, parserContext).getValue(evalCtx); 170 | } 171 | 172 | public String evalAsString(String expr) { 173 | Object o = eval(expr); 174 | if(null != o) { 175 | return o.toString(); 176 | } 177 | return null; 178 | } 179 | 180 | private void setup() { 181 | evalCtx = new StandardEvaluationContext(variables); 182 | List accessors = new ArrayList(); 183 | accessors.add(MAP_ACCESOR); 184 | accessors.add(BEAN_ACCESOR); 185 | accessors.add(ENV_ACCESSOR); 186 | evalCtx.setPropertyAccessors(accessors); 187 | evalCtx.setBeanResolver(beanFactoryResolver); 188 | variables.put("env", ENV); 189 | } 190 | 191 | } 192 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/DiscoveryCommands.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.io.BufferedReader; 4 | import java.io.IOException; 5 | import java.io.InputStreamReader; 6 | import java.net.HttpURLConnection; 7 | import java.net.URI; 8 | import java.net.URISyntaxException; 9 | import java.util.ArrayList; 10 | import java.util.Arrays; 11 | import java.util.HashMap; 12 | import java.util.List; 13 | import java.util.Map; 14 | import javax.net.ssl.HostnameVerifier; 15 | import javax.net.ssl.HttpsURLConnection; 16 | import javax.net.ssl.SSLSession; 17 | 18 | import org.codehaus.jackson.map.ObjectMapper; 19 | import org.slf4j.Logger; 20 | import org.slf4j.LoggerFactory; 21 | import org.springframework.beans.factory.annotation.Autowired; 22 | import org.springframework.context.ApplicationEventPublisher; 23 | import org.springframework.context.ApplicationEventPublisherAware; 24 | import org.springframework.hateoas.Link; 25 | import org.springframework.http.HttpMethod; 26 | import org.springframework.http.MediaType; 27 | import org.springframework.http.client.ClientHttpRequest; 28 | import org.springframework.http.client.ClientHttpResponse; 29 | import org.springframework.http.client.SimpleClientHttpRequestFactory; 30 | import org.springframework.shell.core.CommandMarker; 31 | import org.springframework.shell.core.annotation.CliAvailabilityIndicator; 32 | import org.springframework.shell.core.annotation.CliCommand; 33 | import org.springframework.shell.core.annotation.CliOption; 34 | import org.springframework.shell.support.util.OsUtils; 35 | import org.springframework.stereotype.Component; 36 | import org.springframework.util.CollectionUtils; 37 | import org.springframework.web.client.RequestCallback; 38 | import org.springframework.web.client.ResponseExtractor; 39 | import org.springframework.web.client.RestTemplate; 40 | import org.springframework.web.util.UriComponentsBuilder; 41 | 42 | /** 43 | * Commands that discover resources and create local helpers for defined links. 44 | * 45 | * @author Jon Brisbin 46 | */ 47 | @Component 48 | public class DiscoveryCommands implements CommandMarker, ApplicationEventPublisherAware { 49 | 50 | private static final MediaType COMPACT_JSON = MediaType.valueOf("application/x-spring-data-compact+json"); 51 | private static final Logger LOG = LoggerFactory.getLogger(DiscoveryCommands.class); 52 | @Autowired 53 | private ConfigurationCommands configCmds; 54 | @Autowired 55 | private ContextCommands contextCmds; 56 | @Autowired 57 | private SslCommands sslCmds; 58 | private SslAwareClientHttpRequestFactory requestFactory = new SslAwareClientHttpRequestFactory(); 59 | @Autowired(required = false) 60 | private RestTemplate client = new RestTemplate(requestFactory); 61 | @Autowired(required = false) 62 | private ObjectMapper mapper = new ObjectMapper(); 63 | private Map resources = new HashMap(); 64 | private ApplicationEventPublisher ctx; 65 | 66 | private static String pad(String s, int len) { 67 | char[] pad = new char[len - s.length()]; 68 | Arrays.fill(pad, ' '); 69 | return s + new String(pad); 70 | } 71 | 72 | @Override public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) { 73 | this.ctx = applicationEventPublisher; 74 | } 75 | 76 | /** 77 | * Get the discovered resources. 78 | * 79 | * @return 80 | */ 81 | public Map getResources() { 82 | return resources; 83 | } 84 | 85 | @CliAvailabilityIndicator({"discover", "list", "follow"}) 86 | public boolean available() { 87 | return true; 88 | } 89 | 90 | /** 91 | * Issue a GET and discover what resources are available by looking in the links property of the JSON. 92 | * 93 | * @param path 94 | * URI to resource. 95 | * 96 | * @return 97 | * 98 | * @throws IOException 99 | */ 100 | @CliCommand(value = "discover", help = "Discover the resources available at a given URI.") 101 | public String discover( 102 | @CliOption(key = {"", "rel"}, 103 | mandatory = false, 104 | help = "The URI at which to discover resources.", 105 | unspecifiedDefaultValue = "/") PathOrRel path) throws IOException, URISyntaxException { 106 | 107 | URI requestUri; 108 | if("/".equals(path)) { 109 | requestUri = configCmds.getBaseUri(); 110 | } else if(path.getPath().startsWith("http")) { 111 | requestUri = URI.create(path.getPath()); 112 | } else { 113 | requestUri = UriComponentsBuilder.fromUri(configCmds.getBaseUri()).path(path.getPath()).build().toUri(); 114 | } 115 | 116 | configCmds.setBaseUri(requestUri.toString()); 117 | 118 | return list(new PathOrRel(requestUri.toString()), null); 119 | } 120 | 121 | @CliCommand(value = "list", help = "Discover the resources available at a given URI.") 122 | public String list( 123 | @CliOption(key = {"", "rel"}, 124 | mandatory = false, 125 | help = "The URI at which to discover resources.", 126 | unspecifiedDefaultValue = "/") PathOrRel path, 127 | @CliOption(key = "params", 128 | mandatory = false, 129 | help = "Query parameters to add to the URL.") Map params) { 130 | 131 | URI requestUri; 132 | if("/".equals(path)) { 133 | requestUri = configCmds.getBaseUri(); 134 | } else if(path.getPath().startsWith("http")) { 135 | requestUri = URI.create(path.getPath()); 136 | } else if(resources.containsKey(path)) { 137 | requestUri = UriComponentsBuilder.fromUriString(resources.get(path)) 138 | .build() 139 | .toUri(); 140 | } else if("/".equals(configCmds.getBaseUri().getPath())) { 141 | requestUri = UriComponentsBuilder.fromUri(configCmds.getBaseUri()) 142 | .path(path.getPath()) 143 | .build() 144 | .toUri(); 145 | } else { 146 | requestUri = UriComponentsBuilder.fromUri(configCmds.getBaseUri()) 147 | .pathSegment(path.getPath()) 148 | .build() 149 | .toUri(); 150 | } 151 | 152 | if(null != params) { 153 | UriComponentsBuilder urib = UriComponentsBuilder.fromUri(requestUri); 154 | for(Object key : params.keySet()) { 155 | urib.queryParam(key.toString(), params.get(key)); 156 | } 157 | requestUri = urib.build().toUri(); 158 | } 159 | 160 | ExtractLinksHelper elh = new ExtractLinksHelper(); 161 | List links = client.execute(requestUri, HttpMethod.GET, elh, elh); 162 | 163 | if(links.size() == 0) { 164 | return "No resources found..."; 165 | } 166 | 167 | StringBuilder sb = new StringBuilder(); 168 | 169 | int maxRelLen = 0; 170 | int maxHrefLen = 0; 171 | 172 | // First get max lengths 173 | for(Link l : links) { 174 | if(maxRelLen < l.getRel().length()) { 175 | maxRelLen = l.getRel().length(); 176 | } 177 | if(maxHrefLen < l.getHref().length()) { 178 | maxHrefLen = l.getHref().length(); 179 | } 180 | } 181 | maxRelLen += 4; 182 | 183 | sb.append(pad("rel", maxRelLen)) 184 | .append(pad("href", maxHrefLen)) 185 | .append(OsUtils.LINE_SEPARATOR); 186 | 187 | char[] line = new char[maxRelLen + maxHrefLen]; 188 | Arrays.fill(line, '='); 189 | sb.append(new String(line)) 190 | .append(OsUtils.LINE_SEPARATOR); 191 | 192 | // Now build a table 193 | for(Link l : links) { 194 | resources.put(l.getRel(), l.getHref()); 195 | sb.append(pad(l.getRel(), maxRelLen)) 196 | .append(pad(l.getHref(), maxHrefLen)) 197 | .append(OsUtils.LINE_SEPARATOR); 198 | } 199 | 200 | return sb.toString(); 201 | } 202 | 203 | /** 204 | * Follow a URI by setting the baseUri to this path, then discovering what resources are available there. 205 | * 206 | * @param path 207 | * URI to resource. 208 | * 209 | * @return 210 | * 211 | * @throws IOException 212 | * @throws URISyntaxException 213 | */ 214 | @CliCommand(value = "follow", 215 | help = "Follows a URI path, sets the base to that new path, and discovers what resources are available.") 216 | public void follow( 217 | @CliOption(key = {"", "rel"}, 218 | mandatory = true, 219 | help = "The URI to follow.") PathOrRel path) throws IOException, URISyntaxException { 220 | configCmds.setBaseUri(path.getPath()); 221 | } 222 | 223 | private class ExtractLinksHelper implements RequestCallback, ResponseExtractor> { 224 | 225 | @Override public void doWithRequest(ClientHttpRequest request) throws IOException { 226 | request.getHeaders().setAll(configCmds.getHeaders().toSingleValueMap()); 227 | if(CollectionUtils.isEmpty(request.getHeaders().getAccept())) { 228 | if(LOG.isDebugEnabled()) { 229 | LOG.debug("No 'Accept' header specified, using " + COMPACT_JSON); 230 | } 231 | request.getHeaders().setAccept(Arrays.asList(COMPACT_JSON, MediaType.APPLICATION_JSON)); 232 | } 233 | } 234 | 235 | @Override public List extractData(ClientHttpResponse response) throws IOException { 236 | List links = new ArrayList(); 237 | 238 | MediaType ct = response.getHeaders().getContentType(); 239 | if(null != ct && ct.getSubtype().endsWith("json")) { 240 | Map m = mapper.readValue(response.getBody(), Map.class); 241 | 242 | Object o = m.get("links"); 243 | if(o instanceof List) { 244 | for(Object lnk : (List)o) { 245 | if(lnk instanceof Map) { 246 | Map lnkmap = (Map)lnk; 247 | String href = String.format("%s", lnkmap.get("href")); 248 | String rel = String.format("%s", lnkmap.get("rel")); 249 | links.add(new Link(href, rel)); 250 | } 251 | } 252 | } 253 | } else if(null != ct && ct.getSubtype().endsWith("uri-list")) { 254 | BufferedReader rdr = new BufferedReader(new InputStreamReader(response.getBody())); 255 | String line; 256 | while(null != (line = rdr.readLine())) { 257 | links.add(new Link(URI.create(line).toString(), "")); 258 | } 259 | } 260 | 261 | if(LOG.isDebugEnabled()) { 262 | LOG.debug("Returning links: " + links); 263 | } 264 | 265 | return links; 266 | } 267 | 268 | } 269 | 270 | private class SslAwareClientHttpRequestFactory extends SimpleClientHttpRequestFactory { 271 | @Override protected void prepareConnection(HttpURLConnection connection, String httpMethod) throws IOException { 272 | if(connection instanceof HttpsURLConnection) { 273 | HttpsURLConnection httpsConnection = (HttpsURLConnection)connection; 274 | if(!sslCmds.getValidate()) { 275 | httpsConnection.setHostnameVerifier(new HostnameVerifier() { 276 | @Override public boolean verify(String s, SSLSession sslSession) { 277 | return true; 278 | } 279 | }); 280 | httpsConnection.setSSLSocketFactory(sslCmds.getCustomContext().getSocketFactory()); 281 | } 282 | } 283 | super.prepareConnection(connection, httpMethod); 284 | } 285 | } 286 | 287 | } 288 | 289 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/DotRcReader.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.io.BufferedReader; 4 | import java.io.File; 5 | import java.io.FileReader; 6 | import java.io.IOException; 7 | 8 | import org.springframework.beans.factory.annotation.Autowired; 9 | import org.springframework.shell.core.JLineShellComponent; 10 | import org.springframework.stereotype.Component; 11 | 12 | /** 13 | * @author Jon Brisbin 14 | */ 15 | @Component 16 | public class DotRcReader { 17 | 18 | @Autowired 19 | private JLineShellComponent shell; 20 | private boolean readDotRc = false; 21 | 22 | public void readDotRc() throws Exception { 23 | if(readDotRc) { 24 | return; 25 | } 26 | String homeDir = System.getenv("HOME"); 27 | File restShellInitDir = new File(homeDir + File.separator + ".rest-shell"); 28 | if(restShellInitDir.exists() && restShellInitDir.isDirectory()) { 29 | File[] files = restShellInitDir.listFiles(); 30 | if(null == files) { 31 | return; 32 | } 33 | for(File f : files) { 34 | sourceFile(f); 35 | } 36 | readDotRc = true; 37 | } 38 | } 39 | 40 | private void sourceFile(File f) throws IOException { 41 | BufferedReader dotRc = new BufferedReader(new FileReader(f)); 42 | String line; 43 | while(null != (line = dotRc.readLine())) { 44 | shell.executeCommand(line); 45 | } 46 | } 47 | 48 | } 49 | 50 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/HierarchyCommands.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.net.URI; 4 | import java.net.URISyntaxException; 5 | 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.shell.core.CommandMarker; 8 | import org.springframework.shell.core.annotation.CliAvailabilityIndicator; 9 | import org.springframework.shell.core.annotation.CliCommand; 10 | import org.springframework.stereotype.Component; 11 | import org.springframework.web.util.UriComponentsBuilder; 12 | 13 | /** 14 | * Commands that figure out how to traverse the URL hierarchy. 15 | * 16 | * @author Jon Brisbin 17 | */ 18 | @Component 19 | public class HierarchyCommands implements CommandMarker { 20 | 21 | @Autowired 22 | private ConfigurationCommands configCmds; 23 | @Autowired 24 | private DiscoveryCommands discoveryCmds; 25 | 26 | @CliAvailabilityIndicator({"up"}) 27 | public boolean isHierarchyAvailable() { 28 | String path = configCmds.getBaseUri().getPath(); 29 | return !("".equals(path) || "/".equals(path)); 30 | } 31 | 32 | /** 33 | * Traverse one level up in the URL hierarchy. 34 | */ 35 | @CliCommand(value = "up", help = "Traverse one level up in the URL hierarchy.") 36 | public void up() throws URISyntaxException { 37 | if(discoveryCmds.getResources().containsKey("parent")) { 38 | configCmds.setBaseUri(discoveryCmds.getResources().get("parent")); 39 | return; 40 | } 41 | 42 | URI baseUri = configCmds.getBaseUri(); 43 | String path = baseUri.getPath(); 44 | if (!("".equals(path) || "/".equals(path))) { 45 | int idx = path.lastIndexOf("/"); 46 | String newPath = path.substring(0, idx); 47 | configCmds.setBaseUri(UriComponentsBuilder.fromUri(baseUri).replacePath(newPath).build().toUriString()); 48 | } 49 | } 50 | 51 | } 52 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/HistoryCommands.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.net.URI; 4 | import java.net.URISyntaxException; 5 | import java.util.ArrayList; 6 | import java.util.List; 7 | 8 | import org.springframework.beans.factory.annotation.Autowired; 9 | import org.springframework.context.ApplicationListener; 10 | import org.springframework.data.rest.shell.context.BaseUriChangedEvent; 11 | import org.springframework.shell.core.CommandMarker; 12 | import org.springframework.shell.core.annotation.CliAvailabilityIndicator; 13 | import org.springframework.shell.core.annotation.CliCommand; 14 | import org.springframework.shell.core.annotation.CliOption; 15 | import org.springframework.shell.support.util.OsUtils; 16 | import org.springframework.stereotype.Component; 17 | 18 | /** 19 | * Commands for tracking the baseUris that have been set in this session. 20 | * 21 | * @author Jon Brisbin 22 | */ 23 | @Component 24 | public class HistoryCommands implements CommandMarker, ApplicationListener { 25 | 26 | @Autowired 27 | private ConfigurationCommands configCmds; 28 | private List baseUris = new ArrayList(); 29 | 30 | @Override public void onApplicationEvent(BaseUriChangedEvent event) { 31 | baseUris.add(event.getBaseUri()); 32 | } 33 | 34 | @CliAvailabilityIndicator({"history list", "history go"}) 35 | public boolean isHistoryAvailable() { 36 | return true; 37 | } 38 | 39 | public List getHistory() { 40 | return baseUris; 41 | } 42 | 43 | @CliCommand(value = "history list", help = "List the URLs in the history.") 44 | public String list() { 45 | StringBuilder buffer = new StringBuilder(); 46 | for(int i = 0; i < baseUris.size(); i++) { 47 | URI uri = baseUris.get(i); 48 | buffer.append(i + 1).append(": ").append(uri.toString()).append(OsUtils.LINE_SEPARATOR); 49 | } 50 | return buffer.toString(); 51 | } 52 | 53 | @CliCommand(value = "history go", help = "Go to a specific URL in the history.") 54 | public void go( 55 | @CliOption(key = "", 56 | mandatory = true, 57 | help = "The history entry to set the baseUri to.") Integer num) throws URISyntaxException { 58 | if(num < 1) { 59 | return; 60 | } 61 | if(num > baseUris.size()) { 62 | return; 63 | } 64 | URI uri = baseUris.get(num - 1); 65 | configCmds.setBaseUri(uri.toString()); 66 | } 67 | 68 | } 69 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/HttpCommands.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import org.codehaus.jackson.JsonParseException; 4 | import org.codehaus.jackson.JsonParser; 5 | import org.codehaus.jackson.map.ObjectMapper; 6 | import org.codehaus.jackson.map.SerializationConfig; 7 | import org.slf4j.Logger; 8 | import org.slf4j.LoggerFactory; 9 | import org.springframework.beans.factory.InitializingBean; 10 | import org.springframework.beans.factory.annotation.Autowired; 11 | import org.springframework.context.ApplicationEventPublisher; 12 | import org.springframework.context.ApplicationEventPublisherAware; 13 | import org.springframework.data.rest.shell.context.ResponseEvent; 14 | import org.springframework.data.rest.shell.formatter.FormatProvider; 15 | import org.springframework.data.rest.shell.formatter.Formatter; 16 | import org.springframework.hateoas.Link; 17 | import org.springframework.http.HttpMethod; 18 | import org.springframework.http.HttpStatus; 19 | import org.springframework.http.MediaType; 20 | import org.springframework.http.ResponseEntity; 21 | import org.springframework.http.client.ClientHttpRequest; 22 | import org.springframework.http.client.ClientHttpResponse; 23 | import org.springframework.http.client.SimpleClientHttpRequestFactory; 24 | import org.springframework.shell.core.CommandMarker; 25 | import org.springframework.shell.core.annotation.CliAvailabilityIndicator; 26 | import org.springframework.shell.core.annotation.CliCommand; 27 | import org.springframework.shell.core.annotation.CliOption; 28 | import org.springframework.shell.support.util.OsUtils; 29 | import org.springframework.stereotype.Component; 30 | import org.springframework.web.client.*; 31 | import org.springframework.web.util.UriComponentsBuilder; 32 | 33 | import javax.net.ssl.HostnameVerifier; 34 | import javax.net.ssl.HttpsURLConnection; 35 | import javax.net.ssl.SSLSession; 36 | import java.io.*; 37 | import java.net.HttpURLConnection; 38 | import java.net.URI; 39 | import java.net.URISyntaxException; 40 | import java.net.URLEncoder; 41 | import java.util.List; 42 | import java.util.Map; 43 | import java.util.concurrent.atomic.AtomicInteger; 44 | 45 | /** 46 | * Commands that issue the HTTP requests. 47 | * 48 | * @author Jon Brisbin 49 | */ 50 | @Component 51 | public class HttpCommands implements CommandMarker, ApplicationEventPublisherAware, InitializingBean { 52 | 53 | private static final Logger LOG = LoggerFactory.getLogger(HttpCommands.class); 54 | private static final String LOCATION_HEADER = "Location"; 55 | @Autowired 56 | private ConfigurationCommands configCmds; 57 | @Autowired 58 | private DiscoveryCommands discoveryCmds; 59 | @Autowired 60 | private ContextCommands contextCmds; 61 | @Autowired 62 | private SslCommands sslCmds; 63 | private SslAwareClientHttpRequestFactory requestFactory = new SslAwareClientHttpRequestFactory(); 64 | @Autowired(required = false) 65 | private RestTemplate restTemplate = new RestTemplate(requestFactory); 66 | @Autowired(required = false) 67 | private ObjectMapper mapper = new ObjectMapper(); 68 | private ApplicationEventPublisher ctx; 69 | private Object lastResult; 70 | private URI requestUri; 71 | @Autowired 72 | private FormatProvider formatProvider; 73 | 74 | private static String encode(String s) { 75 | try { 76 | return URLEncoder.encode(s, "ISO-8859-1"); 77 | } catch (UnsupportedEncodingException e) { 78 | throw new IllegalStateException(e); 79 | } 80 | } 81 | 82 | @Override 83 | public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) { 84 | this.ctx = applicationEventPublisher; 85 | } 86 | 87 | @Override 88 | public void afterPropertiesSet() throws Exception { 89 | mapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true); 90 | mapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true); 91 | 92 | restTemplate.setErrorHandler(new DefaultResponseErrorHandler() { 93 | @Override 94 | public void handleError(ClientHttpResponse response) throws IOException { 95 | } 96 | }); 97 | } 98 | 99 | @CliAvailabilityIndicator({"timeout", "get", "post", "put", "delete"}) 100 | public boolean isHttpCommandAvailable() { 101 | return true; 102 | } 103 | 104 | @CliCommand(value = "timeout", help = "Set the read timeout for requests.") 105 | public void timeout(@CliOption(key = "", 106 | mandatory = true, 107 | help = "The timeout (in milliseconds) to wait for a response.", 108 | unspecifiedDefaultValue = "30000") int timeout) { 109 | requestFactory.setReadTimeout(timeout); 110 | } 111 | 112 | /** 113 | * HTTP GET to retrieve a resource. 114 | * 115 | * @param path URI to resource. 116 | * @param params URL query parameters to pass for paging and search. 117 | * @return 118 | */ 119 | @CliCommand(value = "get", help = "Issue HTTP GET to a resource.") 120 | public String get( 121 | @CliOption(key = {"", "rel"}, 122 | mandatory = false, 123 | help = "The path to the resource to GET.", 124 | unspecifiedDefaultValue = "") PathOrRel path, 125 | @CliOption(key = "follow", 126 | mandatory = false, 127 | help = "If a Location header is returned, immediately follow it.", 128 | unspecifiedDefaultValue = "false") final String follow, 129 | @CliOption(key = "params", 130 | mandatory = false, 131 | help = "Query parameters to add to the URL as a simplified JSON fragment '{paramName:\"paramValue\"}'.") Map params, 132 | @CliOption(key = "output", 133 | mandatory = false, 134 | help = "The path to dump the output to.") String outputPath) { 135 | 136 | outputPath = contextCmds.evalAsString(outputPath); 137 | 138 | UriComponentsBuilder ucb = createUriComponentsBuilder(path.getPath()); 139 | if (null != params) { 140 | for (Object key : params.keySet()) { 141 | Object o = params.get(key); 142 | ucb.queryParam(key.toString(), encode(o.toString())); 143 | } 144 | } 145 | requestUri = ucb.build().toUri(); 146 | 147 | return execute(HttpMethod.GET, null, follow, outputPath); 148 | } 149 | 150 | /** 151 | * HTTP POST to create a new resource. 152 | * 153 | * @param path URI to resource. 154 | * @param data The JSON data to send. 155 | * @return 156 | */ 157 | @CliCommand(value = "post", help = "Issue HTTP POST to create a new resource.") 158 | public String post( 159 | @CliOption(key = {"", "rel"}, 160 | mandatory = false, 161 | help = "The path to the resource collection.", 162 | unspecifiedDefaultValue = "") PathOrRel path, 163 | @CliOption(key = "data", 164 | mandatory = false, 165 | help = "The JSON data to use as the resource.") String data, 166 | @CliOption(key = "from", 167 | mandatory = false, 168 | help = "The directory from which to read JSON files to POST to the server.") String fromDir, 169 | @CliOption(key = "follow", 170 | mandatory = false, 171 | help = "If a Location header is returned, immediately follow it.", 172 | unspecifiedDefaultValue = "false") final String follow, 173 | @CliOption(key = "params", 174 | mandatory = false, 175 | help = "Query parameters to add to the URL as a simplified JSON fragment '{paramName:\"paramValue\"}'.") Map params, 176 | @CliOption(key = "output", 177 | mandatory = false, 178 | help = "The path to dump the output to.") String outputTo) throws IOException { 179 | 180 | fromDir = contextCmds.evalAsString(fromDir); 181 | final String outputPath = contextCmds.evalAsString(outputTo); 182 | 183 | UriComponentsBuilder ucb = createUriComponentsBuilder(path.getPath()); 184 | if (null != params) { 185 | for (Object key : params.keySet()) { 186 | Object o = params.get(key); 187 | ucb.queryParam(key.toString(), encode(o.toString())); 188 | } 189 | } 190 | requestUri = ucb.build().toUri(); 191 | 192 | Object obj = null; 193 | if (null != data) { 194 | if (data.contains("#{")) { 195 | obj = contextCmds.eval(data); 196 | } else if (data.startsWith("[") || data.startsWith("{")) { 197 | Class targetType = Map.class; 198 | if (data.startsWith("[")) { 199 | targetType = List.class; 200 | } 201 | obj = mapper.readValue(data.replaceAll("\\\\", "").replaceAll("'", "\""), targetType); 202 | } else { 203 | obj = data; 204 | } 205 | } 206 | 207 | if (null != fromDir) { 208 | fromDir = contextCmds.evalAsString(fromDir); 209 | try { 210 | return readFileOrFiles(HttpMethod.POST, fromDir, follow, outputPath); 211 | } catch (IOException e) { 212 | throw new IllegalStateException(e); 213 | } 214 | } 215 | 216 | return execute(HttpMethod.POST, obj, follow, outputPath); 217 | } 218 | 219 | /** 220 | * HTTP PUT to update a resource. 221 | * 222 | * @param path URI to resource. 223 | * @param data The JSON data to send. 224 | * @return 225 | */ 226 | @CliCommand(value = "put", help = "Issue HTTP PUT to update a resource.") 227 | public String put( 228 | @CliOption(key = {"", "rel"}, 229 | mandatory = false, 230 | help = "The path to the resource.", 231 | unspecifiedDefaultValue = "") PathOrRel path, 232 | @CliOption(key = "data", 233 | mandatory = false, 234 | help = "The JSON data to use as the resource.") String data, 235 | @CliOption(key = "from", 236 | mandatory = false, 237 | help = "The directory from which to read JSON files to POST to the server.") String fromDir, 238 | @CliOption(key = "follow", 239 | mandatory = false, 240 | help = "If a Location header is returned, immediately follow it.", 241 | unspecifiedDefaultValue = "false") final String follow, 242 | @CliOption(key = "params", 243 | mandatory = false, 244 | help = "Query parameters to add to the URL as a simplified JSON fragment '{paramName:\"paramValue\"}'.") Map params, 245 | @CliOption(key = "output", 246 | mandatory = false, 247 | help = "The path to dump the output to.") String outputPath) throws IOException { 248 | 249 | fromDir = contextCmds.evalAsString(fromDir); 250 | outputPath = contextCmds.evalAsString(outputPath); 251 | 252 | UriComponentsBuilder ucb = createUriComponentsBuilder(path.getPath()); 253 | if (null != params) { 254 | for (Object key : params.keySet()) { 255 | Object o = params.get(key); 256 | ucb.queryParam(key.toString(), encode(o.toString())); 257 | } 258 | } 259 | requestUri = ucb.build().toUri(); 260 | 261 | Object obj; 262 | if (null != data) { 263 | if (data.contains("#{")) { 264 | obj = contextCmds.eval(data); 265 | } else if (data.startsWith("[") || data.startsWith("{")) { 266 | Class targetType = Map.class; 267 | if (data.startsWith("[")) { 268 | targetType = List.class; 269 | } 270 | try { 271 | obj = mapper.readValue(data.replaceAll("\\\\", "").replaceAll("'", "\""), targetType); 272 | } catch (JsonParseException e) { 273 | LOG.error(e.getMessage(), e); 274 | throw new IllegalStateException(e.getMessage(), e); 275 | } 276 | } else { 277 | obj = data; 278 | } 279 | return execute(HttpMethod.PUT, obj, follow, outputPath); 280 | } 281 | 282 | if (null != fromDir) { 283 | fromDir = contextCmds.evalAsString(fromDir); 284 | try { 285 | return readFileOrFiles(HttpMethod.PUT, fromDir, "false", outputPath); 286 | } catch (IOException e) { 287 | throw new IllegalStateException(e); 288 | } 289 | } 290 | 291 | return null; 292 | } 293 | 294 | /** 295 | * HTTP DELETE to delete a resource. 296 | * 297 | * @param path URI to resource. 298 | * @return 299 | */ 300 | @CliCommand(value = "delete", help = "Issue HTTP DELETE to delete a resource.") 301 | public String delete( 302 | @CliOption(key = {"", "rel"}, 303 | mandatory = false, 304 | help = "Issue HTTP DELETE to delete a resource.", 305 | unspecifiedDefaultValue = "") PathOrRel path, 306 | @CliOption(key = "follow", 307 | mandatory = false, 308 | help = "If a Location header is returned, immediately follow it.", 309 | unspecifiedDefaultValue = "false") final String follow, 310 | @CliOption(key = "params", 311 | mandatory = false, 312 | help = "Query parameters to add to the URL as a simplified JSON fragment '{paramName:\"paramValue\"}'.") Map params, 313 | @CliOption(key = "output", 314 | mandatory = false, 315 | help = "The path to dump the output to.") String outputPath) { 316 | 317 | outputPath = contextCmds.evalAsString(outputPath); 318 | 319 | UriComponentsBuilder ucb = createUriComponentsBuilder(path.getPath()); 320 | if (null != params) { 321 | for (Object key : params.keySet()) { 322 | Object o = params.get(key); 323 | ucb.queryParam(key.toString(), encode(o.toString())); 324 | } 325 | } 326 | requestUri = ucb.build().toUri(); 327 | 328 | return execute(HttpMethod.DELETE, null, follow, outputPath); 329 | } 330 | 331 | public String execute(final HttpMethod method, 332 | final Object data, 333 | final String follow, 334 | final String outputPath) { 335 | final StringBuilder buffer = new StringBuilder(); 336 | MediaType contentType = configCmds.getHeaders().getContentType(); 337 | if (contentType == null) { 338 | contentType = MediaType.APPLICATION_JSON; 339 | } 340 | 341 | ResponseErrorHandler origErrHandler = restTemplate.getErrorHandler(); 342 | RequestHelper helper = (null == data ? new RequestHelper() : new RequestHelper(data, contentType)); 343 | ResponseEntity response; 344 | try { 345 | restTemplate.setErrorHandler(new ResponseErrorHandler() { 346 | @Override 347 | public boolean hasError(ClientHttpResponse response) throws IOException { 348 | HttpStatus status = response.getStatusCode(); 349 | return (status == HttpStatus.BAD_GATEWAY || status == HttpStatus.GATEWAY_TIMEOUT); 350 | } 351 | 352 | @Override 353 | public void handleError(ClientHttpResponse response) throws IOException { 354 | if (LOG.isWarnEnabled()) { 355 | LOG.warn("Client encountered an error " + response.getRawStatusCode() + ". Retrying..."); 356 | } 357 | System.out.println(execute(method, data, follow, outputPath)); 358 | } 359 | }); 360 | 361 | if (LOG.isInfoEnabled()) { 362 | LOG.info("Sending " + method + " to " + requestUri + " using " + data); 363 | } 364 | response = restTemplate.execute(requestUri, method, helper, helper); 365 | 366 | } catch (ResourceAccessException e) { 367 | if (LOG.isWarnEnabled()) { 368 | LOG.warn("Client encountered an error. Retrying. (" + e.getMessage() + ")", e); 369 | } 370 | // Calling this method recursively results in hang, so just retry once. 371 | response = restTemplate.execute(requestUri, method, helper, helper); 372 | } finally { 373 | restTemplate.setErrorHandler(origErrHandler); 374 | } 375 | 376 | if ("true".equals(follow) && response.getHeaders().containsKey(LOCATION_HEADER)) { 377 | try { 378 | configCmds.setBaseUri(response.getHeaders().getFirst(LOCATION_HEADER)); 379 | } catch (URISyntaxException e) { 380 | LOG.error("Error following Location header: " + e.getMessage(), e); 381 | } 382 | } 383 | 384 | outputRequest(method.name(), requestUri, buffer); 385 | contextCmds.variables.put("response", response); 386 | ctx.publishEvent(new ResponseEvent(requestUri, method, response)); 387 | outputResponse(response, buffer); 388 | 389 | if (null != outputPath) { 390 | FileWriter writer = null; 391 | try { 392 | writer = new FileWriter(new File(outputPath)); 393 | writer.write(buffer.toString()); 394 | writer.flush(); 395 | } catch (IOException e) { 396 | LOG.error(e.getMessage(), e); 397 | throw new IllegalArgumentException(e); 398 | } finally { 399 | if (null != writer) { 400 | try { 401 | writer.close(); 402 | } catch (IOException e) { 403 | } 404 | } 405 | } 406 | return "\n>> " + outputPath + "\n"; 407 | } else { 408 | switch (response.getStatusCode()) { 409 | case BAD_REQUEST: 410 | case INTERNAL_SERVER_ERROR: { 411 | System.err.println(buffer.toString()); 412 | return null; 413 | } 414 | default: 415 | return buffer.toString(); 416 | } 417 | } 418 | } 419 | 420 | private String readFileOrFiles(final HttpMethod method, 421 | final String fromPath, 422 | final String follow, 423 | final String outputPath) throws IOException { 424 | String output; 425 | File fromFile = new File(fromPath); 426 | if (!fromFile.exists()) { 427 | throw new IllegalArgumentException("Path " + fromPath + " not found."); 428 | } 429 | 430 | if (fromFile.isDirectory()) { 431 | final AtomicInteger numItems = new AtomicInteger(0); 432 | 433 | FilenameFilter jsonFilter = new FilenameFilter() { 434 | @Override 435 | public boolean accept(File file, String s) { 436 | return s.endsWith(".json"); 437 | } 438 | }; 439 | for (File file : fromFile.listFiles(jsonFilter)) { 440 | Object body = readFile(file); 441 | String response = execute(method, 442 | body, 443 | follow, 444 | outputPath); 445 | if (LOG.isDebugEnabled()) { 446 | LOG.debug(response); 447 | } 448 | if (null != response) { 449 | numItems.incrementAndGet(); 450 | } 451 | } 452 | 453 | output = "\n" + numItems.get() + " files successfully uploaded to the server using " + method + "\n"; 454 | } else { 455 | Object body = readFile(fromFile); 456 | String response = execute(method, 457 | body, 458 | follow, 459 | outputPath); 460 | if (LOG.isDebugEnabled()) { 461 | LOG.debug(response); 462 | } 463 | 464 | output = response; 465 | } 466 | 467 | return output; 468 | } 469 | 470 | private Object readFile(File file) throws IOException { 471 | StringBuilder builder = new StringBuilder(); 472 | FileReader reader = new FileReader(file); 473 | char[] buffer = new char[8 * 1024]; 474 | int read; 475 | while (-1 < (read = reader.read(buffer))) { 476 | String s = new String(buffer, 0, read); 477 | builder.append(s); 478 | } 479 | 480 | String bodyAsString = builder.toString(); 481 | Object body = ""; 482 | if (bodyAsString.length() > 0) { 483 | try { 484 | if (bodyAsString.charAt(0) == '{') { 485 | body = mapper.readValue(bodyAsString, Map.class); 486 | } else if (bodyAsString.charAt(0) == '[') { 487 | body = mapper.readValue(bodyAsString, List.class); 488 | } else { 489 | body = bodyAsString; 490 | } 491 | } catch (JsonParseException e) { 492 | LOG.error(e.getMessage(), e); 493 | throw new IllegalStateException(e.getMessage(), e); 494 | } 495 | } 496 | return body; 497 | } 498 | 499 | private UriComponentsBuilder createUriComponentsBuilder(String path) { 500 | UriComponentsBuilder ucb; 501 | if (discoveryCmds.getResources().containsKey(path)) { 502 | ucb = UriComponentsBuilder.fromUriString(discoveryCmds.getResources().get(path)); 503 | } else { 504 | if (path.startsWith("http")) { 505 | ucb = UriComponentsBuilder.fromUriString(path); 506 | } else { 507 | ucb = UriComponentsBuilder.fromUri(configCmds.getBaseUri()).pathSegment(path); 508 | } 509 | } 510 | return ucb; 511 | } 512 | 513 | private void outputRequest(String method, URI requestUri, StringBuilder buffer) { 514 | buffer.append("> ") 515 | .append(method) 516 | .append(" ") 517 | .append(requestUri.toString()) 518 | .append(OsUtils.LINE_SEPARATOR); 519 | for (Map.Entry entry : configCmds.getHeaders().toSingleValueMap().entrySet()) { 520 | buffer.append("> ") 521 | .append(entry.getKey()) 522 | .append(": ") 523 | .append(entry.getValue()) 524 | .append(OsUtils.LINE_SEPARATOR); 525 | } 526 | buffer.append(OsUtils.LINE_SEPARATOR); 527 | } 528 | 529 | private void outputResponse(ResponseEntity response, StringBuilder buffer) { 530 | buffer.append("< ") 531 | .append(response.getStatusCode().value()) 532 | .append(" ") 533 | .append(response.getStatusCode().name()) 534 | .append(OsUtils.LINE_SEPARATOR); 535 | for (Map.Entry> entry : response.getHeaders().entrySet()) { 536 | buffer.append("< ") 537 | .append(entry.getKey()) 538 | .append(": "); 539 | boolean first = true; 540 | for (String s : entry.getValue()) { 541 | if (!first) { 542 | buffer.append(","); 543 | } else { 544 | first = false; 545 | } 546 | buffer.append(s); 547 | } 548 | buffer.append(OsUtils.LINE_SEPARATOR); 549 | } 550 | buffer.append("< ").append(OsUtils.LINE_SEPARATOR); 551 | if (null != response.getBody()) { 552 | final Formatter formatter = formatProvider.getFormatter(response.getHeaders().getContentType().getSubtype()); 553 | buffer.append(formatter.format(response.getBody())); 554 | } 555 | } 556 | 557 | private class RequestHelper implements RequestCallback, 558 | ResponseExtractor> { 559 | 560 | private Object body; 561 | private MediaType contentType; 562 | private HttpMessageConverterExtractor extractor = 563 | new HttpMessageConverterExtractor(String.class, 564 | restTemplate.getMessageConverters()); 565 | private ObjectMapper mapper = new ObjectMapper(); 566 | 567 | { 568 | mapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true); 569 | } 570 | 571 | private RequestHelper() { 572 | } 573 | 574 | private RequestHelper(Object body, MediaType contentType) { 575 | this.body = body; 576 | this.contentType = contentType; 577 | } 578 | 579 | @Override 580 | public void doWithRequest(ClientHttpRequest request) throws IOException { 581 | request.getHeaders().setAll(configCmds.getHeaders().toSingleValueMap()); 582 | if (null != contentType) { 583 | request.getHeaders().setContentType(contentType); 584 | } 585 | if (null != body) { 586 | if (body instanceof String) { 587 | request.getBody().write(((String) body).getBytes()); 588 | } else if (body instanceof byte[]) { 589 | request.getBody().write((byte[]) body); 590 | } else { 591 | try { 592 | mapper.writeValue(request.getBody(), body); 593 | } catch (JsonParseException e) { 594 | LOG.error(e.getMessage(), e); 595 | throw new IllegalStateException(e.getMessage(), e); 596 | } 597 | } 598 | } 599 | //contextCmds.variables.put("request", request); 600 | } 601 | 602 | @SuppressWarnings({"unchecked"}) 603 | @Override 604 | public ResponseEntity extractData(ClientHttpResponse response) throws IOException { 605 | String body = extractor.extractData(response); 606 | contextCmds.variables.put("requestUrl", requestUri.toString()); 607 | contextCmds.variables.put("responseHeaders", response.getHeaders()); 608 | contextCmds.variables.put("responseBody", null); 609 | 610 | MediaType ct = response.getHeaders().getContentType(); 611 | if (null != body && null != ct && ct.getSubtype().endsWith("json")) { 612 | // Pretty-print the JSON 613 | try { 614 | if (body.startsWith("{")) { 615 | lastResult = mapper.readValue(body.getBytes(), Map.class); 616 | } else if (body.startsWith("[")) { 617 | lastResult = mapper.readValue(body.getBytes(), List.class); 618 | } else { 619 | lastResult = new String(body.getBytes()); 620 | } 621 | } catch (JsonParseException e) { 622 | LOG.error(e.getMessage(), e); 623 | throw new IllegalStateException(e.getMessage(), e); 624 | } 625 | 626 | contextCmds.variables.put("responseBody", lastResult); 627 | 628 | if (lastResult instanceof Map && ((Map) lastResult).containsKey("links")) { 629 | Links linksobj; 630 | if (contextCmds.variables.containsKey("links")) { 631 | linksobj = (Links) contextCmds.variables.get("links"); 632 | } else { 633 | linksobj = new Links(); 634 | contextCmds.evalCtx.addPropertyAccessor(linksobj.getPropertyAccessor()); 635 | } 636 | linksobj.getLinks().clear(); 637 | for (Map linkmap : (List>) ((Map) lastResult).get("links")) { 638 | linksobj.addLink(new Link(linkmap.get("href"), linkmap.get("rel"))); 639 | } 640 | contextCmds.variables.put("links", linksobj); 641 | } 642 | 643 | StringWriter sw = new StringWriter(); 644 | try { 645 | mapper.writeValue(sw, lastResult); 646 | } catch (JsonParseException e) { 647 | LOG.error(e.getMessage(), e); 648 | throw new IllegalStateException(e.getMessage(), e); 649 | } 650 | body = sw.toString(); 651 | } 652 | 653 | return new ResponseEntity(body, response.getHeaders(), response.getStatusCode()); 654 | } 655 | } 656 | 657 | private class SslAwareClientHttpRequestFactory extends SimpleClientHttpRequestFactory { 658 | @Override 659 | protected void prepareConnection(HttpURLConnection connection, String httpMethod) throws IOException { 660 | if (connection instanceof HttpsURLConnection) { 661 | HttpsURLConnection httpsConnection = (HttpsURLConnection) connection; 662 | if (!sslCmds.getValidate()) { 663 | httpsConnection.setHostnameVerifier(new HostnameVerifier() { 664 | @Override 665 | public boolean verify(String s, SSLSession sslSession) { 666 | return true; 667 | } 668 | }); 669 | httpsConnection.setSSLSocketFactory(sslCmds.getCustomContext().getSocketFactory()); 670 | } 671 | } 672 | super.prepareConnection(connection, httpMethod); 673 | } 674 | } 675 | } 676 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/Links.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | 6 | import org.codehaus.jackson.annotate.JsonIgnore; 7 | import org.codehaus.jackson.annotate.JsonUnwrapped; 8 | import org.springframework.expression.AccessException; 9 | import org.springframework.expression.EvaluationContext; 10 | import org.springframework.expression.PropertyAccessor; 11 | import org.springframework.expression.TypedValue; 12 | import org.springframework.hateoas.Link; 13 | 14 | /** 15 | * @author Jon Brisbin 16 | */ 17 | public class Links { 18 | 19 | private final PropertyAccessor propertyAccessor = new Accessor(); 20 | private final List links = new ArrayList(); 21 | 22 | public Links() { 23 | } 24 | 25 | @JsonUnwrapped 26 | public List getLinks() { 27 | return this.links; 28 | } 29 | 30 | public void addLink(Link link) { 31 | links.add(link); 32 | } 33 | 34 | @JsonIgnore 35 | public PropertyAccessor getPropertyAccessor() { 36 | return propertyAccessor; 37 | } 38 | 39 | private class Accessor implements PropertyAccessor { 40 | 41 | @Override public Class[] getSpecificTargetClasses() { 42 | return new Class[]{Links.class}; 43 | } 44 | 45 | @Override public boolean canRead(EvaluationContext context, Object target, String name) throws AccessException { 46 | return (target instanceof Links); 47 | } 48 | 49 | @Override public TypedValue read(EvaluationContext context, Object target, String name) throws AccessException { 50 | for(Link link : links) { 51 | if(link.getRel().equals(name)) { 52 | return new TypedValue(link); 53 | } 54 | } 55 | return null; 56 | } 57 | 58 | @Override public boolean canWrite(EvaluationContext context, Object target, String name) throws AccessException { 59 | return false; 60 | } 61 | 62 | @Override public void write(EvaluationContext context, Object target, String name, Object newValue) 63 | throws AccessException { 64 | 65 | } 66 | 67 | } 68 | 69 | } 70 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/PathOrRel.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | /** 4 | * @author Jon Brisbin 5 | */ 6 | public class PathOrRel { 7 | 8 | private final String path; 9 | 10 | public PathOrRel(String path) { 11 | this.path = path; 12 | } 13 | 14 | public String getPath() { 15 | return path; 16 | } 17 | 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/PathOrRelConverter.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.util.List; 4 | import java.util.Map; 5 | 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.shell.core.Completion; 8 | import org.springframework.shell.core.Converter; 9 | import org.springframework.shell.core.MethodTarget; 10 | import org.springframework.stereotype.Component; 11 | 12 | /** 13 | * @author Jon Brisbin 14 | */ 15 | @Component 16 | public class PathOrRelConverter implements Converter { 17 | 18 | 19 | @Autowired 20 | private DiscoveryCommands discoveryCmds; 21 | @Autowired 22 | private ContextCommands contextCmds; 23 | 24 | @Override public boolean supports(Class type, String optionContext) { 25 | return PathOrRel.class.isAssignableFrom(type); 26 | } 27 | 28 | @Override public PathOrRel convertFromText(String value, 29 | Class targetType, 30 | String optionContext) { 31 | String relOrPath = contextCmds.evalAsString(value); 32 | if(discoveryCmds.getResources().containsKey(relOrPath)) { 33 | return new PathOrRel(discoveryCmds.getResources().get(relOrPath)); 34 | } else { 35 | return new PathOrRel(relOrPath); 36 | } 37 | } 38 | 39 | @Override 40 | public boolean getAllPossibleValues(List completions, 41 | Class targetType, 42 | String existingData, 43 | String optionContext, 44 | MethodTarget target) { 45 | for(Map.Entry entry : discoveryCmds.getResources().entrySet()) { 46 | if(entry.getKey().startsWith(existingData)) { 47 | completions.add(new Completion(entry.getKey())); 48 | } 49 | } 50 | return true; 51 | } 52 | 53 | } 54 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/commands/SslCommands.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.commands; 2 | 3 | import java.io.File; 4 | import java.io.FileInputStream; 5 | import java.io.IOException; 6 | import java.security.KeyManagementException; 7 | import java.security.KeyStore; 8 | import java.security.KeyStoreException; 9 | import java.security.NoSuchAlgorithmException; 10 | import java.security.cert.CertificateException; 11 | import java.security.cert.X509Certificate; 12 | import javax.net.ssl.KeyManager; 13 | import javax.net.ssl.KeyManagerFactory; 14 | import javax.net.ssl.SSLContext; 15 | import javax.net.ssl.TrustManager; 16 | import javax.net.ssl.TrustManagerFactory; 17 | import javax.net.ssl.X509TrustManager; 18 | 19 | import org.springframework.shell.core.CommandMarker; 20 | import org.springframework.shell.core.annotation.CliCommand; 21 | import org.springframework.shell.core.annotation.CliOption; 22 | import org.springframework.stereotype.Component; 23 | 24 | /** 25 | * Commands for managing SSL configuration. 26 | * 27 | * @author Jon Brisbin 28 | */ 29 | @Component 30 | public class SslCommands implements CommandMarker { 31 | 32 | private final SSLContext defaultContext; 33 | private SSLContext customContext; 34 | private boolean validate = true; 35 | private KeyManager[] keyManagers; 36 | private TrustManager[] trustManagers; 37 | private File truststore; 38 | private String truststorePassword; 39 | private File keystore; 40 | private String keystorePassword; 41 | 42 | { 43 | try { 44 | defaultContext = SSLContext.getDefault(); 45 | } catch(NoSuchAlgorithmException e) { 46 | throw new IllegalStateException(e.getMessage(), e); 47 | } 48 | } 49 | 50 | public SSLContext getCustomContext() { 51 | return (null == customContext ? defaultContext : customContext); 52 | } 53 | 54 | public KeyManager[] getKeyManagers() throws IOException, 55 | KeyStoreException, 56 | NoSuchAlgorithmException, 57 | CertificateException { 58 | if(null != keystore) { 59 | KeyStore keyks = KeyStore.getInstance("JKS"); 60 | keyks.load(new FileInputStream(keystore), keystorePassword.toCharArray()); 61 | KeyManagerFactory keyfac = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm()); 62 | keyManagers = keyfac.getKeyManagers(); 63 | } 64 | 65 | return keyManagers; 66 | } 67 | 68 | public TrustManager[] getTrustManagers() throws KeyStoreException, 69 | IOException, 70 | NoSuchAlgorithmException, 71 | CertificateException { 72 | if(!validate) { 73 | return new TrustManager[]{ 74 | new X509TrustManager() { 75 | @Override public void checkClientTrusted(X509Certificate[] x509Certificates, 76 | String s) throws CertificateException { 77 | 78 | } 79 | 80 | @Override public void checkServerTrusted(X509Certificate[] x509Certificates, 81 | String s) throws CertificateException { 82 | 83 | } 84 | 85 | @Override public X509Certificate[] getAcceptedIssuers() { 86 | return null; 87 | } 88 | } 89 | }; 90 | } else if(null != truststore) { 91 | KeyStore trustks = KeyStore.getInstance("JKS"); 92 | trustks.load(new FileInputStream(truststore), truststorePassword.toCharArray()); 93 | TrustManagerFactory trustfac = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm()); 94 | trustManagers = trustfac.getTrustManagers(); 95 | } 96 | 97 | return trustManagers; 98 | } 99 | 100 | public boolean getValidate() { 101 | return validate; 102 | } 103 | 104 | @CliCommand(value = "ssl reset", help = "Reset the SSL configuration back to the system default") 105 | public void reset() { 106 | SSLContext.setDefault(defaultContext); 107 | } 108 | 109 | @CliCommand(value = "ssl truststore", help = "Manage the truststore TrustManagers") 110 | public void truststore( 111 | @CliOption( 112 | key = "file", 113 | mandatory = true, 114 | help = "Set the truststore file to use for SSL") File truststore, 115 | @CliOption( 116 | key = "password", 117 | mandatory = false, 118 | help = "Set the truststore password to use for SSL") String password) throws IOException, 119 | NoSuchAlgorithmException, 120 | KeyManagementException, 121 | KeyStoreException, 122 | CertificateException { 123 | this.truststore = truststore; 124 | this.truststorePassword = (null == password ? "" : password); 125 | setCustomContext(); 126 | } 127 | 128 | @CliCommand(value = "ssl keystore", help = "Manage the keystore KeyManagers") 129 | public void keystore( 130 | @CliOption( 131 | key = "file", 132 | mandatory = true, 133 | help = "Set the keystore file to use for SSL") File keystore, 134 | @CliOption( 135 | key = "password", 136 | mandatory = false, 137 | help = "Set the keystore password to use for SSL") String password) throws IOException, 138 | NoSuchAlgorithmException, 139 | KeyManagementException, 140 | KeyStoreException, 141 | CertificateException { 142 | this.keystore = keystore; 143 | this.keystorePassword = (null == password ? "" : password); 144 | setCustomContext(); 145 | } 146 | 147 | @CliCommand(value = "ssl validate", help = "Manage settings for validation of SSL certificates") 148 | public void validate( 149 | @CliOption( 150 | key = "enabled", 151 | mandatory = false, 152 | unspecifiedDefaultValue = "true", 153 | help = "Turns certificate checking on or off") boolean enabled) throws 154 | NoSuchAlgorithmException, 155 | KeyManagementException, 156 | IOException, 157 | KeyStoreException, 158 | CertificateException { 159 | this.validate = enabled; 160 | setCustomContext(); 161 | } 162 | 163 | private void setCustomContext() throws NoSuchAlgorithmException, 164 | IOException, 165 | KeyStoreException, 166 | CertificateException, 167 | KeyManagementException { 168 | customContext = SSLContext.getInstance("TLS"); 169 | customContext.init(getKeyManagers(), getTrustManagers(), null); 170 | } 171 | 172 | } 173 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/context/BaseUriChangedEvent.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.context; 2 | 3 | import java.net.URI; 4 | 5 | import org.springframework.context.ApplicationEvent; 6 | 7 | /** 8 | * @author Jon Brisbin 9 | */ 10 | public class BaseUriChangedEvent extends ApplicationEvent { 11 | 12 | public BaseUriChangedEvent(URI baseUri) { 13 | super(baseUri); 14 | } 15 | 16 | public URI getBaseUri() { 17 | return (URI)getSource(); 18 | } 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/context/HeaderSetEvent.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.context; 2 | 3 | import org.springframework.context.ApplicationEvent; 4 | import org.springframework.http.HttpHeaders; 5 | 6 | /** 7 | * Event emitted when an HTTP header is set. 8 | * 9 | * @author Jon Brisbin 10 | */ 11 | public class HeaderSetEvent extends ApplicationEvent { 12 | 13 | private String name; 14 | 15 | public HeaderSetEvent(String name, HttpHeaders headers) { 16 | super(headers); 17 | this.name = name; 18 | } 19 | 20 | public String getName() { 21 | return name; 22 | } 23 | 24 | public HttpHeaders getHeaders() { 25 | return (HttpHeaders)getSource(); 26 | } 27 | 28 | } 29 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/context/ResponseEvent.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.context; 2 | 3 | import java.net.URI; 4 | 5 | import org.springframework.context.ApplicationEvent; 6 | import org.springframework.http.HttpMethod; 7 | import org.springframework.http.ResponseEntity; 8 | 9 | /** 10 | * @author Jon Brisbin 11 | */ 12 | public class ResponseEvent extends ApplicationEvent { 13 | 14 | private URI requestUri; 15 | private HttpMethod method; 16 | 17 | public ResponseEvent(URI requestUri, HttpMethod method, ResponseEntity response) { 18 | super(response); 19 | this.requestUri = requestUri; 20 | this.method = method; 21 | } 22 | 23 | public URI getRequestUri() { 24 | return requestUri; 25 | } 26 | 27 | public HttpMethod getMethod() { 28 | return method; 29 | } 30 | 31 | @SuppressWarnings({"unchecked"}) 32 | public ResponseEntity getResponse() { 33 | return (ResponseEntity)getSource(); 34 | } 35 | 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/context/UserConfig.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.context; 2 | 3 | import org.springframework.beans.factory.annotation.Qualifier; 4 | import org.springframework.context.annotation.Configuration; 5 | import org.springframework.context.annotation.ImportResource; 6 | 7 | /** 8 | * @author Jon Brisbin 9 | */ 10 | @Configuration 11 | @ImportResource("classpath*:META-INF/rest-shell/**/*.xml") 12 | @Qualifier("restShellUserConfig") 13 | public class UserConfig { 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/formatter/FormatProvider.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.formatter; 2 | 3 | import java.util.ArrayList; 4 | import java.util.Collection; 5 | 6 | import org.springframework.stereotype.Component; 7 | 8 | @Component 9 | public class FormatProvider { 10 | private final Collection availableFormatter = new ArrayList(); 11 | private final NoOpFormatter noOpFormatter = new NoOpFormatter(); 12 | 13 | public FormatProvider() { 14 | availableFormatter.add(new XmlFormatter()); 15 | availableFormatter.add(new JsonFormatter()); 16 | } 17 | 18 | public Formatter getFormatter(String contentType) { 19 | for(Formatter formatter : availableFormatter) { 20 | if(formatter.isSupported(contentType)) { 21 | return formatter; 22 | } 23 | } 24 | 25 | return noOpFormatter; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/formatter/Formatter.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.formatter; 2 | 3 | public interface Formatter { 4 | boolean isSupported(String contentType); 5 | String format(String nonFormattedString); 6 | } 7 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/formatter/FormatterSupport.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.formatter; 2 | 3 | import java.util.Collection; 4 | 5 | public abstract class FormatterSupport implements Formatter { 6 | @Override 7 | public boolean isSupported(String contentType) { 8 | boolean supported = false; 9 | for (String subType : getSupportedList()) { 10 | supported = contentType.indexOf(subType) > 0; 11 | if(supported) { 12 | break; 13 | } 14 | } 15 | return supported; 16 | } 17 | 18 | public abstract Collection getSupportedList(); 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/formatter/JsonFormatter.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.formatter; 2 | 3 | import java.io.IOException; 4 | import java.util.Arrays; 5 | import java.util.Collection; 6 | import java.util.List; 7 | import java.util.Map; 8 | 9 | import org.codehaus.jackson.map.ObjectMapper; 10 | import org.codehaus.jackson.map.SerializationConfig; 11 | import org.springframework.http.converter.HttpMessageNotReadableException; 12 | 13 | /** 14 | * @author Jon Brisbin 15 | */ 16 | public class JsonFormatter extends FormatterSupport { 17 | 18 | private static final List SUPPORTED = Arrays.asList("json"); 19 | private final ObjectMapper mapper = new ObjectMapper(); 20 | 21 | { 22 | mapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true); 23 | } 24 | 25 | @Override public Collection getSupportedList() { 26 | return SUPPORTED; 27 | } 28 | 29 | @Override public String format(String nonFormattedString) { 30 | Object obj; 31 | try { 32 | if(nonFormattedString.startsWith("[")) { 33 | obj = mapper.readValue(nonFormattedString.getBytes(), List.class); 34 | } else { 35 | obj = mapper.readValue(nonFormattedString.getBytes(), Map.class); 36 | } 37 | return mapper.writeValueAsString(obj); 38 | } catch(IOException e) { 39 | throw new HttpMessageNotReadableException(e.getMessage(), e); 40 | } 41 | } 42 | 43 | } 44 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/formatter/NoOpFormatter.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.formatter; 2 | 3 | public class NoOpFormatter implements Formatter { 4 | @Override 5 | public boolean isSupported(String contentType) { 6 | return true; 7 | } 8 | 9 | @Override 10 | public String format(String nonFormattedString) { 11 | return nonFormattedString; 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/formatter/XmlFormatter.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.formatter; 2 | 3 | import java.io.ByteArrayInputStream; 4 | import java.io.ByteArrayOutputStream; 5 | import java.util.Arrays; 6 | import java.util.Collection; 7 | import java.util.List; 8 | import javax.xml.transform.OutputKeys; 9 | import javax.xml.transform.Source; 10 | import javax.xml.transform.Transformer; 11 | import javax.xml.transform.sax.SAXSource; 12 | import javax.xml.transform.sax.SAXTransformerFactory; 13 | import javax.xml.transform.stream.StreamResult; 14 | 15 | import org.xml.sax.InputSource; 16 | 17 | public class XmlFormatter extends FormatterSupport { 18 | private final List supportedContentTypes = Arrays.asList("xml"); 19 | 20 | @Override 21 | public Collection getSupportedList() { 22 | return supportedContentTypes; 23 | } 24 | 25 | @Override 26 | public String format(String nonFormattedString) { 27 | try { 28 | Transformer serializer = SAXTransformerFactory.newInstance().newTransformer(); 29 | serializer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes"); 30 | serializer.setOutputProperty(OutputKeys.INDENT, "yes"); 31 | serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2"); 32 | Source xmlSource = new SAXSource(new InputSource(new ByteArrayInputStream(nonFormattedString.getBytes()))); 33 | StreamResult res = new StreamResult(new ByteArrayOutputStream()); 34 | 35 | serializer.transform(xmlSource, res); 36 | 37 | return new String(((ByteArrayOutputStream) res.getOutputStream()).toByteArray()); 38 | } catch (Exception e) { 39 | return nonFormattedString; 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/resources/PagableResources.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.resources; 2 | 3 | import org.springframework.hateoas.Resources; 4 | 5 | /** 6 | * @author Jon Brisbin 7 | */ 8 | public class PagableResources extends Resources { 9 | 10 | private Page page; 11 | 12 | public Page getPage() { 13 | return page; 14 | } 15 | 16 | public void setPage(Page page) { 17 | this.page = page; 18 | } 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/org/springframework/data/rest/shell/resources/Page.java: -------------------------------------------------------------------------------- 1 | package org.springframework.data.rest.shell.resources; 2 | 3 | /** 4 | * @author Jon Brisbin 5 | */ 6 | public class Page { 7 | 8 | int size; 9 | long totalElements; 10 | int totalPages; 11 | int number; 12 | 13 | public int getSize() { 14 | return size; 15 | } 16 | 17 | public void setSize(int size) { 18 | this.size = size; 19 | } 20 | 21 | public long getTotalElements() { 22 | return totalElements; 23 | } 24 | 25 | public void setTotalElements(long totalElements) { 26 | this.totalElements = totalElements; 27 | } 28 | 29 | public int getTotalPages() { 30 | return totalPages; 31 | } 32 | 33 | public void setTotalPages(int totalPages) { 34 | this.totalPages = totalPages; 35 | } 36 | 37 | public int getNumber() { 38 | return number; 39 | } 40 | 41 | public void setNumber(int number) { 42 | this.number = number; 43 | } 44 | 45 | } 46 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring/spring-shell-plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /src/main/resources/logback.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 7 | 8 | 9 | 10 | 11 | 12 | .rest-shell.log 13 | true 14 | 15 | 16 | %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | --------------------------------------------------------------------------------