├── .gitignore ├── LICENSE.TXT ├── README.md ├── pom.xml └── src └── main ├── java └── de │ └── codecentric │ └── boot │ └── admin │ ├── config │ └── SpringBootAdminClientAutoConfiguration.java │ ├── controller │ ├── LogfileController.java │ └── RefreshController.java │ ├── model │ └── Application.java │ ├── services │ └── SpringBootAdminRegistratorTask.java │ └── web │ └── SimpleCORSFilter.java └── resources └── META-INF └── spring.factories /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /.settings 3 | /.classpath 4 | /.project 5 | /dev/ 6 | -------------------------------------------------------------------------------- /LICENSE.TXT: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | spring-boot-starter-admin-client 2 | ================================ 3 | 4 | This [Spring-Boot starter](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-starter-poms "Spring Boot docu") that provides services and controllers that a required if an application show be able to be administrated with the [spring-boot-admin application](https://github.com/codecentric/spring-boot-admin "GitHub project"). 5 | 6 | This client uses the [AutoConfiguration](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration "Spring Boot docu") feature of Spring Boot to register service and controller beans in the application context. 7 | 8 | The main service that is used is a registrar that registeres the application at the spring-boot-admin application by periodically calling a REST-API to check or perform the registration of itself. 9 | 10 | The following properties have to be included in the environment (i.e. application.properties) to ensure all features to work properly. 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 |
info.idThe identifier in the registry - this property is published by the /info endpoint
info.versionThe version number - also published by the /info endpoint
spring.boot.admin.urlURL of the spring-boot-admin application to register at
logging.fileFile path of the logfile of the application
26 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 3 | 4.0.0 4 | de.codecentric 5 | spring-boot-starter-admin-client 6 | 1.0.1.RELEASE 7 | 8 | org.springframework.boot 9 | spring-boot-starters 10 | 1.1.4.RELEASE 11 | 12 | 13 | 14 | Apache License, Version 2.0 15 | http://opensource.org/licenses/Apache-2.0 16 | repo 17 | 18 | 19 | 20 | 21 | org.springframework.boot 22 | spring-boot-starter 23 | 24 | 25 | org.springframework.boot 26 | spring-boot-starter-actuator 27 | 28 | 29 | org.springframework.boot 30 | spring-boot-starter-web 31 | 32 | 33 | org.springframework 34 | spring-web 35 | 36 | 37 | org.jolokia 38 | jolokia-core 39 | 40 | 41 | 42 | 43 | 44 | org.apache.maven.plugins 45 | maven-source-plugin 46 | 47 | 48 | 49 | jar 50 | 51 | 52 | 53 | 54 | 55 | org.apache.maven.plugins 56 | maven-javadoc-plugin 57 | 58 | 59 | 60 | jar 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | -------------------------------------------------------------------------------- /src/main/java/de/codecentric/boot/admin/config/SpringBootAdminClientAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2014 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package de.codecentric.boot.admin.config; 17 | 18 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 19 | import org.springframework.context.annotation.Bean; 20 | import org.springframework.context.annotation.Configuration; 21 | import org.springframework.scheduling.config.ScheduledTaskRegistrar; 22 | 23 | import de.codecentric.boot.admin.controller.LogfileController; 24 | import de.codecentric.boot.admin.controller.RefreshController; 25 | import de.codecentric.boot.admin.services.SpringBootAdminRegistratorTask; 26 | import de.codecentric.boot.admin.web.SimpleCORSFilter; 27 | 28 | /** 29 | * This configuration adds a registrator bean to the spring context. This bean checks periodicaly, if the using 30 | * application is registered at the spring-boot-admin application. If not, it registers itself. 31 | */ 32 | @Configuration 33 | public class SpringBootAdminClientAutoConfiguration { 34 | 35 | /** 36 | * Task that registers the application at the spring-boot-admin application. 37 | */ 38 | @Bean 39 | public SpringBootAdminRegistratorTask registrator() { 40 | return new SpringBootAdminRegistratorTask(); 41 | } 42 | 43 | /** 44 | * HTTP filter to enable Cross-Origin Resource Sharing. 45 | */ 46 | @Bean 47 | public SimpleCORSFilter corsFilter() { 48 | return new SimpleCORSFilter(); 49 | } 50 | 51 | /** 52 | * TaskRegistrar that triggers the RegistratorTask every ten seconds. 53 | */ 54 | @Bean 55 | public ScheduledTaskRegistrar taskRegistrar() { 56 | ScheduledTaskRegistrar registrar = new ScheduledTaskRegistrar(); 57 | registrar.addFixedRateTask(registrator(), 10000); 58 | return registrar; 59 | } 60 | 61 | /** 62 | * Controller to do something with the application logfile(s). 63 | */ 64 | @Bean 65 | @ConditionalOnProperty("logging.file") 66 | public LogfileController logfileController() { 67 | return new LogfileController(); 68 | } 69 | 70 | /** 71 | * Controller to do a refresh on the application. 72 | */ 73 | @Bean 74 | public RefreshController refreshController() { 75 | return new RefreshController(); 76 | } 77 | 78 | } 79 | -------------------------------------------------------------------------------- /src/main/java/de/codecentric/boot/admin/controller/LogfileController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2014 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package de.codecentric.boot.admin.controller; 17 | 18 | import java.io.IOException; 19 | 20 | import javax.servlet.http.HttpServletResponse; 21 | 22 | import org.slf4j.Logger; 23 | import org.slf4j.LoggerFactory; 24 | import org.springframework.beans.factory.annotation.Autowired; 25 | import org.springframework.core.env.Environment; 26 | import org.springframework.core.io.FileSystemResource; 27 | import org.springframework.core.io.Resource; 28 | import org.springframework.stereotype.Controller; 29 | import org.springframework.util.FileCopyUtils; 30 | import org.springframework.web.bind.annotation.RequestMapping; 31 | import org.springframework.web.bind.annotation.ResponseBody; 32 | 33 | /** 34 | * Controller that provides an API for logfiles, i.e. downloading the main logfile configured in environment property 35 | * 'logging.file' that is standard, but optional property for spring-boot applications. 36 | */ 37 | @Controller 38 | public class LogfileController { 39 | 40 | private static final Logger LOGGER = LoggerFactory.getLogger(LogfileController.class); 41 | 42 | @Autowired 43 | private Environment env; 44 | 45 | @RequestMapping("/logfile") 46 | @ResponseBody 47 | public String getLogfile(HttpServletResponse response) { 48 | String path = env.getProperty("logging.file"); 49 | if (path == null) { 50 | LOGGER.error("Logfile download failed for missing property 'logging.file'"); 51 | return "Logfile download failed for missing property 'logging.file'"; 52 | } 53 | Resource file = new FileSystemResource(path); 54 | if (!file.exists()) { 55 | LOGGER.error("Logfile download failed for missing file at path=" + path); 56 | return "Logfile download failed for missing file at path=" + path; 57 | } 58 | response.setContentType("application/octet-stream"); 59 | response.setHeader("Content-Disposition", "attachment; filename=\"" + file.getFilename() + "\""); 60 | try { 61 | FileCopyUtils.copy(file.getInputStream(), response.getOutputStream()); 62 | } catch (IOException e) { 63 | LOGGER.error("Logfile download failed for path=" + path); 64 | return "Logfile download failed for path=" + path; 65 | } 66 | return null; 67 | } 68 | 69 | } 70 | -------------------------------------------------------------------------------- /src/main/java/de/codecentric/boot/admin/controller/RefreshController.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2014 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package de.codecentric.boot.admin.controller; 17 | 18 | import org.slf4j.Logger; 19 | import org.slf4j.LoggerFactory; 20 | import org.springframework.beans.factory.annotation.Autowired; 21 | import org.springframework.context.ConfigurableApplicationContext; 22 | import org.springframework.stereotype.Controller; 23 | import org.springframework.web.bind.annotation.RequestMapping; 24 | import org.springframework.web.bind.annotation.RequestMethod; 25 | import org.springframework.web.bind.annotation.ResponseBody; 26 | 27 | /** 28 | * Refresh the application context i.e. to reload changed properties files. 29 | */ 30 | @Controller 31 | public class RefreshController { 32 | 33 | private static final Logger LOGGER = LoggerFactory.getLogger(RefreshController.class); 34 | 35 | @Autowired 36 | private ConfigurableApplicationContext context; 37 | 38 | @RequestMapping(value = "/refresh", method = RequestMethod.POST) 39 | @ResponseBody 40 | public String refresh() { 41 | // Doesn't work in spring-boot at the moment ... (v 1.1.0) 42 | LOGGER.warn("Refreshing application doesn't work at the moment"); 43 | return "Refreshing application doesn't work at the moment"; 44 | // context.refresh(); 45 | } 46 | 47 | } 48 | -------------------------------------------------------------------------------- /src/main/java/de/codecentric/boot/admin/model/Application.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2014 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package de.codecentric.boot.admin.model; 17 | 18 | import java.io.Serializable; 19 | 20 | /** 21 | * The domain model for all registered application at the spring boot admin application. 22 | */ 23 | public class Application implements Serializable { 24 | 25 | private static final long serialVersionUID = 1L; 26 | 27 | private String id; 28 | 29 | private String url; 30 | 31 | public String getId() { 32 | return id; 33 | } 34 | 35 | public void setId(String id) { 36 | this.id = id; 37 | } 38 | 39 | public String getUrl() { 40 | return url; 41 | } 42 | 43 | public void setUrl(String url) { 44 | this.url = url; 45 | } 46 | 47 | @Override 48 | public String toString() { 49 | return id + " : " + url; 50 | } 51 | 52 | @Override 53 | public int hashCode() { 54 | final int prime = 31; 55 | int result = 1; 56 | result = prime * result + ((id == null) ? 0 : id.hashCode()); 57 | result = prime * result + ((url == null) ? 0 : url.hashCode()); 58 | return result; 59 | } 60 | 61 | @Override 62 | public boolean equals(Object obj) { 63 | if (this == obj) 64 | return true; 65 | if (obj == null) 66 | return false; 67 | if (getClass() != obj.getClass()) 68 | return false; 69 | Application other = (Application) obj; 70 | if (id == null) { 71 | if (other.id != null) 72 | return false; 73 | } else if (!id.equals(other.id)) 74 | return false; 75 | if (url == null) { 76 | if (other.url != null) 77 | return false; 78 | } else if (!url.equals(other.url)) 79 | return false; 80 | return true; 81 | } 82 | 83 | } 84 | -------------------------------------------------------------------------------- /src/main/java/de/codecentric/boot/admin/services/SpringBootAdminRegistratorTask.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2014 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package de.codecentric.boot.admin.services; 17 | 18 | import java.net.InetAddress; 19 | import java.net.URL; 20 | import java.util.ArrayList; 21 | 22 | import javax.annotation.PostConstruct; 23 | 24 | import org.slf4j.Logger; 25 | import org.slf4j.LoggerFactory; 26 | import org.springframework.beans.factory.annotation.Autowired; 27 | import org.springframework.core.env.Environment; 28 | import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; 29 | import org.springframework.util.Assert; 30 | import org.springframework.web.client.RestTemplate; 31 | 32 | import de.codecentric.boot.admin.model.Application; 33 | 34 | /** 35 | * Scheduler that checks the registration of the application at the spring-boot-admin. 36 | */ 37 | public class SpringBootAdminRegistratorTask implements Runnable { 38 | 39 | private static final Logger LOGGER = LoggerFactory.getLogger(SpringBootAdminRegistratorTask.class); 40 | 41 | @Autowired 42 | private Environment env; 43 | 44 | @PostConstruct 45 | public void check() { 46 | Assert.notNull(env.getProperty("spring.boot.admin.url"), 47 | "The URL of the spring-boot-admin application is mandatory"); 48 | Assert.notNull(env.getProperty("server.port"), "The server port of the application is mandatory"); 49 | Assert.notNull(env.getProperty("info.id"), "The id of the application is mandatory"); 50 | } 51 | 52 | /** 53 | * @see java.lang.Runnable#run() 54 | */ 55 | @Override 56 | public void run() { 57 | try { 58 | String id = env.getProperty("info.id"); 59 | int port = env.getProperty("server.port", Integer.class); 60 | String adminUrl = env.getProperty("spring.boot.admin.url"); 61 | RestTemplate template = new RestTemplate(); 62 | template.getMessageConverters().add(new MappingJackson2HttpMessageConverter()); 63 | ApplicationList list = template.getForObject(adminUrl + "/api/applications", ApplicationList.class); 64 | for (Application app : list) { 65 | if (id.equals(app.getId())) { 66 | // the application is already registered at the admin tool 67 | LOGGER.debug("Application already registered with ID '{}'", id); 68 | return; 69 | } 70 | } 71 | // register the application with the used URL and port 72 | String url = new URL("http", InetAddress.getLocalHost().getCanonicalHostName(), port, "").toString(); 73 | Application app = new Application(); 74 | app.setId(id); 75 | app.setUrl(url); 76 | template.postForObject(adminUrl + "/api/applications", app, String.class); 77 | LOGGER.info("Application registered itself at the admin application with ID '{}' and URL '{}'", id, url); 78 | } catch (Exception e) { 79 | LOGGER.warn("Failed to register application at spring-boot-admin, message={}", e.getMessage()); 80 | } 81 | } 82 | 83 | private static class ApplicationList extends ArrayList { 84 | private static final long serialVersionUID = 1L; 85 | } 86 | 87 | } 88 | -------------------------------------------------------------------------------- /src/main/java/de/codecentric/boot/admin/web/SimpleCORSFilter.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2014 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package de.codecentric.boot.admin.web; 17 | 18 | import java.io.IOException; 19 | 20 | import javax.servlet.Filter; 21 | import javax.servlet.FilterChain; 22 | import javax.servlet.FilterConfig; 23 | import javax.servlet.ServletException; 24 | import javax.servlet.ServletRequest; 25 | import javax.servlet.ServletResponse; 26 | import javax.servlet.http.HttpServletResponse; 27 | 28 | import org.springframework.beans.factory.annotation.Value; 29 | 30 | /** 31 | * Request filter to allow Cross-Origin Resource Sharing. 32 | */ 33 | public class SimpleCORSFilter implements Filter { 34 | 35 | // Configurable origin for CORS - default: * (all) 36 | @Value("${http.filter.cors.origin:*}") 37 | private String origin; 38 | 39 | /** 40 | * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, 41 | * javax.servlet.FilterChain) 42 | */ 43 | @Override 44 | public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, 45 | ServletException { 46 | HttpServletResponse res = (HttpServletResponse) response; 47 | res.setHeader("Access-Control-Allow-Origin", origin); 48 | chain.doFilter(request, res); 49 | } 50 | 51 | /** 52 | * @see javax.servlet.Filter#destroy() 53 | */ 54 | @Override 55 | public void destroy() { 56 | // nop 57 | } 58 | 59 | /** 60 | * @see javax.servlet.Filter#init(javax.servlet.FilterConfig) 61 | */ 62 | @Override 63 | public void init(FilterConfig filterConfig) throws ServletException { 64 | // nop 65 | } 66 | 67 | } 68 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=de.codecentric.boot.admin.config.SpringBootAdminClientAutoConfiguration --------------------------------------------------------------------------------