Permalink
Browse files

JBEAP-14084: Create shared content - Pulled out more common content i…

…nto shared docs; restructured Configure the Server sections to be consistent in backup, starting the server, configuration, restore
  • Loading branch information...
sgilda authored and ctomc committed Jan 23, 2018
1 parent 7de01c4 commit 401bd7f79750c0d35fc978de16ea96d707508b38
Showing with 919 additions and 1,305 deletions.
  1. +1 −0 .gitignore
  2. +2 −2 README.adoc
  3. +2 −2 app-client/README.adoc
  4. +5 −9 batch-processing/README.adoc
  5. +9 −7 bean-validation-custom-constraint/README.adoc
  6. +5 −7 bean-validation/README.adoc
  7. +5 −7 bmt/README.adoc
  8. +1 −2 buildReadmes.sh
  9. +5 −7 cmt/README.adoc
  10. +5 −8 ejb-asynchronous/README.adoc
  11. +5 −8 ejb-in-ear/README.adoc
  12. +5 −7 ejb-in-war/README.adoc
  13. +5 −7 ejb-multi-server/README.adoc
  14. +65 −98 ejb-security-context-propagation/README.adoc
  15. +41 −68 ejb-security-jaas/README.adoc
  16. +40 −69 ejb-security-programmatic-auth/README.adoc
  17. +41 −65 ejb-security/README.adoc
  18. +5 −8 ejb-throws-exception/README.adoc
  19. +5 −9 ejb-timer/README.adoc
  20. +5 −7 greeter/README.adoc
  21. +5 −8 ha-singleton-deployment/README.adoc
  22. +5 −8 ha-singleton-service/README.adoc
  23. +37 −64 helloworld-jms/README.adoc
  24. +36 −61 helloworld-mdb-propertysubstitution/README.adoc
  25. +5 −7 helloworld-mdb/README.adoc
  26. +36 −66 helloworld-mutual-ssl-secured/README.adoc
  27. +32 −59 helloworld-mutual-ssl/README.adoc
  28. +5 −8 helloworld-rs/README.adoc
  29. +5 −8 helloworld-singleton/README.adoc
  30. +48 −75 helloworld-ssl/README.adoc
  31. +5 −8 helloworld-ws/README.adoc
  32. +5 −7 helloworld/README.adoc
  33. +12 −11 hibernate/README.adoc
  34. +5 −8 inter-app/README.adoc
  35. +5 −8 jaxrs-client/README.adoc
  36. +5 −8 jaxws-addressing/README.adoc
  37. +6 −8 jaxws-ejb/README.adoc
  38. +5 −8 jaxws-pojo/README.adoc
  39. +6 −8 jaxws-retail/README.adoc
  40. +5 −8 jsonp/README.adoc
  41. +5 −8 jta-crash-rec/README.adoc
  42. +1 −1 jts-distributed-crash-rec/README.adoc
  43. +5 −8 kitchensink-ear/README.adoc
  44. +5 −8 kitchensink-jsp/README.adoc
  45. +5 −8 kitchensink-ml/README.adoc
  46. +5 −8 kitchensink/README.adoc
  47. +5 −8 logging-tools/README.adoc
  48. +32 −52 logging/README.adoc
  49. +41 −66 mail/README.adoc
  50. +7 −10 managed-executor-service/README.adoc
  51. +5 −8 numberguess/README.adoc
  52. +5 −8 payment-cdi-event/README.adoc
  53. +5 −8 servlet-async/README.adoc
  54. +5 −8 servlet-filterlistener/README.adoc
  55. +36 −65 servlet-security/README.adoc
  56. +15 −0 shared-doc/back-up-managed-domain-configuration.adoc
  57. +21 −0 shared-doc/back-up-server-standalone-configuration.adoc
  58. +8 −0 shared-doc/debug-the-application.adoc
  59. +12 −0 shared-doc/restore-managed-domain-configuration-manual.adoc
  60. +19 −0 shared-doc/restore-standalone-server-configuration-manual.adoc
  61. +34 −0 shared-doc/restore-standalone-server-configuration.adoc
  62. +45 −79 shopping-cart/README.adoc
  63. +5 −8 tasks-rs/README.adoc
  64. +5 −8 tasks/README.adoc
  65. +5 −8 temperature-converter/README.adoc
  66. +8 −11 template/README.adoc
  67. +10 −18 thread-racing/README.adoc
  68. +5 −8 websocket-client/README.adoc
  69. +5 −8 websocket-endpoint/README.adoc
  70. +5 −8 websocket-hello/README.adoc
  71. +5 −8 wsat-simple/README.adoc
  72. +5 −8 wsba-coordinator-completion-simple/README.adoc
  73. +5 −8 wsba-participant-completion-simple/README.adoc
  74. +5 −8 xml-jaxp/README.adoc
