From 401bd7f79750c0d35fc978de16ea96d707508b38 Mon Sep 17 00:00:00 2001 From: Sande Gilda Date: Tue, 23 Jan 2018 14:45:43 -0500 Subject: [PATCH] JBEAP-14084: Create shared content - Pulled out more common content into shared docs; restructured Configure the Server sections to be consistent in backup, starting the server, configuration, restore --- .gitignore | 1 + README.adoc | 4 +- app-client/README.adoc | 4 +- batch-processing/README.adoc | 14 +- bean-validation-custom-constraint/README.adoc | 16 +- bean-validation/README.adoc | 12 +- bmt/README.adoc | 12 +- buildReadmes.sh | 3 +- cmt/README.adoc | 12 +- ejb-asynchronous/README.adoc | 13 +- ejb-in-ear/README.adoc | 13 +- ejb-in-war/README.adoc | 12 +- ejb-multi-server/README.adoc | 12 +- ejb-security-context-propagation/README.adoc | 163 +++++++----------- ejb-security-jaas/README.adoc | 109 +++++------- ejb-security-programmatic-auth/README.adoc | 109 +++++------- ejb-security/README.adoc | 106 +++++------- ejb-throws-exception/README.adoc | 13 +- ejb-timer/README.adoc | 14 +- greeter/README.adoc | 12 +- ha-singleton-deployment/README.adoc | 13 +- ha-singleton-service/README.adoc | 13 +- helloworld-jms/README.adoc | 101 ++++------- .../README.adoc | 97 ++++------- helloworld-mdb/README.adoc | 12 +- helloworld-mutual-ssl-secured/README.adoc | 102 ++++------- helloworld-mutual-ssl/README.adoc | 91 ++++------ helloworld-rs/README.adoc | 13 +- helloworld-singleton/README.adoc | 13 +- helloworld-ssl/README.adoc | 123 ++++++------- helloworld-ws/README.adoc | 13 +- helloworld/README.adoc | 12 +- hibernate/README.adoc | 23 +-- inter-app/README.adoc | 13 +- jaxrs-client/README.adoc | 13 +- jaxws-addressing/README.adoc | 13 +- jaxws-ejb/README.adoc | 14 +- jaxws-pojo/README.adoc | 13 +- jaxws-retail/README.adoc | 14 +- jsonp/README.adoc | 13 +- jta-crash-rec/README.adoc | 13 +- jts-distributed-crash-rec/README.adoc | 2 +- kitchensink-ear/README.adoc | 13 +- kitchensink-jsp/README.adoc | 13 +- kitchensink-ml/README.adoc | 13 +- kitchensink/README.adoc | 13 +- logging-tools/README.adoc | 13 +- logging/README.adoc | 84 ++++----- mail/README.adoc | 107 +++++------- managed-executor-service/README.adoc | 17 +- numberguess/README.adoc | 13 +- payment-cdi-event/README.adoc | 13 +- servlet-async/README.adoc | 13 +- servlet-filterlistener/README.adoc | 13 +- servlet-security/README.adoc | 101 ++++------- .../back-up-managed-domain-configuration.adoc | 15 ++ ...ck-up-server-standalone-configuration.adoc | 21 +++ shared-doc/debug-the-application.adoc | 8 + ...e-managed-domain-configuration-manual.adoc | 12 ++ ...tandalone-server-configuration-manual.adoc | 19 ++ ...store-standalone-server-configuration.adoc | 34 ++++ shopping-cart/README.adoc | 124 +++++-------- tasks-rs/README.adoc | 13 +- tasks/README.adoc | 13 +- temperature-converter/README.adoc | 13 +- template/README.adoc | 19 +- thread-racing/README.adoc | 28 ++- websocket-client/README.adoc | 13 +- websocket-endpoint/README.adoc | 13 +- websocket-hello/README.adoc | 13 +- wsat-simple/README.adoc | 13 +- .../README.adoc | 13 +- .../README.adoc | 13 +- xml-jaxp/README.adoc | 13 +- 74 files changed, 919 insertions(+), 1305 deletions(-) create mode 100644 shared-doc/back-up-managed-domain-configuration.adoc create mode 100644 shared-doc/back-up-server-standalone-configuration.adoc create mode 100644 shared-doc/debug-the-application.adoc create mode 100644 shared-doc/restore-managed-domain-configuration-manual.adoc create mode 100644 shared-doc/restore-standalone-server-configuration-manual.adoc create mode 100644 shared-doc/restore-standalone-server-configuration.adoc diff --git a/.gitignore b/.gitignore index 0c226bf576..9611d8d0a0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ *~ +build target .DS_Store bin diff --git a/README.adoc b/README.adoc index 01b9e5f6fe..2147808a82 100644 --- a/README.adoc +++ b/README.adoc @@ -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_ diff --git a/app-client/README.adoc b/app-client/README.adoc index 2de61228d8..c7469efe84 100644 --- a/app-client/README.adoc +++ b/app-client/README.adoc @@ -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. + diff --git a/batch-processing/README.adoc b/batch-processing/README.adoc index 7916b58998..336972654b 100644 --- a/batch-processing/README.adoc +++ b/batch-processing/README.adoc @@ -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] diff --git a/bean-validation-custom-constraint/README.adoc b/bean-validation-custom-constraint/README.adoc index 227d08834c..88b8cc2587 100644 --- a/bean-validation-custom-constraint/README.adoc +++ b/bean-validation-custom-constraint/README.adoc @@ -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 ---- +==== diff --git a/bean-validation/README.adoc b/bean-validation/README.adoc index 568dc4fa3c..017eca5d25 100644 --- a/bean-validation/README.adoc +++ b/bean-validation/README.adoc @@ -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] diff --git a/bmt/README.adoc b/bmt/README.adoc index 1fa6d0efa5..dec8120aaa 100644 --- a/bmt/README.adoc +++ b/bmt/README.adoc @@ -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] diff --git a/buildReadmes.sh b/buildReadmes.sh index 994bfce483..64f83d1ec2 100755 --- a/buildReadmes.sh +++ b/buildReadmes.sh @@ -6,7 +6,7 @@ NO_COLOR="\033[0m" usage(){ cat < *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] diff --git a/ejb-in-ear/README.adoc b/ejb-in-ear/README.adoc index e9350445f1..688f72f609 100644 --- a/ejb-in-ear/README.adoc +++ b/ejb-in-ear/README.adoc @@ -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] diff --git a/ejb-in-war/README.adoc b/ejb-in-war/README.adoc index 0751588767..4b18a425a1 100644 --- a/ejb-in-war/README.adoc +++ b/ejb-in-war/README.adoc @@ -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] diff --git a/ejb-multi-server/README.adoc b/ejb-multi-server/README.adoc index 9d1e14b71d..90904d4dac 100644 --- a/ejb-multi-server/README.adoc +++ b/ejb-multi-server/README.adoc @@ -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] diff --git a/ejb-security-context-propagation/README.adoc b/ejb-security-context-propagation/README.adoc index 30487ca095..5dc8d3ea09 100644 --- a/ejb-security-context-propagation/README.adoc +++ b/ejb-security-context-propagation/README.adoc @@ -22,10 +22,10 @@ remote EJB in {productNameFull}. The quickstart makes use of two EJBs, xref:secured_ejb[`SecuredEJB`] and xref:intermediate_ejb[`IntermediateEJB`], to verify that the security context propagation is correct, and a xref:remote_client[`RemoteClient`] standalone client. [[secured_ejb]] -=== SecuredEJB +SecuredEJB:: The `SecuredEJB` has four methods. - ++ [source, java] ---- String getSecurityInformation(); @@ -33,31 +33,31 @@ String guestMethod(); String userMethod(); String adminMethod(); ---- - -The first method can be called by all users that are created in this quickstart. The purpose of this method is to return a -`String` containing the name of the `Principal` that called the EJB, along with the user's authorized role information, for example: - ++ +The `getSecurityInformation()` method can be called by all users that are created in this quickstart. +The purpose of this method is to return a `String` containing the name of the `Principal` that called the EJB, along with the user's authorized role information, for example: ++ [source,options="nowrap"] ---- [Principal=[quickstartUser], In role [guest]=true, In role [user]=true, In role [admin]=false] ---- - -The next three methods are annotated to require that the calling user is authorized for roles `guest`, `user` and `admin` respectively. ++ +The `guestMethod()`, `userMethod()`, and `adminMethod()`` methods are annotated to require that the calling user is authorized for roles `guest`, `user` and `admin` respectively. [[intermediate_ejb]] -=== IntermediateEJB +IntermediateEJB:: -The `IntermediateEJB` contains a single method. Its purpose is to make use of a remote connection and invoke each of the -methods on the `SecuredEJB`. A summary is then returned with the outcome of the calls. +The `IntermediateEJB` contains a single method. +Its purpose is to make use of a remote connection and invoke each of the methods on the `SecuredEJB`. +A summary is then returned with the outcome of the calls. [[remote_client]] -=== RemoteClient +RemoteClient:: Finally there is the `RemoteClient` stand-alone client. The client makes calls using the identity of the established connection. - -In the real world, remote calls between servers in the servers-to-server scenario would truly be remote and separate. For -the purpose of this quickstart, we make use of a loopback connection to the same server so we do not need two servers just -to run the test. ++ +In the real world, remote calls between servers in the servers-to-server scenario would truly be remote and separate. +For the purpose of this quickstart, we make use of a loopback connection to the same server so we do not need two servers just to run the test. //************************************************* // Add System Requirements @@ -106,25 +106,28 @@ The `quickstart` user establishes the actual connection to the server. If you prefer, you can use the `add-user` utility interactively. For an example of how to use the add-user utility, see the instructions located here: link:{addApplicationUserDocUrl}[Add an Application User]. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + [[configure_the_server]] == Configure the Server -These steps assume you are running the server in standalone mode and using the default `standalone.xml` supplied with the distribution. - You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-elytron.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: -** If it is running, stop the {productName} server. -** Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-elytron.cli` file in the root of this quickstart directory. This script adds the configuration that enables Elytron security for the quickstart deployment. Comments in the script describe the purpose of each block of commands. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: @@ -135,9 +138,10 @@ $ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=configure-elytron.cli ---- + NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. - + -. Because this example quickstart demonstrates security, exceptions are thrown when secured EJB access is attempted by an invalid user. If you want to review the security exceptions in the server log, you can skip this step. If you want to suppress these exceptions in the server log, run the following command, replacing `__{jbossHomeName}__` with the path to your server: + +. Because this example quickstart demonstrates security, system exceptions are thrown when secured EJB access is attempted by an invalid user. If you want to review the security exceptions in the server log, you can skip this step. If you want to suppress these exceptions in the server log, run the following command, replacing `__{jbossHomeName}__` with the path to your server: +[[suppress_system_exceptions]] + [source,subs="+quotes,attributes+",options="nowrap"] ---- @@ -224,28 +228,16 @@ For the purpose of the quickstart we just need an outbound connection that loops ---- -. If you ran the script to suppress system exceptions, you should see the following configuration in the `ejb3` subsystem. +. If you xref:suppress_system_exceptions[ran the script to suppress system exceptions], you should see the following configuration in the `ejb3` subsystem. + [source,xml,options="nowrap"] ---- ---- -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 this command to build and deploy the archive: + @@ -253,7 +245,7 @@ NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. $ mvn clean package wildfly:deploy ---- -. This will deploy `target/{artifactId}.jar` to the running instance of the server. +. This will deploy the `target/{artifactId}.jar` to the running instance of the server. == Run the Client @@ -297,7 +289,7 @@ secured EJB and their roles have been correctly evaluated. == Investigate the Server Console Output -If you did not run the script to suppress system exceptions, you should see the following exceptions in the {productName} +If you did not xref:suppress_system_exceptions[run the script to suppress system exceptions], you should see the following exceptions in the {productName} server console or log. The exceptions are logged for each of the tests where a request is rejected because the user is not authorized. @@ -339,7 +331,9 @@ authorized. == Undeploy the Archive -. Make sure you have started the {productName} server as described above. +When you are finished testing, follow these steps to undeploy the archive. + +. 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. . When you are finished testing, type this command to undeploy the archive: + @@ -347,61 +341,37 @@ authorized. $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration - -You can restore the original server configuration by running the `restore-configuration.cli` script provided in the root directory of this quickstart or by manually restoring the backup copy the configuration file. - -=== Restore the Server Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-configuration.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. -+ +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-configuration.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] +// Additional information about this script This script reverts the changes made to the `ejb3`, `elytron` and `remoting` subsystems. You should see the following result when you run the script. -+ + [source,options="nowrap"] ---- The batch executed successfully process-state: reload-required ---- -. If ran the script to suppress system exceptions, run the following command, replacing `__{jbossHomeName}__` with the path to your server. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-system-exception.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. +[NOTE] +==== +If you xref:suppress_system_exceptions[ran the script to suppress system exceptions], you need to restore the logging of system exceptions. Run the above command, passing `restore-system-exception.cli` instead of `restore-configuration.cli` for the file name. You should see the following result when you run the script. -+ -You should see the following result when you run the script. -+ [source,options="nowrap"] ---- The batch executed successfully ---- +==== -=== Restore the Server Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the backup copy of the file. +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] [[run_the_quickstart_in_jboss_developer_studio_or_eclipse]] == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse @@ -417,13 +387,10 @@ This quickstart requires additional configuration and deploys and runs different . Choose *RemoteClient - org.jboss.as.quickstarts.ejb_security_context_propagation* and click *OK*. . Review the output in the console window. . To undeploy the project, right-click on the *{artifactId}* project and choose *Run As* -> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*. -. Make sure you xref:restore_the_server_configuration[Restore the Server Configuration] when you have completed testing this quickstart. - -== Debug the Application +. Make sure you xref:restore_the_server_configuration[restore the server configuration] when you have completed testing this quickstart. -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] diff --git a/ejb-security-jaas/README.adoc b/ejb-security-jaas/README.adoc index 83e0e84fe6..cd0db696ea 100644 --- a/ejb-security-jaas/README.adoc +++ b/ejb-security-jaas/README.adoc @@ -66,26 +66,29 @@ quickstartUser=guest This concludes the configuration required by the legacy `JAAS` login module used in this quickstart. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + [[configure_the_server]] == Configure the Server -These steps assume you are running the server in standalone mode and using the default `standalone.xml` supplied with the distribution. - You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-elytron-jaas.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: + +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. -** If it is running, stop the {productName} server. -** Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. . Review the `configure-elytron-jaas.cli` file in the root of this quickstart directory. This script adds the configuration that enables Elytron security for the quickstart components. Comments in the script describe the purpose of each block of commands. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing __{jbossHomeName}__ with the path to your server. @@ -217,21 +220,9 @@ Authentication performed by the quickstart remote client is handled by this SASL + This mapping basically enables `Elytron` security for EJB3 applications that specify the security domain `legacy-domain` in their metadata (either via jboss-ejb3.xml or annotations). The quickstart application uses the `@SecurityDomain` annotation in the bean class to specify this security domain. -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 this command to build and deploy the archive: + @@ -331,53 +322,38 @@ Principal has admin permission: true == Undeploy the Archive -. Make sure you have started the {productName} server as described above. +When you are finished testing, follow these steps to undeploy the archive. + +. 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. -. When you are finished testing, type this command to undeploy the archive: +. Type this command to undeploy the archive: + [source,options="nowrap"] ---- $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-configuration.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -You can restore the original server configuration by running the `restore-configuration.cli` script provided in the root directory of this quickstart or by manually restoring the backup copy the configuration file. - -=== Restore the Server Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing __{jbossHomeName}__ with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-configuration.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. - -+ +// Additional information about this script This script reverts the changes made to the `ejb3`, `elytron`, `security` and `undertow` subsystems. You should see the following result when you run the script. -+ + [source,options="nowrap"] ---- The batch executed successfully process-state: reload-required ---- -=== Restore the Server Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the backup copy of the file. +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] == Remove the Properties Files from the Server @@ -396,13 +372,10 @@ You can also start the server and deploy the quickstarts or run the Arquillian t * Leave the application running in JBoss Developer Studio. To configure the server to use the legacy role mappers, open a terminal, and run the `enable-role-mappers.cli` script as described above under xref:access_the_application[Access the Application]. * Go back to JBoss Developer Studio and click *Refresh the current page*. Note that *Has admin permission* is now `true`. * To undeploy the project, right-click on the *{artifactId}* project and choose *Run As* -> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*. -* Make sure you xref:restore_the_server_configuration[Restore the Server Configuration] when you have completed testing this quickstart. - -== 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. +* Make sure you xref:restore_the_server_configuration[restore the server configuration] when you have completed testing this quickstart. -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/ejb-security-programmatic-auth/README.adoc b/ejb-security-programmatic-auth/README.adoc index 56ec1d6b1d..18c01655b1 100644 --- a/ejb-security-programmatic-auth/README.adoc +++ b/ejb-security-programmatic-auth/README.adoc @@ -59,26 +59,28 @@ NOTE: For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. If you prefer, you can use the `add-user` utility interactively. For an example of how to use the add-user utility, see the instructions located here: link:{addApplicationUserDocUrl}[Add an Application User]. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + [[configure_the_server]] == Configure the Server -These steps assume you are running the server in standalone mode and using the default `standalone.xml` supplied with the distribution. - You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-elytron.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: -** If it is running, stop the {productName} server. -** Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-elytron.cli` file in the root of this quickstart directory. This script adds the configuration that enables Elytron security for the quickstart components. Comments in the script describe the purpose of each block of commands. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server. @@ -125,21 +127,9 @@ The `application-security-domain` essentially enables Elytron security for the q + This allows for the identity that was established in the connection authentication to be propagated to the components. -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 and deploy the archive: + @@ -184,54 +174,38 @@ As expected, the `quickstart` user is able to call the methods available for `gu == Undeploy the Archive -. Make sure you have started the {productName} server as described above. +When you are finished testing, follow these steps to undeploy the archive. + +. 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. -. When you are finished testing, type the following command to undeploy the archive. +. Type this command to undeploy the archive: + [source,options="nowrap"] ---- $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration - -You can restore the original server configuration by running the `restore-configuration.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. - -=== Restore the Server Configuration by Running the JBoss CLI Script - -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server. - -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-configuration.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. -+ +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-configuration.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] +// Additional information about this script This script reverts the changes made to the `ejb3` and `remoting` subsystems. You should see the following result when you run the script. -+ + [source,options="nowrap"] ---- The batch executed successfully process-state: reload-required ---- -=== Restore the Server Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the back-up copy of the file. +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] [[run_the_quickstart_in_jboss_developer_studio_or_eclipse]] == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse @@ -260,13 +234,10 @@ Principal has admin permission: true * To undeploy the project, right-click on the *{artifactId}* project and choose *Run As* -> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*. -* Make sure you xref:restore_the_server_configuration[Restore the Server Configuration] when you have completed testing this quickstart. - -== Debug the Application +* Make sure you xref:restore_the_server_configuration[restore the {productName} standalone server configuration] when you have completed testing this quickstart. -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] diff --git a/ejb-security/README.adoc b/ejb-security/README.adoc index 775741481c..ad6c590f29 100644 --- a/ejb-security/README.adoc +++ b/ejb-security/README.adoc @@ -67,26 +67,28 @@ NOTE: For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. If you prefer, you can use the `add-user` utility interactively. For an example of how to use the add-user utility, see the instructions located here: link:{addApplicationUserDocUrl}[Add an Application User]. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + [[configure_the_server]] == Configure the Server -These steps assume you are running the server in standalone mode and using the default `standalone.xml` supplied with the distribution. - You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-elytron.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: -** If it is running, stop the {productName} server. -** Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-elytron.cli` file in the root of this quickstart directory. This script adds the configuration that enables Elytron security for the quickstart components. Comments in the script describe the purpose of each block of commands. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: @@ -129,20 +131,9 @@ After stopping the server, open the `__{jbossHomeName}__/standalone/configuratio ---- -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -NOTE: For Window, use the `__{jbossHomeName}__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 this command to build and deploy the archive: + @@ -207,52 +198,39 @@ Principal has admin permission: true == Undeploy the Archive -. Make sure you have started the {productName} server as described above. +When you are finished testing, follow these steps to undeploy the archive. + +. 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. -. When you are finished testing, type this command to undeploy the archive: +. Type this command to undeploy the archive: + +[source,options="nowrap"] ---- $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration - -You can restore the original server configuration by running the `restore-configuration.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. - -=== Restore the Server Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-configuration.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-configuration.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -+ +// Additional information about this script This script reverts the changes made to the `ejb3` and `undertow` subsystems. You should see the following result when you run the script. -+ + [source,options="nowrap"] ---- The batch executed successfully process-state: reload-required ---- -=== Restore the Server Configuration Manually +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the back-up copy of the file. [[run_the_quickstart_in_jboss_developer_studio_or_eclipse]] == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse @@ -265,12 +243,10 @@ You can also start the server and deploy the quickstarts or run the Arquillian t . Right-click on the *{artifactId}* project and choose *Run As* –> *Run Configurations*. Enter *exec:exec* for the *Goals*, and then click *Run*. . Review the output in the console window. You should see the same results as when running Maven in the command line. . To undeploy the project, right-click on the *{artifactId}* project and choose *Run As* –> *Run Configurations*. Enter `wildfly:undeploy` for the *Goals* and click *Run*. -. Make sure you xref:restore_the_server_configuration[Restore the Server Configuration] when you have completed testing this quickstart. - -== Debug the Application +. Make sure you xref:restore_the_server_configuration[restore the server configuration] when you have completed testing this quickstart. -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] diff --git a/ejb-throws-exception/README.adoc b/ejb-throws-exception/README.adoc index 470f96de3f..5289bfce86 100644 --- a/ejb-throws-exception/README.adoc +++ b/ejb-throws-exception/README.adoc @@ -125,11 +125,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] diff --git a/ejb-timer/README.adoc b/ejb-timer/README.adoc index 1c93f90992..dcea673cd4 100644 --- a/ejb-timer/README.adoc +++ b/ejb-timer/README.adoc @@ -97,12 +97,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/greeter/README.adoc b/greeter/README.adoc index abfb963f3f..7ab85d11bf 100644 --- a/greeter/README.adoc +++ b/greeter/README.adoc @@ -94,10 +94,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] diff --git a/ha-singleton-deployment/README.adoc b/ha-singleton-deployment/README.adoc index 51078b790e..ea53599a49 100644 --- a/ha-singleton-deployment/README.adoc +++ b/ha-singleton-deployment/README.adoc @@ -234,11 +234,8 @@ $ mvn wildfly:undeploy $ mvn wildfly:undeploy -Dwildfly.port=10090 ---- -== 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] diff --git a/ha-singleton-service/README.adoc b/ha-singleton-service/README.adoc index 42034c7128..70b0c29ad9 100644 --- a/ha-singleton-service/README.adoc +++ b/ha-singleton-service/README.adoc @@ -517,11 +517,8 @@ $ __{jbossHomeName}_2__/bin/jboss-cli.sh --connect --controller=localhost:10090 + NOTE: For Windows, use the `__{jbossHomeName}_1__\bin\jboss-cli.bat` and `__{jbossHomeName}_2__\bin\jboss-cli.bat` scripts. -== 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] diff --git a/helloworld-jms/README.adoc b/helloworld-jms/README.adoc index dadd093b9c..f914235c60 100644 --- a/helloworld-jms/README.adoc +++ b/helloworld-jms/README.adoc @@ -60,23 +60,28 @@ NOTE: For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. If you prefer, you can use the `add-user` utility interactively. For an example of how to use the add-user utility, see the instructions located here: link:{addApplicationUserDocUrl}[Add an Application User]. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-full: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the full profile +//************************************************* +// == Start the Server with the Full Profile +include::../shared-doc/start-server-full-profile.adoc[leveloffset=+1] + [[configure_the_server]] == Configure the Server You configure the JMS `test` queue by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-jms.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file -** If it is running, stop the {productName} server. -** Back up the file: `{jbossHomeName}/standalone/configuration/standalone-full.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server with the standalone full profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh -c standalone-full.xml ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +. Before you begin, make sure you do the following: + +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_full_profile[Start the {productName} server with the standalone full profile] as described above. . Review the `configure-jms.cli` file in the root of this quickstart directory. This script adds the `test` queue to the `messaging` subsystem in the server configuration file. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server: @@ -107,23 +112,10 @@ The following `testQueue` jms-queue was configured in the default server configu ---- -== Start the Server with the Full Profile - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the standalone full profile by typing the following command: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh -c standalone-full.xml ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. == Build and Execute the Quickstart -To run the quickstart from the command line: - -. Make sure you have started the {productName} server. See the instructions in the previous section. +. xref:start_eap_standalone_server_with_the_full_profile[Start the {productName} server with the standalone full profile] as described above. . Open a terminal and navigate to the root of the helloworld-jms quickstart directory: + @@ -203,42 +195,26 @@ The example provides for a certain amount of customization for the `mvn:exec` pl | This property allows configuration of the JNDI directory used to look up the JMS destination. This is useful when the client resides on another host. |=== -[[remove_the_jms_configuration]] -== Remove the JMS Configuration - -You can remove the JMS configuration by running the `remove-jms.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. - -=== Remove the JMS Configuration by Running the JBoss CLI Script +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: remove-jms.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -. Start the {productName} server with the standalone full profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh -c standalone-full.xml ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +// Additional information about this script +This script removes the `test` queue from the `messaging` subsystem in the server configuration. You should see the following result when you run the script. -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=remove-jms.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. - -. This script removes the `test` queue from the `messaging` subsystem in the server configuration. You should see the following result when you run the script. -+ [source,options="nowrap"] ---- The batch executed successfully ---- -=== Remove the JMS Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone-full.xml` file with the back-up copy of the file. +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse @@ -253,13 +229,10 @@ This quickstart consists of multiple projects, so it deploys and runs differentl . Outside of JBoss Developer Studio, configure the JMS `test` queue by running the JBoss CLI commands as described above under xref:configure_the_server[Configure the Server]. . In JBoss Developer Studio, right-click on the *{artifactId}* project and choose *Run As* -> *Java Application*. In the *Select Java Application* window, choose *HellowWorldJMSClient - org.jboss.as.quickstarts.jms* and click *OK*. The client output displays in the *Console* window. The output messages appear in the *Console* window. -. Make sure you xref:remove_the_jms_configuration[Remove the JMS Configuration] when you have completed testing this quickstart. - -== 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. +. Make sure you xref:restore_the_server_configuration[restore the {productName} server configuration] when you have completed testing this quickstart. -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/helloworld-mdb-propertysubstitution/README.adoc b/helloworld-mdb-propertysubstitution/README.adoc index f06da2e99a..0156c31156 100644 --- a/helloworld-mdb-propertysubstitution/README.adoc +++ b/helloworld-mdb-propertysubstitution/README.adoc @@ -38,23 +38,29 @@ include::../shared-doc/system-requirements.adoc[leveloffset=+1] // == Use of {jbossHomeName} include::../shared-doc/use-of-jboss-home-name.adoc[leveloffset=+1] +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-full: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the full profile +//************************************************* +// == Start the Server with the Full Profile +include::../shared-doc/start-server-full-profile.adoc[leveloffset=+1] + + [[configure_the_server]] == Configure the Server You enable MDB property substitution by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `enable-mdb-property-substitution.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file -** If it is running, stop the {productName} server. -** Back up the file: `{jbossHomeName}/standalone/configuration/standalone-full.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -.. Start the {productName} server with the standalone full profile by typing the following command: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh -c standalone-full.xml ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +. Before you begin, make sure you do the following: + +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_full_profile[Start the {productName} server with the standalone full profile] as described above. . Review the `enable-mdb-property-substitution.cli` script file in the root of this quickstart directory. This script first enables MDB annotation property substitution the `ee` subsystem of the server configuration file by creating an `annotation-property-replacement` property with a value of `true`. It then defines the system properties that are used in the substitution. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server: @@ -102,21 +108,9 @@ The following system properties are defined and appear after the ``: ---- -== Start the Server with the Full Profile - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the standalone full profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh -c standalone-full.xml ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. xref:start_eap_standalone_server_with_the_full_profile[Start the {productName} server with the standalone full profile] as described above. . Open a terminal and navigate to the root directory of this quickstart. . Type this command to build and deploy the archive: + @@ -171,31 +165,13 @@ INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-4 (ActiveM $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration - -You can remove the server configuration by running the `disable-mdb-property-substitution.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: disable-mdb-property-substitution.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -=== Restore Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh -c standalone-full.xml ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing __{jbossHomeName}__ with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=disable-mdb-property-substitution.cli ----- -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. - -+ This script removes the system properties and sets the `` value to `false` in the `ee` subsystem of the server configuration. You should see the following result when you run the script: + [source,options="nowrap"] @@ -203,10 +179,12 @@ This script removes the system properties and sets the `keytool -importkeystore -srckeystore client.keystore -srcstorepass secret -des . The certificates and keystores are now properly configured. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + [[configure_the_server]] == Configure the Server -These steps assume you are running the server in standalone mode and using the default `standalone.xml` supplied with the distribution. - You configure the SSL context and required security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-ssl.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: -** If it is running, stop the {productName} server. -** Back up the file: `{jbossHomeName}/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-ssl.cli` file in the root of this quickstart directory. Comments in the script describe the purpose of each block of commands. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server: @@ -339,21 +341,9 @@ Before you access the application, you must import the _clientCert.p12_, which h . Select the *clientCert.p12* file. You will be prompted to enter the password: `secret`. . The certificate is now installed in the Mozilla Firefox browser. -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 one of the quickstart. . Type this command to build and deploy the archive: + @@ -402,44 +392,27 @@ ynfnMaOxI67FC2QzhfzERyKqHj47WuwN0xWbS/1gBypS2nUwvItyxaEQG2X5uQY8j8QoY9wcMzIIkP2M $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration - -You can restore the original server configuration by running the `restore-configuration.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. - -=== Restore the Server Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-configuration.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-configuration.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -+ +// Additional information about this script This script reverts the changes made to the `undertow` and `elytron` subsystems. You should see the following result when you run the script: -+ + [source,options="nowrap"] ---- The batch executed successfully process-state: reload-required ---- -=== Restore the Server Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `{jbossHomeName}/standalone/configuration/standalone.xml` file with the back-up copy of the file. +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] == Remove the keystores and certificates created for this quickstart @@ -487,13 +460,10 @@ You can also start the server and deploy the quickstarts or run the Arquillian t * Make sure you configure the server by running the JBoss CLI commands as described above under xref:configure_the_server[Configure the Server]. Stop the server at the end of that step. * In JBoss Developer Studio, choose *Window* –> *Web Browser*, then select the browser you chose to import the certificate. * To deploy the application, right-click on the *{artifactId}* project and choose *Run As* –> *Run on Server*. -* Make sure you xref:restore_the_server_configuration[Restore the Server Configuration>>] when you have completed testing this quickstart. - -== Debug the Application +* Make sure you xref:restore_the_server_configuration[restore the {productName} server configuration] when you have completed testing this quickstart. -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] diff --git a/helloworld-mutual-ssl/README.adoc b/helloworld-mutual-ssl/README.adoc index f493516dc9..829e0c5e40 100644 --- a/helloworld-mutual-ssl/README.adoc +++ b/helloworld-mutual-ssl/README.adoc @@ -130,26 +130,29 @@ $>keytool -importkeystore -srckeystore client.keystore -srcstorepass secret -des . The certificates and keystores are now properly configured. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + + [[configure_the_server]] == Configure the Server -These steps assume you are running the server in standalone mode and using the default `standalone.xml` supplied with the distribution. - You configure the SSL context by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-ssl.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: -** If it is running, stop the {productName} server. -** Back up the file: `{jbossHomeName}/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-ssl.cli` file in the root of this quickstart directory. Comments in the script describe the purpose of each block of commands. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server: @@ -263,22 +266,9 @@ Before you access the application, you must import the _clientCert.p12_, which h . Select the *clientCert.p12* file. You will be prompted to enter the password: `secret`. . The certificate is now installed in the Mozilla Firefox browser. -[[start_the_server]] -== Start the Server - -. Open a terminal and navigate to the root of the JBoss server directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 one of the quickstart. . Type this command to build and deploy the archive: + @@ -323,46 +313,29 @@ aEWK4zhPVFynfnMaOxI67FC2QzhfzERyKqHj47WuwN0xWbS/1gBypS2nUwvItyxaEQG2X5uQY8j8QoY9 $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-configuration.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -You can restore the original server configuration by running the `restore-configuration.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. - -=== Restore the Server Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-configuration.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. - -+ +// Additional information about this script This script reverts the changes made to the `undertow` subsystem and it also removes the `ssl-context`, `key-manager`, `trust-manager` and `key-store`s from the `elytron` subsystem. You should see the following result when you run the script: -+ + [source,options="nowrap"] ---- The batch executed successfully process-state: reload-required ---- -=== Restore the Server Configuration Manually +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the back-up copy of the file. == Remove the keystores and certificates created for this quickstart @@ -409,7 +382,7 @@ You can also start the server and deploy the quickstarts or run the Arquillian t * Make sure you configure the server by running the JBoss CLI commands as described above under xref:configure_the_server[Configure the Server]. Stop the server at the end of that step. * In JBoss Developer Studio, choose *Window* –> *Web Browser*, then select the browser you chose to import the certificate. * To deploy the application, right-click on the *{artifactId}* project and choose *Run As* –> *Run on Server*. -* Make sure you xref:restore_the_server_configuration[Restore the Server Configuration>>] when you have completed testing this quickstart. +* Make sure you xref:restore_the_server_configuration[restore the server configuration] when you have completed testing this quickstart. == Debug the Application diff --git a/helloworld-rs/README.adoc b/helloworld-rs/README.adoc index 6055c8114e..0a9e1bfc73 100644 --- a/helloworld-rs/README.adoc +++ b/helloworld-rs/README.adoc @@ -72,11 +72,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/helloworld-singleton/README.adoc b/helloworld-singleton/README.adoc index 7e02de06f1..55c9eede6c 100644 --- a/helloworld-singleton/README.adoc +++ b/helloworld-singleton/README.adoc @@ -74,11 +74,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/helloworld-ssl/README.adoc b/helloworld-ssl/README.adoc index 02ecd344d4..298b0c4168 100644 --- a/helloworld-ssl/README.adoc +++ b/helloworld-ssl/README.adoc @@ -70,25 +70,29 @@ Is CN=localhost, OU=wildfly, O=jboss, L=Raleigh, ST=Carolina, C=US correct? + Make sure you enter your desired "hostname" for the `first and last name` field, otherwise you might run into issues while permanently accepting this certificate as an exception in some browsers. Chrome does not currently exhibit this issue. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + + [[configure_the_server]] == Configure the Server -These steps assume you are running the server in standalone mode and using the default `standalone.xml` supplied with the distribution. - You configure the SSL context by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-ssl.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: -** If it is running, stop the {productName} server. -** Back up the file: `{jbossHomeName}/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-ssl.cli` file in the root of this quickstart directory. Comments in the script describe the purpose of each block of commands. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: @@ -108,13 +112,17 @@ The batch executed successfully process-state: reload-required ---- + +[[test_the_server_ssl_configuration]] +== Test the Server SSL Configuration + +To test the connection to the SSL port of your your server instance by opening a browser and navigation to https://localhost:8443/. Note, that you get the privacy error because the server certificate is self-signed. If you need to use a fully signed certificate, you must get a PEM file from the Certificate Authority and then import the PEM into the keystore. . Stop the {productName} server. -Now you are ready to connect to the SSL port of your instance https://localhost:8443/. Note, that you get the privacy error as the server certificate is self-signed. If you need to use a fully signed certificate you mostly get a PEM file from the Certificate Authority. In such a case, you need to import the PEM into the keystore. == Review the Modified Server Configuration -After stopping the server, open the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file and review the changes. +. Stop the server and open the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file and review the changes. . The following `key-store` was added to the `elytron` subsystem: + @@ -158,28 +166,10 @@ After stopping the server, open the `__{jbossHomeName}__/standalone/configuratio ---- -[[test_the_server_ssl_configuration]] -== Test the Server SSL Configuration - -To test the SSL configuration, access: https://localhost:8443 - -[[start_the_server]] -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - [[build_and_deploy_the_quickstart]] == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 one of the quickstart. . Type this command to build and deploy the archive: + @@ -188,7 +178,7 @@ NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. $ mvn clean package wildfly:deploy ---- -. This will deploy `target/{artifactId}.war` to the running instance of the server. +. This deploys the `target/{artifactId}.war` to the running instance of the server. [[access_the_application]] == Access the Application @@ -198,52 +188,38 @@ The application will be running at the following URL: https://localhost:8443/{ar [[undeploy_the_archive]] == Undeploy the Archive -. Make sure you have started the JBoss Server as described above. +When you are finished testing, follow these steps to undeploy the archive. + +. 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. -. When you are finished testing, type this command to undeploy the archive: +. Type this command to undeploy the archive: + [source,options="nowrap"] ---- $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration - -You can restore the original server configuration by running the `restore-configuration.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. - -=== Restore the Server Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-configuration.cli ----- -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-configuration.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -+ +// Additional information about this script This script reverts the changes made to the `undertow` subsystem and it also removes the `ssl-context`, `key-manager`, and `key-store` from the `elytron` subsystem. You should see the following result when you run the script. -+ + [source,options="nowrap"] ---- The batch executed successfully process-state: reload-required ---- -=== Restore the Server Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the back-up copy of the file. +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] == Remove the keystore created for this quickstart @@ -262,13 +238,10 @@ $ cd __{jbossHomeName}__/standalone/configuration/ 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]. * Make sure you configure the server by running the JBoss CLI commands as described above under xref:configure_the_server[Configure the Server]. Stop the server at the end of that step. -* Make sure you xref:restore-the-server-configuration[Restore the Server Configuration>> when you have completed testing this quickstart. - -== Debug the Application +* Make sure you xref:restore-the-server-configuration[restore the server configuration] when you have completed testing this quickstart. -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] diff --git a/helloworld-ws/README.adoc b/helloworld-ws/README.adoc index b5e2705cbf..58d29a769c 100644 --- a/helloworld-ws/README.adoc +++ b/helloworld-ws/README.adoc @@ -118,11 +118,8 @@ You can also start the server and deploy the quickstarts or run the Arquillian t When you deploy this quickstart, you are presented with a window that explains there is no user interface for this quickstart and directs you to click on a link to view the WSDL definition. However, the Eclipse browser does not support the display of WSDL definitions. Instead, open an external browser and access the following URL: http://localhost:8080/{artifactId}/HelloWorldService?wsdl. This URL will display the deployed WSDL endpoint for the Web Service. -== 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] diff --git a/helloworld/README.adoc b/helloworld/README.adoc index 7349775a6e..367d78fa3e 100644 --- a/helloworld/README.adoc +++ b/helloworld/README.adoc @@ -66,10 +66,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] diff --git a/hibernate/README.adoc b/hibernate/README.adoc index f17d38b1d2..ea40881de5 100644 --- a/hibernate/README.adoc +++ b/hibernate/README.adoc @@ -114,19 +114,20 @@ $ 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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] -You may see the following message when you run the command. It indicates the source is not provided in the third-party `antlr` JAR. +// Additional debug info +[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. [source,options="nowrap"] ---- - [INFO] The following files have NOT been resolved: - [INFO] antlr:antlr:jar:sources:2.7.7:provided +[INFO] The following files have NOT been resolved: +[INFO] antlr:antlr:jar:sources:2.7.7:provided ---- +==== diff --git a/inter-app/README.adoc b/inter-app/README.adoc index cbd451bb15..8210bfe1b5 100644 --- a/inter-app/README.adoc +++ b/inter-app/README.adoc @@ -122,11 +122,8 @@ This quickstart consists of multiple projects containing interdependencies on ea . To undeploy the *{artifactId}-app-appB* project, right-click on it and choose *Run As* –>; *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*. . To undeploy the `{artifactId}-app-appA` project, right-click on it 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] diff --git a/jaxrs-client/README.adoc b/jaxrs-client/README.adoc index 3e3b996cb2..b1bd547ade 100644 --- a/jaxrs-client/README.adoc +++ b/jaxrs-client/README.adoc @@ -153,11 +153,8 @@ To run the tests in Red Hat JBoss Developer Studio: . You must first set the active Maven profile in project properties to be either `arq-managed` for running on managed server or `arq-remote` for running on remote server. . Then, to run the tests, right click on the project or individual classes and select Run As –> JUnit Test in the context menu. -== 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] diff --git a/jaxws-addressing/README.adoc b/jaxws-addressing/README.adoc index f725e0555a..8ecfee55ff 100644 --- a/jaxws-addressing/README.adoc +++ b/jaxws-addressing/README.adoc @@ -125,11 +125,8 @@ Hello World! . To undeploy the project, right-click on the *{artifactId}* parent 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] diff --git a/jaxws-ejb/README.adoc b/jaxws-ejb/README.adoc index 820f6d8529..c3c84fa1e8 100644 --- a/jaxws-ejb/README.adoc +++ b/jaxws-ejb/README.adoc @@ -123,15 +123,13 @@ EJB3Bean returning: ejbClient calling . To undeploy the project, right-click on the *{artifactId}* parent 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] +// Additional debug info [NOTE] ==== You will see the following informational messages. This is because the source files for these JARs are not available in the Maven repository. The `jaxws-ejb-service` source files are available in the `jaxws-ejb` project. diff --git a/jaxws-pojo/README.adoc b/jaxws-pojo/README.adoc index ff7a52e7e0..b9ae2790cc 100644 --- a/jaxws-pojo/README.adoc +++ b/jaxws-pojo/README.adoc @@ -124,11 +124,8 @@ JSEBean pojo: pojoClient calling . To undeploy the project, right-click on the *{artifactId}* parent 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] diff --git a/jaxws-retail/README.adoc b/jaxws-retail/README.adoc index d2510a07cc..6c1c2c6915 100644 --- a/jaxws-retail/README.adoc +++ b/jaxws-retail/README.adoc @@ -161,15 +161,13 @@ Jay Boss's discount is 10.00 ---- . To undeploy the project, right-click on the *{artifactId}-service* 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] +// Additional debug info [NOTE] ==== You will see the following informational messages. This is because the source files for this JAR are not available in the Maven repository. diff --git a/jsonp/README.adoc b/jsonp/README.adoc index e958d80669..6a3c55ff35 100644 --- a/jsonp/README.adoc +++ b/jsonp/README.adoc @@ -78,11 +78,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. -+ -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/jta-crash-rec/README.adoc b/jta-crash-rec/README.adoc index e5b3a2d78d..2b9b804544 100644 --- a/jta-crash-rec/README.adoc +++ b/jta-crash-rec/README.adoc @@ -220,11 +220,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/jts-distributed-crash-rec/README.adoc b/jts-distributed-crash-rec/README.adoc index dfe4224465..bdf16a58a5 100644 --- a/jts-distributed-crash-rec/README.adoc +++ b/jts-distributed-crash-rec/README.adoc @@ -280,4 +280,4 @@ __{jbossHomeName}_2__/standalone/data/tx-object-store . After recovery is complete, access the application URL http://localhost:8080/jts-application-component-1/customers.jsf. The user you created should now appear in the list. -. Do NOT forget to link:{configureBytemanDisableDocUrl}[Disable the Byteman script] by restoring the backup server configuration file. The Byteman rule must be removed to ensure that your application server will be able to commit 2PC transactions! +. Do _not_ forget to link:{configureBytemanDisableDocUrl}[Disable the Byteman script] by restoring the backup server configuration file. The Byteman rule must be removed to ensure that your application server will be able to commit 2PC transactions! diff --git a/kitchensink-ear/README.adoc b/kitchensink-ear/README.adoc index e3be778d65..1c461315da 100644 --- a/kitchensink-ear/README.adoc +++ b/kitchensink-ear/README.adoc @@ -147,11 +147,8 @@ For this quickstart, follow the special instructions to build link:link:{useEcli . This starts the server, deploys the application, and opens a browser window that accesses the running application at http://localhost:8080/kitchensink-ear-web. . 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] diff --git a/kitchensink-jsp/README.adoc b/kitchensink-jsp/README.adoc index caf833bfd4..befb71ac02 100644 --- a/kitchensink-jsp/README.adoc +++ b/kitchensink-jsp/README.adoc @@ -114,11 +114,8 @@ The tag handler class for "c:out" (org.apache.taglibs.standard.tag.rt.core.OutTa You can ignore this warning as it does not impact building or deploying the quickstart in JBoss Developer Studio. See https://issues.jboss.org/browse/JBIDE-22175[JBIDE-22175] for the latest updates on this issue. -== 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] diff --git a/kitchensink-ml/README.adoc b/kitchensink-ml/README.adoc index 32fd1d660e..38c0e7c9ba 100644 --- a/kitchensink-ml/README.adoc +++ b/kitchensink-ml/README.adoc @@ -194,11 +194,8 @@ You can also let Arquillian manage the {productName} server by using the `arq-ma 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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/kitchensink/README.adoc b/kitchensink/README.adoc index 3b0c68d586..492965d01b 100644 --- a/kitchensink/README.adoc +++ b/kitchensink/README.adoc @@ -104,11 +104,8 @@ You can also let Arquillian manage the {productName} server by using the `arq-ma 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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/logging-tools/README.adoc b/logging-tools/README.adoc index 141f2ac423..7099531a21 100644 --- a/logging-tools/README.adoc +++ b/logging-tools/README.adoc @@ -140,11 +140,8 @@ GreeterExceptionBundle_$bundle.java Java Problem ---- -== 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] diff --git a/logging/README.adoc b/logging/README.adoc index c710fe3810..64e3d7e097 100644 --- a/logging/README.adoc +++ b/logging/README.adoc @@ -35,6 +35,13 @@ include::../shared-doc/system-requirements.adoc[leveloffset=+1] // == Use of {jbossHomeName} include::../shared-doc/use-of-jboss-home-name.adoc[leveloffset=+1] +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + //************************************************* // Start the server with the default profile //************************************************* @@ -44,7 +51,7 @@ include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] [[build_and_deploy_the_quickstart]] == 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 this command to build and deploy the archive: + @@ -81,24 +88,15 @@ The log files are located in the `__{jbossHomeName}__/standalone/log` log direct * `server.log` - This is the standard log produced by the application server. By default, it contains all the server log messages, including the server startup messages. * `gc.log.0.current` - This is a garbage collection log. It contains garbage collection activity and can be used for diagnostic purposes. This log can be ignored as it is not used in this quickstart. - == Configure the Server -You configure server logging by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-logging.cli` script provided in the root directory of this quickstart. +Now you have deployed the quickstart with the default configuration, you run a management CLI script to configure the logging subsystem and review the differences in the resulting log files. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: + +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. -** If it is running, stop the {productName} server. -** Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. . Review the `configure-logging.cli` file in the root of this quickstart directory. This script configures the logging subsytem in the server configuration file. It configures the periodic rotating file handlers and the async handlers, creates the logger for our quickstart class and sets the level to TRACE, and assigns the async handlers for our quickstart class. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: @@ -215,7 +213,7 @@ The following XML was added to the `logging` subsystem. == Test the New Logging Configuration -. If your server is not started, then xref:start_the_server[Start the server]. +. Make sure you xref:start_eap_standalone_server_with_the_default_profile[start the {productName} server with the standalone default profile] as described above. . xref:build_and_deploy_the_quickstart[Build and deploy the quickstart]. . xref:access_the_application[Access the application]. @@ -267,42 +265,27 @@ from TRACE to DEBUG, INFO, WARN, ERROR, or FATAL, then access the application. $ mvn wildfly:undeploy ---- -[[remove_the_logging_configuration]] -== Remove the Logging Configuration - -You can remove the logging configuration by running the `remove-logging.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: remove-logging.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -=== Remove the Logging Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=remove-logging.cli ----- -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. - -+ +// Additional information about this script This script removes the log and file handlers from the `logging` subsystem in the server configuration. You should see the following result when you run the script: -+ + [source,options="nowrap"] ---- The batch executed successfully ---- -=== Remove the Logging Configuration Manually +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the back-up copy of the file. == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse @@ -311,11 +294,8 @@ You can also start the server and deploy the quickstarts or run the Arquillian t * Make sure you configure {productName} server logging as described above under xref:configure_the_server[Configure the Server]. Stop the server at the end of that step. * Make sure you xref:remove_the_logging_configuration[Remove the Logging Configuration] when you have completed testing this quickstart. -== 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,iptions="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/mail/README.adoc b/mail/README.adoc index 90013e549e..b67977e80d 100644 --- a/mail/README.adoc +++ b/mail/README.adoc @@ -45,23 +45,29 @@ To configure an SMTP mail server, consult the documentation for your operating s If you do not configure an SMTP mail server on your local machine, you will see the exception `com.sun.mail.util.MailConnectException: Couldn't connect to host, port: localhost, 25; timeout -1;` when you access the application and attempt to send an email. +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + + [[configure_the_server]] == Configure the Server You configure the custom mail session in {productName} by running Management CLI commands. For your convenience, this quickstart batches the commands into a `configure-mail-session.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file -** If it is running, stop the {productName} server. -** Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +. Before you begin, make sure you do the following: + +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-mail-session.cli` file in the root of this quickstart directory. This script creates custom outbound socket binding port for SMTP, POP3, and IMAP. It then creates the custom `MyOtherMail` mail session and configures it to use the custom outbound socket binding ports. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: @@ -123,29 +129,17 @@ The `MyOtherMail` mail session is added to the `mail` subsystem and configured t ---- -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 this command to build and deploy the archive: - ++ ---- $ mvn clean install wildfly:deploy ---- - -. This will deploy `target/{artifactId}.war` to the running instance of the server. ++ +This deploys `target/{artifactId}.war` to the running instance of the server. == Access the Application @@ -163,44 +157,27 @@ NOTE: If you see `Error processing request` in the browser when you access the a $ mvn wildfly:undeploy ---- -[[remove_the_mail_configuration]] -== Remove the Mail Configuration - -You can remove the mail configuration by running the `remove-mail-session.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: remove-mail-session.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -=== Remove the Custom Mail Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=remove-mail-session.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. - -+ +// Additional information about this script This script removes the custom `MyOtherMail` session from the `mail` subsystem in the server configuration. file You should see the following result when you run the script: -+ + [source,options="nowrap"] ---- The batch executed successfully process-state: reload-required ---- -=== Remove the Custom Mail Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone-full.xml` file with the back-up copy of the file. +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse @@ -210,12 +187,10 @@ You can also start the server and deploy the quickstarts or run the Arquillian t * Make sure you configure the {productName} custom mail configuration as described above under xref:configure_the_server[Configure the {productName} Server]. Stop the server at the end of that step. * To deploy the server project, right-click on the *{artifactId}* project and choose *Run As* –> *Run on Server*. A browser window appears that accesses the running application. * To undeploy the project, right-click on the *{artifactId}* project and choose *Run As* –> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*. -* Make sure you xref:remove_the_mail_configuration[Remove the Mail Configuration] when you have completed testing this quickstart. +* Make sure you xref:restore_the_server_configuration[restore the {productName} server configuration] when you have completed testing this quickstart. -== 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] diff --git a/managed-executor-service/README.adoc b/managed-executor-service/README.adoc index 5b78520c65..e100d9ce9f 100644 --- a/managed-executor-service/README.adoc +++ b/managed-executor-service/README.adoc @@ -54,7 +54,7 @@ include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container. -. 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 run the test goal with the following profile activated: + @@ -144,15 +144,12 @@ You can also start the server and deploy the quickstarts or run the Arquillian t To run the tests in Red Hat JBoss Developer Studio, you must first set the active Maven profile in project properties to one of the following: * `arq-remote`: This setting is used for a remote server. JBoss Developer Studio starts the server for you. -* `arq-managed`: This setting is used for a managed server. If you use this setting, you must xref:start_the_server[start the server] before you run the tests. +* `arq-managed`: This setting is used for a managed server. If you use this setting, you must xref:start_eap_standalone_server_with_the_default_profile[start the server] before you run the tests. Then, to run the tests, right click on the project or individual classes and select *Run As* –> *JUnit Test* in the context menu. -== 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] diff --git a/numberguess/README.adoc b/numberguess/README.adoc index 80e83a4c19..b4b027fb2b 100644 --- a/numberguess/README.adoc +++ b/numberguess/README.adoc @@ -68,11 +68,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/payment-cdi-event/README.adoc b/payment-cdi-event/README.adoc index 7b6f5b3493..4565a853e6 100644 --- a/payment-cdi-event/README.adoc +++ b/payment-cdi-event/README.adoc @@ -96,11 +96,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/servlet-async/README.adoc b/servlet-async/README.adoc index 5e16c12525..8c61db24b9 100644 --- a/servlet-async/README.adoc +++ b/servlet-async/README.adoc @@ -72,11 +72,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/servlet-filterlistener/README.adoc b/servlet-filterlistener/README.adoc index 3c4e6f21a2..c276f5ecf0 100644 --- a/servlet-filterlistener/README.adoc +++ b/servlet-filterlistener/README.adoc @@ -119,11 +119,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/servlet-security/README.adoc b/servlet-security/README.adoc index 126887d01b..de643303d6 100644 --- a/servlet-security/README.adoc +++ b/servlet-security/README.adoc @@ -69,25 +69,29 @@ include::../shared-doc/system-requirements.adoc[leveloffset=+1] // == Use of {jbossHomeName} include::../shared-doc/use-of-jboss-home-name.adoc[leveloffset=+1] +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + [[configure_the_server]] == Configure the Server You can configure the server by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-server.cli` script provided in the root directory of this quickstart. -. Before you begin, back up your server configuration file +. Before you begin, make sure you do the following: -** If it is running, stop the {productName} server. -** Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server with the default profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-server.cli` file in the root of this quickstart directory. This script adds security domain and HTTP authentication factory to the `elytron` subsystem in the server configuration and also configures the `undertow` subsystem to use the configured HTTP authentication factory for the Web application. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: @@ -189,21 +193,9 @@ It basically defines an HTTP authentication factory for the BASIC mechanism that This configuration tells `Undertow` that applications with the `servlet-security-quickstart` security domain, as defined in the `jboss-web.xml` or by using the `@SecurityDomain` annotation in the Servlet class, should use the `http-authentication-factory` named `servlet-security-quickstart-http-auth`. If no `application-security-domain` is defined for a particular security domain, `Undertow` assumes the legacy JAAS based security domains should be used for authentication/authorization and, in this case, the security domain defined in the Web application must match a security domain in the legacy `security` subsystem. The presence of an `application-security-domain` configuration is what enables Elytron authentication for a Web application. -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - == Build and Deploy the Quickstart -. Make sure you have started the {productName} server as described above. +. 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 this command to build and deploy the archive: + @@ -257,33 +249,15 @@ HHH000431: Unable to determine H2 database version, certain features may not wor $ mvn wildfly:undeploy ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration - -You can restore the original server configuration by running the `restore-configuration.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. - -=== Restore the Server Configuration by Running the JBoss CLI Script - -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-configuration.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-configuration.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -+ -This script removes the application-security-domain configuration from the undertow subsystem, the http-authentication-factory, security-domain, security-realm and role-decoder configuration from the elytron subsystem and it also removes the datasource used for this quickstart. You should see the following result when you run the script: +// Additional information about this script +This script removes the `application-security-domain` configuration from the `undertow` subsystem, the `http-authentication-factory`, `security-domain`, `security-realm` and `role-decoder` configuration from the `elytron` subsystem and it also removes the datasource used for this quickstart. You should see the following result when you run the script: + [source,options="nowrap"] ---- @@ -291,24 +265,21 @@ The batch executed successfully process-state: reload-required ---- -[[restore_the_server_configuration]] -=== Restore the Server Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the back-up copy of the file. +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse 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]. * Make sure you configure the server by running the JBoss CLI commands as described above under xref:configure_the_server{Configure the Server]. Stop the server at the end of that step. -* Make sure you xref:restore_the_server_configuration[Restore the Server Configuration] when you have completed testing this quickstart. - -== 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. +* Make sure you xref:restore_the_server_configuration[restore the {productName} server configuration] when you have completed testing this quickstart. -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/shared-doc/back-up-managed-domain-configuration.adoc b/shared-doc/back-up-managed-domain-configuration.adoc new file mode 100644 index 0000000000..c37a1b2503 --- /dev/null +++ b/shared-doc/back-up-managed-domain-configuration.adoc @@ -0,0 +1,15 @@ +[[back_up_managed_domain_configuration]] += Back Up the {productName} Managed Domain Configuration + +Before you begin, back up your server configuration files. + +* If it is running, stop the {productName} server. +* Back up the following files: ++ +[source,subs="+quotes,attributes+",options="nowrap"] +---- +__{jbossHomeName}__/domain/configuration/domain.xml +__{jbossHomeName}__/domain/configuration/host.xml +---- + +After you have completed testing this quickstart, you can replace these file to restore the server to its original configuration. diff --git a/shared-doc/back-up-server-standalone-configuration.adoc b/shared-doc/back-up-server-standalone-configuration.adoc new file mode 100644 index 0000000000..cb71174163 --- /dev/null +++ b/shared-doc/back-up-server-standalone-configuration.adoc @@ -0,0 +1,21 @@ +[[back_up_standalone_server_configuration]] += Back Up the {productName} Standalone Server Configuration + +Before you begin, back up your server configuration file. + +ifdef::standalone-server-default[] +* If it is running, stop the {productName} server. +* Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone.xml` +endif::[] + +ifdef::standalone-server-full[] +* If it is running, stop the {productName} server. +* Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone-full.xml` +endif::[] + +ifdef::standalone-server-full-ha[] +* If it is running, stop the {productName} server. +* Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone-full-ha.xml` +endif::[] + +After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. diff --git a/shared-doc/debug-the-application.adoc b/shared-doc/debug-the-application.adoc new file mode 100644 index 0000000000..266addebff --- /dev/null +++ b/shared-doc/debug-the-application.adoc @@ -0,0 +1,8 @@ +[[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. + +---- +$ mvn dependency:sources +---- diff --git a/shared-doc/restore-managed-domain-configuration-manual.adoc b/shared-doc/restore-managed-domain-configuration-manual.adoc new file mode 100644 index 0000000000..402e5f5837 --- /dev/null +++ b/shared-doc/restore-managed-domain-configuration-manual.adoc @@ -0,0 +1,12 @@ +[[restore_managed_domain_configuration_manually]] += Restore the {productName} Managed Domain Configuration Manually + +When you have completed testing the quickstart, you can restore the original server configuration by manually restoring the backup copies the configuration files. + +* If it is running, stop the {productName} server. +* Replace the following files with the backup copies of the files. + +[source,subs="+quotes,attributes+",options="nowrap"] +---- +__{jbossHomeName}__/domain/configuration/domain.xml +__{jbossHomeName}__/domain/configuration/host.xml +---- diff --git a/shared-doc/restore-standalone-server-configuration-manual.adoc b/shared-doc/restore-standalone-server-configuration-manual.adoc new file mode 100644 index 0000000000..7bfff442bc --- /dev/null +++ b/shared-doc/restore-standalone-server-configuration-manual.adoc @@ -0,0 +1,19 @@ +[[restore_standalone_server_configuration_manually]] += Restore the {productName} Standalone Server Configuration Manually + +When you have completed testing the quickstart, you can restore the original server configuration by manually restoring the backup copy the configuration file. + +ifdef::standalone-server-default[] +. If it is running, stop the {productName} server. +. Replace the `__{jbossHomeName}__/standalone/configuration/standalone.xml` file with the backup copy of the file. +endif::[] + +ifdef::standalone-server-full[] +. If it is running, stop the {productName} server. +. Replace the `__{jbossHomeName}__/standalone/configuration/standalone-full.xml` file with the backup copy of the file. +endif::[] + +ifdef::standalone-server-full-ha[] +. If it is running, stop the {productName} server. +. Back up the file: `__{jbossHomeName}__/standalone/configuration/standalone-full-ha.xml` +endif::[] diff --git a/shared-doc/restore-standalone-server-configuration.adoc b/shared-doc/restore-standalone-server-configuration.adoc new file mode 100644 index 0000000000..d640861330 --- /dev/null +++ b/shared-doc/restore-standalone-server-configuration.adoc @@ -0,0 +1,34 @@ +[[restore_the_standalone_server_configuration]] += Restore the {productName} Standalone Server Configuration + +// This content can be reused by any quickstart that provides a script to restore a +// server to its original configuration. +// Make sure you define the script file name using the `restoreScriptName` attribute. +// For example: +// :restoreScriptName: remove-configuration.cli + +You can restore the original server configuration by running the `{restoreScriptName}` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. + +== Restore the {productName} Standalone Server Configuration by Running the JBoss CLI Script + +ifdef::standalone-server-default[] +. xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. +endif::[] + +ifdef::standalone-server-full[] +. xref:start_eap_standalone_server_with_the_full_profile[Start the {productName} server with the standalone full profile] as described above. + +endif::[] + +ifdef::standalone-server-full-ha[] +. xref:start_eap_standalone_server_with_the_full_ha_profile[Start the {productName} server with the standalone full HA profile] as described above. +endif::[] + +. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing `__{jbossHomeName}__` with the path to your server: ++ +[source,subs="+quotes,attributes+",options="nowrap"] +---- +$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file={restoreScriptName} +---- ++ +NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. diff --git a/shopping-cart/README.adoc b/shopping-cart/README.adoc index b3a4ddc4f9..f13e94dec5 100644 --- a/shopping-cart/README.adoc +++ b/shopping-cart/README.adoc @@ -41,6 +41,19 @@ include::../shared-doc/system-requirements.adoc[leveloffset=+1] // == Use of {jbossHomeName} include::../shared-doc/use-of-jboss-home-name.adoc[leveloffset=+1] +//************************************************* +// Back up the server configuration files +//************************************************* +// == Back Up the {productName} Standalone Server Configuration +:standalone-server-default: +include::../shared-doc/back-up-server-standalone-configuration.adoc[leveloffset=+1] + +//************************************************* +// Start the server with the default profile +//************************************************* +// == Start the Server with the Default Profile +include::../shared-doc/start-server-default-profile.adoc[leveloffset=+1] + [[configure_the_server]] == Configure the Server @@ -53,18 +66,10 @@ ERROR [org.jboss.as.ejb3.invocation] (EJB default - 7) WFLYEJB0034: EJB Invocati Follow the steps below to suppress system exception logging. -. Before you begin, back up your server configuration file -** If it is running, stop the {productName} server. -** Back up the file: `{jbossHomeName}/standalone/configuration/standalone.xml` -** After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration. -. Start the {productName} server by typing the following: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +. Before you begin, make sure you do the following: + +* xref:back_up_standalone_server_configuration[Back up the {productName} standalone server configuration] as described above. +* xref:start_eap_standalone_server_with_the_default_profile[Start the {productName} server with the standalone default profile] as described above. . Review the `configure-system-exception.cli` file in the root of this quickstart directory. This script sets the `log-system-exceptions` attribute to `false` in the `ejb3` subsystem in the server configuration file. . Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server: @@ -97,34 +102,12 @@ You should see the following configuration in the `ejb3` subsystem. ---- -== Start the Server - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the default standalone profile by typing the following command. -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. - -[[install_the_quickstart_parent_artifact_in_maven]] -== Install the Quickstart Parent Artifact in Maven - -This quickstart requires the `quickstart-parent` artifact to be installed in your local Maven repository. To install it, navigate to your __QUICKSTART_HOME__ directory directory and run the following command. - -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ cd __QUICKSTART_HOME__ -$ mvn clean install ----- == Build and Deploy the Quickstart -. Make sure you have started the {productName} server. See the instructions in the previous section. +. 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 `shopping-cart` quickstart directory +. Open a terminal and navigate to the root directory of this quickstart. . To build both the server component and the remote client program, deploy the server module, change into the examples shopping-cart directory and type the following: + @@ -200,54 +183,40 @@ Cart was correctly removed, as expected, after Checkout INFO [stdout] (pool-9-thread-8) implementing checkout() left as exercise for the reader! ---- -[[restore_the_server_configuration]] -== Restore the Server Configuration - -You can restore the system exception configuration by running the `restore-system-exception.cli` script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file. +== Undeploy the Archive -=== Restore the Server Configuration by Running the JBoss CLI Script +When you are finished testing, follow these steps to undeploy the archive. -. Start the {productName} server by typing the following: +. 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 this command to undeploy the archive: + -[source,subs="+quotes,attributes+",options="nowrap"] +[source,options="nowrap"] ---- -$ __{jbossHomeName}__/bin/standalone.sh +$ mvn wildfly:undeploy ---- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. -. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=restore-system-exception.cli ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script. +//************************************************************ +// Restore the {productName} Standalone Server Configuration +//************************************************************ +// == Restore the {productName} Standalone Server Configuration +:restoreScriptName: restore-system-exception.cli +include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+1] -+ -This script restores the the log-system-exceptions attribute value to true. You should see the following result when you run the script: +// Additional information about this script +This script restores the the `log-system-exceptions` attribute value to `true`. You should see the following result when you run the script: + [source,options="nowrap"] ---- The batch executed successfully ---- -=== Restore the Server Configuration Manually - -. If it is running, stop the {productName} server. -. Replace the `{jbossHomeName}/standalone/configuration/standalone.xml` file with the back-up copy of the file. - -== Undeploy the Archive +//****************************************************** +// Restore the standalone server configuration manually +//****************************************************** +// == Restore the {productName} Standalone Server Configuration Manually +include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] -. Make sure you have started the {productName} server as described above. -. Open a terminal and navigate to the root directory of this quickstart. -. When you are finished testing, type this command to undeploy the archive: -+ -[source,options="nowrap"] ----- -$ mvn wildfly:undeploy ----- == Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse @@ -259,13 +228,10 @@ This quickstart consists of multiple projects, so it deploys and runs differentl * To deploy the server project, right-click on the *{artifactId}-server* project and choose *Run As* –> *Run on Server*. * To run the client, right-click on the *{artifactId}-client* project and choose *Run As* –> *Java Application*. In the *Select Java Application* window, choose *Client - org.jboss.as.quickstarts.client* and click *OK*. The client output displays in the *Console* window. * To undeploy the project, right-click on the *{artifactId}-server* project and choose *Run As* –> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*. -* Make sure you xref:restore_the_server_configuration[Restore the Server Configuration] when you have completed testing this quickstart. +* Make sure you xref:restore_the_server_configuration[restore the {productName} standalone server configuration] when you have completed testing this quickstart. -== 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] diff --git a/tasks-rs/README.adoc b/tasks-rs/README.adoc index 4521757d19..56e94b86c3 100644 --- a/tasks-rs/README.adoc +++ b/tasks-rs/README.adoc @@ -334,11 +334,8 @@ You can also start the server and deploy the quickstarts or run the Arquillian t Make sure you xref:add_an_application_user[Add an Application User] as described above. -== 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] diff --git a/tasks/README.adoc b/tasks/README.adoc index 0e0a9e0410..2c613db002 100644 --- a/tasks/README.adoc +++ b/tasks/README.adoc @@ -125,11 +125,8 @@ INFO [stdout] (default task-90) Hibernate: select user0_.id as id1_1_, user0_.u 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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/temperature-converter/README.adoc b/temperature-converter/README.adoc index 2a944d7c9e..f7baaa14d0 100644 --- a/temperature-converter/README.adoc +++ b/temperature-converter/README.adoc @@ -83,11 +83,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/template/README.adoc b/template/README.adoc index a9381a1abe..31a80d96e9 100644 --- a/template/README.adoc +++ b/template/README.adoc @@ -46,8 +46,8 @@ If possible, give an overview, including any code they should look at to underst //// Include this "Considerations for Use in a Production Environment" file in the following is true for your quickstart: - * It uses the H2 database. Be sure to define the `:uses-h2:` variable. - * It uses a `*-ds.xml` file. Be sure to define the `:uses-ds-xml:` variable. + * It uses the H2 database. Make sure you define the `:uses-h2:` variable. + * It uses a `*-ds.xml` file. Make sure you define the `:uses-ds-xml:` variable. * It has performance and scalability considerations. Define the `:performance-scalability:` variable. //// //*************************************** @@ -57,7 +57,7 @@ include::../shared-doc/development-shortcuts.adoc[leveloffset=+1] //// Always add the system requirements. - If this quickstart uses CLI scripts, be sure to define the :uses-cli: variable. + If this quickstart uses CLI scripts, make sure you define the :uses-cli: variable. Add any additional requirements for this quickstart after the include. //// //************************************************* @@ -183,11 +183,8 @@ You can also let Arquillian manage the {productName} server by using the `arq-ma 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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/thread-racing/README.adoc b/thread-racing/README.adoc index f36d7c8fc7..2673ba5ff2 100644 --- a/thread-racing/README.adoc +++ b/thread-racing/README.adoc @@ -53,17 +53,11 @@ include::../shared-doc/system-requirements.adoc[leveloffset=+1] // == Use of {jbossHomeName} include::../shared-doc/use-of-jboss-home-name.adoc[leveloffset=+1] -== Start the {productName} Server with the Full Profile - -. Open a terminal and navigate to the root of the {productName} directory. -. Start the {productName} server with the standalone full profile by typing the following command: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ __{jbossHomeName}__/bin/standalone.sh -c standalone-full.xml ----- -+ -NOTE: For Windows, use the `__{jbossHomeName}__\bin\standalone.bat` script. +//************************************************* +// Start the server with the full profile +//************************************************* +// == Start the Server with the Full Profile +include::../shared-doc/start-server-full-profile.adoc[leveloffset=+1] == Build and Deploy the Quickstart @@ -107,10 +101,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] diff --git a/websocket-client/README.adoc b/websocket-client/README.adoc index 367bab043f..d6b4642b37 100644 --- a/websocket-client/README.adoc +++ b/websocket-client/README.adoc @@ -101,11 +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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/websocket-endpoint/README.adoc b/websocket-endpoint/README.adoc index 31f82f2984..869c78c122 100644 --- a/websocket-endpoint/README.adoc +++ b/websocket-endpoint/README.adoc @@ -80,11 +80,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/websocket-hello/README.adoc b/websocket-hello/README.adoc index 02ed838f33..f504b869e3 100644 --- a/websocket-hello/README.adoc +++ b/websocket-hello/README.adoc @@ -86,11 +86,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1] diff --git a/wsat-simple/README.adoc b/wsat-simple/README.adoc index 35a02c0516..22b712853c 100644 --- a/wsat-simple/README.adoc +++ b/wsat-simple/README.adoc @@ -190,11 +190,8 @@ This quickstart is more complex than the others. It requires that you configure . Start the new *{productName} XTS Configuration* server. . Right-click on the *{artifactId}* project, choose *Run As* -> *Maven build*, enter `clean verify -Parq-remote` for the *Goals*, and click *Run* to run the Arquillian tests. The test results appear in the console. -== 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] diff --git a/wsba-coordinator-completion-simple/README.adoc b/wsba-coordinator-completion-simple/README.adoc index 6682ac87c8..2f484976f8 100644 --- a/wsba-coordinator-completion-simple/README.adoc +++ b/wsba-coordinator-completion-simple/README.adoc @@ -190,11 +190,8 @@ This quickstart is more complex than the others. It requires that you configure . Right-click on the *{artifactId}* project, choose *Run As* -> *Maven build*, enter `clean verify -Parq-remote` for the *Goals*, and click *Run* to run the Arquillian tests. The test results appear in the console. -== 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] diff --git a/wsba-participant-completion-simple/README.adoc b/wsba-participant-completion-simple/README.adoc index 77285ba2db..f83e5a7ebc 100644 --- a/wsba-participant-completion-simple/README.adoc +++ b/wsba-participant-completion-simple/README.adoc @@ -184,11 +184,8 @@ This quickstart is more complex than the others. It requires that you configure . Start the new *{productName} XTS Configuration* server. . Right-click on the *{artifactId}* project, choose *Run As* -> *Maven build*, enter `clean verify -Parq-remote` for the *Goals*, and click *Run* to run the Arquillian tests. The test results appear in the console. -== 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] diff --git a/xml-jaxp/README.adoc b/xml-jaxp/README.adoc index 9fa9aa2874..f16b23968b 100644 --- a/xml-jaxp/README.adoc +++ b/xml-jaxp/README.adoc @@ -97,11 +97,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. - -[source,options="nowrap"] ----- -$ mvn dependency:sources ----- +//************************************************* +// Add info to debug the application +//************************************************* +// == Debug the Application +include::../shared-doc/debug-the-application.adoc[leveloffset=+1]