You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2019/10/30 20:14:04 UTC
[juneau-petstore] 03/31: Readme file cleanup.
This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau-petstore.git
commit ec767d9bcbf2d78c8b2144b7fc5c729b6bae6d07
Author: JamesBognar <ja...@apache.org>
AuthorDate: Mon Sep 9 20:20:11 2019 -0400
Readme file cleanup.
---
README.md | 19 ++++-
juneau-petstore-api/pom.xml | 21 ------
juneau-petstore-api/src/assembly/bin.xml | 58 ---------------
juneau-petstore-client/pom.xml | 21 ------
juneau-petstore-server/pom.xml | 21 ------
pom.xml | 123 ++-----------------------------
6 files changed, 22 insertions(+), 241 deletions(-)
diff --git a/README.md b/README.md
index 5620d2d..6e8fd55 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,21 @@
***************************************************************************************************************************
-->
-# Juneau
+# Juneau Petstore
-Please visit the [home page](http://juneau.apache.org) for more information about this project.
+A sample application that shows the capabilities of the Juneau REST platform with Spring Boot and other technologies
+to produce end-to-end REST microservices.
+
+Juneau provides the following capabilities:
+
+- Ability to serialize/parse Java POJOs to a wide variety of languages.
+- Ability to construct REST interfaces using annotated POJOs.
+- Ability to create Java interface proxies against remote REST interfaces.
+
+The project is broken down into the following subprojects:
+
+- juneau-petstore-api - Contains the Java interface and DTOs for the petstore application.
+- juneau-petstore-server - Contains the server-side Java implementation of the petstore Java interface as a REST resource.
+- juneau-petstore-client - Contains the client-side Java proxy of the petstore Java interface.
+
+More information for this project can be found [here](http://juneau.apache.org/index.html#petstore.html)
\ No newline at end of file
diff --git a/juneau-petstore-api/pom.xml b/juneau-petstore-api/pom.xml
index 36b41e9..0f9bc87 100644
--- a/juneau-petstore-api/pom.xml
+++ b/juneau-petstore-api/pom.xml
@@ -72,27 +72,6 @@
</execution>
</executions>
</plugin>
- <plugin>
- <artifactId>maven-assembly-plugin</artifactId>
- <configuration>
- <escapeString>\</escapeString>
- </configuration>
- <executions>
- <execution>
- <id>juneau-assembly</id>
- <phase>package</phase>
- <goals>
- <goal>single</goal>
- </goals>
- <configuration>
- <finalName>juneau-examples-petstore-api-${project.version}</finalName>
- <descriptors>
- <descriptor>src/assembly/bin.xml</descriptor>
- </descriptors>
- </configuration>
- </execution>
- </executions>
- </plugin>
</plugins>
</build>
diff --git a/juneau-petstore-api/src/assembly/bin.xml b/juneau-petstore-api/src/assembly/bin.xml
deleted file mode 100644
index 17e8ca8..0000000
--- a/juneau-petstore-api/src/assembly/bin.xml
+++ /dev/null
@@ -1,58 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ***************************************************************************************************************************
- * 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. *
- ***************************************************************************************************************************
--->
-
-<!--
- This assembly is used to create the template zip file that developers use to import into Eclipse to start their
- own projects.
- -->
-<assembly
- xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
- <id>bin</id>
- <formats>
- <format>zip</format>
- </formats>
- <baseDirectory>/</baseDirectory>
- <includeBaseDirectory>true</includeBaseDirectory>
- <fileSets>
- <fileSet>
- <directory>${basedir}/../juneau-examples-petstore-api</directory>
- <outputDirectory>/</outputDirectory>
- <includes>
- <include>src/main/**</include>
- </includes>
- </fileSet>
- <fileSet>
- <directory>${basedir}</directory>
- <outputDirectory>/</outputDirectory>
- <includes>
- <include>src/main/**</include>
- <include>files/**</include>
- <include>.settings/**</include>
- <include>.project</include>
- <include>*.launch</include>
- <include>*.cfg</include>
- </includes>
- </fileSet>
- <fileSet>
- <directory>${basedir}/build-overlay</directory>
- <outputDirectory>/</outputDirectory>
- <filtered>true</filtered>
- </fileSet>
- </fileSets>
-
-</assembly>
\ No newline at end of file
diff --git a/juneau-petstore-client/pom.xml b/juneau-petstore-client/pom.xml
index b2e073c..874c2d6 100644
--- a/juneau-petstore-client/pom.xml
+++ b/juneau-petstore-client/pom.xml
@@ -72,27 +72,6 @@
</execution>
</executions>
</plugin>
- <plugin>
- <artifactId>maven-assembly-plugin</artifactId>
- <configuration>
- <escapeString>\</escapeString>
- </configuration>
- <executions>
- <execution>
- <id>juneau-assembly</id>
- <phase>package</phase>
- <goals>
- <goal>single</goal>
- </goals>
- <configuration>
- <finalName>juneau-petstore-client-${project.version}</finalName>
- <descriptors>
- <descriptor>src/assembly/bin.xml</descriptor>
- </descriptors>
- </configuration>
- </execution>
- </executions>
- </plugin>
</plugins>
</build>
diff --git a/juneau-petstore-server/pom.xml b/juneau-petstore-server/pom.xml
index 76d7fe0..a95cb8c 100644
--- a/juneau-petstore-server/pom.xml
+++ b/juneau-petstore-server/pom.xml
@@ -113,27 +113,6 @@
</execution>
</executions>
</plugin>
- <plugin>
- <artifactId>maven-assembly-plugin</artifactId>
- <configuration>
- <escapeString>\</escapeString>
- </configuration>
- <executions>
- <execution>
- <id>juneau-assembly</id>
- <phase>package</phase>
- <goals>
- <goal>single</goal>
- </goals>
- <configuration>
- <finalName>juneau-petstore-server-${project.version}</finalName>
- <descriptors>
- <descriptor>src/assembly/bin.xml</descriptor>
- </descriptors>
- </configuration>
- </execution>
- </executions>
- </plugin>
</plugins>
</build>
diff --git a/pom.xml b/pom.xml
index a6918b1..cec0948 100644
--- a/pom.xml
+++ b/pom.xml
@@ -131,76 +131,6 @@
<pluginManagement>
<plugins>
-
- <!-- Generates the javadocs for all non-test projects. -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.10.4</version>
- <configuration>
- <additionalJOptions>
- <additionalJOption>-J-DjuneauVersion=${juneauVersion}</additionalJOption>
- <additionalJOption>-J-DjuneauVersionNext=${juneauVersionNext}</additionalJOption>
- </additionalJOptions>
- <show>protected</show>
- <windowtitle>${project.name} ${project.version}</windowtitle>
- <author>true</author>
- <linksource>true</linksource>
- <source>1.8</source>
- <bootclasspath>${sun.boot.class.path}</bootclasspath>
- <overview>${basedir}/juneau-doc/src/main/javadoc/overview.html</overview>
- <stylesheetfile>${basedir}/juneau-doc/src/main/javadoc/javadoc.css</stylesheetfile>
- <use>false</use>
- <additionalparam>-sourcetab 3 -notimestamp -Xdoclint:none --allow-script-in-comments</additionalparam>
- <verbose>false</verbose>
- <excludePackageNames>*proto*:*test*:org.apache.juneau.doc.internal</excludePackageNames>
- <linksource>true</linksource>
- <links>
- <link>https://docs.oracle.com/javase/8/docs/api/</link>
- <link>https://docs.oracle.com/javaee/5/api/</link>
- </links>
- <docfilessubdirs>true</docfilessubdirs>
- <javadocDirectory>${basedir}/juneau-doc/src/main/javadoc</javadocDirectory>
- <taglets>
- <taglet>
- <tagletClass>org.apache.juneau.doc.internal.DocTag</tagletClass>
- <tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
- </taglet>
- <taglet>
- <tagletClass>org.apache.juneau.doc.internal.PropertyTag</tagletClass>
- <tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
- </taglet>
- <taglet>
- <tagletClass>org.apache.juneau.doc.internal.FragmentTag</tagletClass>
- <tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
- </taglet>
- <taglet>
- <tagletClass>org.apache.juneau.doc.internal.SourceTag</tagletClass>
- <tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
- </taglet>
-
- <!--org.apache.juneau.doc.internal.DocTag</taglet-->
- <!-- taglet>org.apache.juneau.doc.internal.PropertyTag</taglet-->
- </taglets>
- <tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
- </configuration>
- <executions>
- <execution>
- <id>attach-javadocs</id>
- <goals>
- <goal>jar</goal>
- </goals>
- </execution>
- <execution>
- <id>aggregate</id>
- <phase>site</phase>
- <goals>
- <goal>aggregate</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
-
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
@@ -239,50 +169,7 @@
</plugins>
</pluginManagement>
</build>
-
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.10.4</version>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
- <version>2.5</version>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-report-plugin</artifactId>
- <version>2.18</version>
- <configuration>
- <aggregate>true</aggregate>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.jacoco</groupId>
- <artifactId>jacoco-maven-plugin</artifactId>
- <version>0.8.2</version>
- <configuration>
- <excludes>
- <exclude>**/doc/**/*</exclude>
- <exclude>**/examples/**/*</exclude>
- <exclude>**/testutils/**/*</exclude>
- </excludes>
- <fileSets>
- <fileSet implementation="org.apache.maven.shared.model.fileset.FileSet">
- <directory>${project.parent.build.directory}</directory>
- <includes>
- <include>*.exec</include>
- </includes>
- </fileSet>
- </fileSets>
- </configuration>
- </plugin>
- </plugins>
- </reporting>
-
+
<url>https://juneau.apache.org/</url>
<!-- Inherited from parent pom
<organization>
@@ -290,12 +177,12 @@
<url>https://www.apache.org/</url>
</organization>
-->
- <inceptionYear>2016</inceptionYear>
+ <inceptionYear>2019</inceptionYear>
<scm>
- <connection>scm:git:https://gitbox.apache.org/repos/asf/juneau.git</connection>
- <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/juneau.git</developerConnection>
- <url>https://github.com/apache/juneau</url>
+ <connection>scm:git:https://gitbox.apache.org/repos/asf/juneau-petstore.git</connection>
+ <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/juneau-petstore.git</developerConnection>
+ <url>https://github.com/apache/juneau-petstore</url>
<tag>HEAD</tag>
</scm>
<issueManagement>