CAMEL-10561: camel-catalog - Add REST JAX-RS application
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/6e7c1044 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6e7c1044 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6e7c1044 Branch: refs/heads/master Commit: 6e7c1044d317c0822bde1e75b46629ec680018bb Parents: 03b6fe7 Author: Claus Ibsen <[email protected]> Authored: Tue Dec 6 13:52:04 2016 +0100 Committer: Claus Ibsen <[email protected]> Committed: Tue Dec 6 14:00:43 2016 +0100 ---------------------------------------------------------------------- platforms/catalog-rest-app/pom.xml | 125 ++++++++++++ .../catalog/rest/CamelCatalogRestMain.java | 95 +++++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + .../src/main/resources/log4j2.properties | 28 +++ platforms/catalog-rest/pom.xml | 1 + .../src/main/docs/camel-catalog-rest.adoc | 14 ++ .../camel/catalog/rest/CamelCatalogRest.java | 1 + platforms/pom.xml | 1 + 9 files changed, 479 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/catalog-rest-app/pom.xml ---------------------------------------------------------------------- diff --git a/platforms/catalog-rest-app/pom.xml b/platforms/catalog-rest-app/pom.xml new file mode 100644 index 0000000..744cfae --- /dev/null +++ b/platforms/catalog-rest-app/pom.xml @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>platforms</artifactId> + <version>2.19.0-SNAPSHOT</version> + </parent> + + <artifactId>camel-catalog-rest-app</artifactId> + <packaging>jar</packaging> + <name>Camel :: Platforms :: Catalog :: REST App</name> + <description>Camel Catalog REST standalone application</description> + + <dependencies> + + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-catalog-rest</artifactId> + </dependency> + + <!-- cxf --> + <dependency> + <groupId>org.apache.cxf</groupId> + <artifactId>cxf-core</artifactId> + <version>${cxf-version}</version> + </dependency> + <dependency> + <groupId>org.apache.cxf</groupId> + <artifactId>cxf-rt-frontend-jaxrs</artifactId> + <version>${cxf-version}</version> + </dependency> + <dependency> + <groupId>org.apache.cxf</groupId> + <artifactId>cxf-rt-transports-http</artifactId> + <version>${cxf-version}</version> + </dependency> + <dependency> + <groupId>org.apache.cxf</groupId> + <artifactId>cxf-rt-transports-http-jetty</artifactId> + <version>${cxf-version}</version> + </dependency> + <dependency> + <groupId>org.apache.cxf</groupId> + <artifactId>cxf-rt-rs-service-description-swagger</artifactId> + <version>${cxf-version}</version> + </dependency> + + <!-- to support json --> + <dependency> + <groupId>org.apache.cxf</groupId> + <artifactId>cxf-rt-rs-extension-providers</artifactId> + <version>${cxf-version}</version> + </dependency> + <dependency> + <groupId>com.fasterxml.jackson.jaxrs</groupId> + <artifactId>jackson-jaxrs-json-provider</artifactId> + </dependency> + <dependency> + <groupId>com.fasterxml.jackson.core</groupId> + <artifactId>jackson-databind</artifactId> + </dependency> + + <!-- swagger ui --> + <dependency> + <groupId>org.webjars</groupId> + <artifactId>swagger-ui</artifactId> + <version>${swagger-ui-version}</version> + </dependency> + <dependency> + <groupId>org.eclipse.jetty</groupId> + <artifactId>jetty-webapp</artifactId> + <version>${jetty9-version}</version> + <scope>test</scope> + </dependency> + + <!-- logging --> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-api</artifactId> + </dependency> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-core</artifactId> + </dependency> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-slf4j-impl</artifactId> + </dependency> + + </dependencies> + + <build> + <plugins> + + <!-- to start the application using mvn compile exec:java --> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>exec-maven-plugin</artifactId> + <configuration> + <mainClass>org.apache.camel.catalog.rest.CamelCatalogRestMain</mainClass> + </configuration> + </plugin> + + </plugins> + </build> + + </project> http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/catalog-rest-app/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRestMain.java ---------------------------------------------------------------------- diff --git a/platforms/catalog-rest-app/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRestMain.java b/platforms/catalog-rest-app/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRestMain.java new file mode 100644 index 0000000..9f22952 --- /dev/null +++ b/platforms/catalog-rest-app/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRestMain.java @@ -0,0 +1,95 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.catalog.rest; + +import java.io.Console; + +import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider; +import org.apache.cxf.endpoint.Server; +import org.apache.cxf.jaxrs.JAXRSServerFactoryBean; +import org.apache.cxf.jaxrs.lifecycle.SingletonResourceProvider; +import org.apache.cxf.jaxrs.swagger.Swagger2Feature; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Main to start the Camel Catalog REST Api application which runs standalone using an embedded CXF/Jetty server + * with embedded Swagger Doc and Swagger UI. + */ +public class CamelCatalogRestMain { + + private static final Logger LOGGER = LoggerFactory.getLogger(CamelCatalogRestMain.class); + + private Server server; + private CamelCatalogRest catalog; + private int port = 8080; + + public static void main(String[] args) { + CamelCatalogRestMain me = new CamelCatalogRestMain(); + me.run(); + } + + public void run() { + LOGGER.info("Starting ..."); + + catalog = new CamelCatalogRest(); + + // setup Apache CXF REST server + JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean(); + sf.setResourceClasses(CamelCatalogRest.class); + sf.setResourceProvider(CamelCatalogRest.class, new SingletonResourceProvider(catalog)); + + Swagger2Feature swagger = new Swagger2Feature(); + swagger.setBasePath("/"); + swagger.setScanAllResources(false); + swagger.setPrettyPrint(true); + swagger.setSupportSwaggerUi(true); + swagger.setTitle("Camel Catalog REST Api"); + swagger.setDescription("REST Api for the Camel Catalog"); + swagger.setVersion(catalog.getCatalogVersion()); + swagger.setContact("Apache Camel"); + sf.getFeatures().add(swagger); + + // to use jackson for json + sf.setProvider(JacksonJsonProvider.class); + sf.setAddress("http://localhost:"; + port); + + // create and start the CXF server (non blocking) + server = sf.create(); + server.start(); + + LOGGER.info("CamelCatalog REST Api started"); + LOGGER.info(""); + LOGGER.info("\tRest API base path: http://localhost:{}/camel-catalog";, port); + LOGGER.info("\tRest API version: http://localhost:{}/camel-catalog/catalogVersion";, port); + LOGGER.info("\tSwagger Doc: http://localhost:{}/swagger.json";, port); + LOGGER.info("\tSwagger UI: http://localhost:{}/api-docs?url=/swagger.json";, port); + LOGGER.info(""); + + LOGGER.info("Press Enter to stop"); + Console console = System.console(); + console.readLine(); + + LOGGER.info("Stopping ..."); + + server.stop(); + server.destroy(); + LOGGER.info("CamelCatalog REST Api stopped"); + System.exit(0); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/catalog-rest-app/src/main/resources/META-INF/LICENSE.txt ---------------------------------------------------------------------- diff --git a/platforms/catalog-rest-app/src/main/resources/META-INF/LICENSE.txt b/platforms/catalog-rest-app/src/main/resources/META-INF/LICENSE.txt new file mode 100755 index 0000000..6b0b127 --- /dev/null +++ b/platforms/catalog-rest-app/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/catalog-rest-app/src/main/resources/META-INF/NOTICE.txt ---------------------------------------------------------------------- diff --git a/platforms/catalog-rest-app/src/main/resources/META-INF/NOTICE.txt b/platforms/catalog-rest-app/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/platforms/catalog-rest-app/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/catalog-rest-app/src/main/resources/log4j2.properties ---------------------------------------------------------------------- diff --git a/platforms/catalog-rest-app/src/main/resources/log4j2.properties b/platforms/catalog-rest-app/src/main/resources/log4j2.properties new file mode 100644 index 0000000..d2bafca --- /dev/null +++ b/platforms/catalog-rest-app/src/main/resources/log4j2.properties @@ -0,0 +1,28 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- + +appender.file.type = File +appender.file.name = file +appender.file.fileName = target/camel-catalog-app.log +appender.file.layout.type = PatternLayout +appender.file.layout.pattern = %d [%-15.15t] %-5p %-30.30c{1} - %m%n +appender.out.type = Console +appender.out.name = out +appender.out.layout.type = PatternLayout +appender.out.layout.pattern = %d [%-15.15t] %-5p %-30.30c{1} - %m%n +rootLogger.level = INFO +rootLogger.appenderRef.out.ref = out http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/catalog-rest/pom.xml ---------------------------------------------------------------------- diff --git a/platforms/catalog-rest/pom.xml b/platforms/catalog-rest/pom.xml index b1e8784..4ebc70f 100644 --- a/platforms/catalog-rest/pom.xml +++ b/platforms/catalog-rest/pom.xml @@ -87,6 +87,7 @@ <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-rs-extension-providers</artifactId> <version>${cxf-version}</version> + <scope>test</scope> </dependency> <dependency> <groupId>com.fasterxml.jackson.jaxrs</groupId> http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/catalog-rest/src/main/docs/camel-catalog-rest.adoc ---------------------------------------------------------------------- diff --git a/platforms/catalog-rest/src/main/docs/camel-catalog-rest.adoc b/platforms/catalog-rest/src/main/docs/camel-catalog-rest.adoc index 28424b7..825c06f 100644 --- a/platforms/catalog-rest/src/main/docs/camel-catalog-rest.adoc +++ b/platforms/catalog-rest/src/main/docs/camel-catalog-rest.adoc @@ -29,3 +29,17 @@ host the Camel Catalog REST API. </dependency> ``` +== Trying the CamelCatalog REST Api + +You can try the rest api by running the `camel-rest-app` application + +``` + cd camel-rest-app + mvn compile exec:java +``` + +Then a little standalone application with CXF and embedded Jetty starts up the Camel Catalog REST API service +which you can access using the urls the application logs to the console. + +The application has built in Swagger UI which you can use to try the api. + http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java ---------------------------------------------------------------------- diff --git a/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java b/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java index 98a79e3..5f32298 100644 --- a/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java +++ b/platforms/catalog-rest/src/main/java/org/apache/camel/catalog/rest/CamelCatalogRest.java @@ -51,6 +51,7 @@ public class CamelCatalogRest { @GET @Path("/catalogVersion") + @Produces("text/plain") @ApiOperation(value = "The version of this Camel Catalog") public String getCatalogVersion() { return catalog.getCatalogVersion(); http://git-wip-us.apache.org/repos/asf/camel/blob/6e7c1044/platforms/pom.xml ---------------------------------------------------------------------- diff --git a/platforms/pom.xml b/platforms/pom.xml index 0f58ebf..dbee2ea 100644 --- a/platforms/pom.xml +++ b/platforms/pom.xml @@ -40,6 +40,7 @@ <module>catalog-lucene</module> <module>catalog-maven</module> <module>catalog-rest</module> + <module>catalog-rest-app</module> <module>catalog-provider-karaf</module> <module>catalog-provider-springboot</module> </modules>