View
@@ -1,4 +1,5 @@
*~
build
target
.DS_Store
bin
View
@@ -4,7 +4,7 @@
:jbossHomeName: WILDFLY_HOME
:productVersion: 12
:ext-relative: {outfilesuffix}
include::attributes.adoc[]
include::shared-doc/attributes.adoc[]
[abstract]
The quickstarts demonstrate Java EE 7 and a few additional technologies from the JBoss stack. They provide small, specific, working examples that can be used as a reference for your own project.
@@ -48,7 +48,7 @@ NOTE: Some of these quickstarts use the H2 database included with {productName}.
[cols="1,1,2,1,1", options="header"]
|===
| Quickstart Name | Demonstrated Technologies | Description | Experience Level Required | Prerequisites
| link:app-client/README{outfilesuffix}[app-client]|EJB, EAR, AppClient | The `app-client` quickstart demonstrates how to code and package a client app and use the {productName} client container to start the client Main program. | Intermediate | _none_
| link:app-client/README{outfilesuffix}[app-client]|EJB, EAR, AppClient | The `app-client` quickstart demonstrates how to code and package a client app and use the {productName} client container to start the client `Main` program. | Intermediate | _none_
| link:batch-processing/README{outfilesuffix}[batch-processing]|CDI, Batch 1.0, JSF | The `batch-processing` quickstart shows how to use chunk oriented batch jobs to import a file to a database. | Intermediate | _none_
| link:bean-validation/README{outfilesuffix}[bean-validation]|CDI, JPA, BV | The `bean-validation` quickstart provides Arquillian tests to demonstrate how to use CDI, JPA, and Bean Validation. | Beginner | _none_
| link:bean-validation-custom-constraint/README{outfilesuffix}[bean-validation-custom-constraint]|CDI, JPA, BV | The `bean-validation-custom-constraint` quickstart demonstrates how to use the Bean Validation API to define custom constraints and validators. | Beginner | _none_
View
@@ -12,7 +12,7 @@ include::../shared-doc/attributes.adoc[]
:source: {githubRepoUrl}
[abstract]
The `app-client` quickstart demonstrates how to code and package a client app and use the {productName} client container to start the client Main program.
The `app-client` quickstart demonstrates how to code and package a client app and use the {productName} client container to start the client `Main` program.
== What is it?
@@ -82,7 +82,7 @@ include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1]
== Build and Deploy the Quickstart
. Make sure you have started the {productName} server as described above.
. Make sure you xref:start_eap_standalone_server_with_the_default_profile[start the {productName} server with the standalone default profile] as described above.
. Open a terminal and navigate to the root directory of this quickstart.
. Type the following command to build the artifacts.
+
@@ -186,12 +186,8 @@ $ mvn wildfly:undeploy
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
[[debug_the_application]]
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
[source,options="nowrap"]
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
@@ -98,17 +98,19 @@ HHH000431: Unable to determine H2 database version, certain features may not wor
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
// Additional debugging information
[NOTE]
====
You might see the following message when you run the command. It indicates the source is not provided in the third-party `antlr` JAR.
----
[INFO] The following files have NOT been resolved:
[INFO] antlr:antlr:jar:sources:2.7.7:provided
----
====
@@ -99,10 +99,8 @@ HHH000431: Unable to determine H2 database version, certain features may not wor
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
View
@@ -101,10 +101,8 @@ $ mvn wildfly:undeploy
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
View
@@ -6,7 +6,7 @@ NO_COLOR="\033[0m"
usage(){
cat <<EOM
Run this script from the root of your cloned repository:
Run this script from the root of your cloned repository:
~/eap-quickstarts $ ./buildReadmes.sh
EOM
@@ -49,4 +49,3 @@ else
echo -e "${RED}Please fix all issues before requesting a merge!${NO_COLOR}"
exit 1;
fi
View
@@ -126,10 +126,8 @@ You can also start the server and deploy the quickstarts or run the Arquillian t
NOTE: Within JBoss Developer Studio, make sure you define a server runtime environment that uses the `standalone-full.xml` configuration file.
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
@@ -130,11 +130,8 @@ This quickstart consists of multiple projects, so it deploys and runs differentl
** The client output displays in the *Console* window.
. To undeploy the project, right-click on the *{artifactId}-ejb* project and choose *Run As* -> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*.
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
[source,options="nowrap"]
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
View
@@ -104,11 +104,8 @@ For this quickstart, follow the special instructions to build link:{useEclipseDe
. This starts the server, deploys the application, and opens a browser window that accesses the running application.
. To undeploy the project, right-click on the *{artifactId}-ear* project and choose *Run As* -> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*.
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
[source,options="nowrap"]
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
View
@@ -111,10 +111,8 @@ INFO [org.jboss.as.server] (management-handler-thread - 30) WFLYSRV0009: Undepl
You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use JBoss Developer Studio or Eclipse to Run the Quickstarts].
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
@@ -275,10 +275,8 @@ NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat`.
EJB Client (ejb-client) currently has limited support in the Eclipse Web Tools Platform (WTP). For that reason, this quickstart is not supported in Red Hat JBoss Developer Studio.
== Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
----
$ mvn dependency:sources
----
//*************************************************
// Add info to debug the application
//*************************************************
// == Debug the Application
include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
Oops, something went wrong.

0 comments on commit 401bd7f

Please sign in to comment.