Permalink
Browse files

JBEAP-13958: Additional formatting cleanup

  • Loading branch information...
sgilda committed Dec 25, 2017
1 parent 02d5031 commit 292f1667da8821e36b444e586676fbcb1e0998ef
@@ -14,8 +14,6 @@ include::../attributes.adoc[]
[abstract]
The `ejb-security-jaas` quickstart demonstrates how legacy `JAAS` security domains can be used in conjunction with `Elytron`
Source: <{githubRepoUrl}>
== What is it?
The `ejb-security-jaas` quickstart demonstrates how legacy `JAAS`-based security domains can be used in conjunction with `WildFly Elytron` to secure JEE applications. The secured EJB component can be accessed indirectly using a web application and it can also be directly invoked by a remote client. This quickstart shows how {productNameFull} must be configured to support both scenarios using the legacy `JAAS` integration.
View
@@ -22,10 +22,10 @@ When you deploy this example, two users are automatically created for you: `emus
To test this example:
. Enter a name in the `username` field and click on `Greet!`.
. Enter a name in the *username* field and click on *Greet!*.
. If you enter a username that is not in the database, you get a message `No such user exists!`.
. If you enter a valid username, you get a message `Hello,` followed by the user's first and last name.
. To create a new user, click the `Add a new user` link. Enter the username, first name, and last name and then click `Add User`. The user is added and a message displays the new user id number.
. To create a new user, click the *Add a new user* link. Enter the *username*, *first name*, and *last name*, and then click *Add User*. The user is added and a message displays the new user id number.
. Click on the `Greet a user!` link to return to the `Greet!` page.
//*************************************************
@@ -88,7 +88,7 @@ The `<annotation-property-replacement>` attribute is set to true in the `ee` sub
</subsystem>
----
The following system properties are defined and appear after the `&lt;extensions&gt;`:
The following system properties are defined and appear after the `<extensions>`:
[source,xml,options="nowrap"]
----
View
@@ -340,7 +340,7 @@ NOTE: For Windows, use the `__{jbossHomeName}_1__\bin\jboss-cli.bat` script.
</subsystem>
----
** Find the `transaction` subsystem and remove the `node-identifier` attribute from the `core-environment` element. Also remove the `&lt;jts/&gt;` element.
** Find the `transaction` subsystem and remove the `node-identifier` attribute from the `core-environment` element. Also remove the `<jts/>` element.
+
[source,xml,options="nowrap"]
----
@@ -66,8 +66,8 @@ $ mvn clean install wildfly:deploy
The application will be running at the following URL: http://localhost:8080/kitchensink-ear/.
. Enter a name, email address, and Phone nubmer in the input field and click the _Register_ button.
. If the data entered is valid, the new member will be registered and added to the _Members_ display list.
. Enter a name, email address, and Phone nubmer in the input field and click the *Register* button.
. If the data entered is valid, the new member will be registered and added to the *Members* display list.
. If the data is not valid, you must fix the validation errors and try again.
. When the registration is successful, you will see a log message in the server console:
+
@@ -146,7 +146,7 @@ To run the tests in Red Hat JBoss Developer Studio, you must first set the activ
* `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.
Then, to run the tests, right click on the project or individual classes and select `Run As* –> *JUnit Test* in the context menu.
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
@@ -33,7 +33,7 @@ Both contain a singleton configuration as specified in the file link:src/main/we
</c:clustering>
----
The wildcard (*) in the `&lt;ejb-name&gt;` element indicates that all MDBs contained in the application will be clustered singleton. As a result, only one node in the cluster will have those MDBs active at a specific time. If that node shuts down, another node in the cluster will become the active node with MDBs, called the singleton provider.
The wildcard (*) in the `ejb-name` element indicates that all MDBs contained in the application will be clustered singleton. As a result, only one node in the cluster will have those MDBs active at a specific time. If that node shuts down, another node in the cluster will become the active node with MDBs, called the singleton provider.
Also, we can find a configuration for delivery group in the same file:
@@ -20,13 +20,12 @@ The application this project produces is designed to be run on {productNameFull}
The `spring-greeter` quickstart is based on the `greeter` quickstart, but differs in that it uses Spring MVC for Mapping `GET` and `POST` requests:
* `&lt;mvc:annotation-driven\&gt;` configured in `src/main/webapp/WEB-INF/spring-mvc-context.xml` tells Spring to look for
`@RequestMapping` in our controllers.
* The `mvc:annotation-driven` element configured in the `src/main/webapp/WEB-INF/spring-mvc-context.xml` file tells Spring to look for `@RequestMapping` in the controllers.
* Spring then routes the HTTP requests to the correct methods in `CreateController.java` and `GreetController`
Spring's XML configurations are used to get hold of the database and entity manager (via jndi) to perform transactional operations:
* `&lt;tx:jta-transaction-manager/&gt;` and `&lt;tx:annotation-driven/&gt;` are configured in `/src/main/webapp/WEB-INF/spring-business-context.xml`
* The `tx:jta-transaction-manager` and `tx:annotation-driven` elements are configured in the `/src/main/webapp/WEB-INF/spring-business-context.xml` file.
* Methods in UserDaoImpl are marked as `@Transactional`, which Spring, using aspect oriented programming, surrounds with
boilerplate code to make the methods transactional
@@ -19,8 +19,8 @@ The `spring-kitchensink-basic` quickstart is an example of a Java EE 7 applicati
The `spring-kitchensink-basic` quickstart is an example of a Java EE 7 application using JSP, JPA and Spring 4.x in {productNameFull}. It
includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java:
* In `jboss-as-spring-mvc-context.xml` `&lt;context:component-scan base-package=&quot;org.jboss.as.quickstarts.kitchensink.spring.basic.controller&quot;/&gt;`
and `&lt;mvc:annotation-driven/&gt;` are used to register both the non-rest and rest controllers.
* In the `jboss-as-spring-mvc-context.xml` file, the `context:component-scan`
and `mvc:annotation-driven` elements are used to register both the non-rest and rest controllers.
* The controllers map the respective urls to methods using `@RequestMapping(url)`.
@@ -22,8 +22,8 @@ The `spring-kitchensink-springmvctest` quickstart demonstrates how to create an
* By using `@WebAppConfiguration` and `@ContextConfiguration` we tell Spring the configuration files we would like the tests to use.
* In `jboss-as-spring-mvc-context.xml` `&lt;context:component-scan base-package=&quot;org.jboss.as.quickstarts.kitchensink.spring.springmvctest.controller&quot;/&gt;`
and `&lt;mvc:annotation-driven/&gt;` are used to register both the non-rest and rest controllers.
* In the `jboss-as-spring-mvc-context.xml` file, the `context:component-scan`
and `mvc:annotation-driven` elements are used to register both the non-rest and rest controllers.
* The controllers map the respective urls to methods using `@RequestMapping(url)`.
@@ -23,13 +23,13 @@ For detailed explanation of the changes made to adapt the Quickstart to {product
PetClinic features alternative DAO implementations and application configurations for JDBC, JPA, and Spring Data JPA, with HSQLDB and MySQL as target databases. The default PetClinic configuration is JPA on HSQLDB.
* The `src/main/resources/spring/business-config.xml` pulls in `src/main/resources/spring/data-access.properties` to set the JDBC-related settings for the JPA EntityManager definition.
* The `src/main/resources/spring/business-config.xml` file pulls in the `src/main/resources/spring/data-access.properties` file to set the JDBC-related settings for the JPA EntityManager definition.
** A simple comment change in `data-access.properties` switches between the data access strategies.
* In `webapp/WEB_INF/web.xml` the `&lt;param-name&gt;spring.profiles.active&lt;/param-name&gt;` using `&lt;param-value&gt;jpa&lt;/param-value&gt;`
(_as the default_) refers to the bean to be used in `src/main/resources/spring/business-config.xml`.
** Setting the `&lt;param-value&gt;` to `jdbc`, `jpa`, or `spring-data-jpa` is all that is needed to change the DAO implementation.
* In the `webapp/WEB_INF/web.xml` file, the `<param-name>spring.profiles.active</param-name>` using `<param-value>jpa</param-value>`
(_as the default_) refers to the bean to be used in the `src/main/resources/spring/business-config.xml` file.
** Setting the `<param-value>` to `jdbc`, `jpa`, or `spring-data-jpa` is all that is needed to change the DAO implementation.
All versions of PetClinic also demonstrate JMX support via the use of `&lt;context:mbean-export/&gt;` in `resources/spring/tools-config.xml` for exporting MBeans. The `CallMonitoringAspect.java` is exposed using Spring's `@ManagedResource` and `@ManagedOperation` annotations and with `@Around` annotation we add monitoring around all `org.springframework.stereotype.Repository *` functions.
All versions of PetClinic also demonstrate JMX support via the use of `<context:mbean-export/>` in `resources/spring/tools-config.xml` for exporting MBeans. The `CallMonitoringAspect.java` is exposed using Spring's `@ManagedResource` and `@ManagedOperation` annotations and with `@Around` annotation we add monitoring around all `org.springframework.stereotype.Repository *` functions.
You can start up the JDK's JConsole to manage the exported bean.
The use of `@Cacheable` is also demonstrated in `ClinicServiceImpl.java` by caching the results of the method `findVets`.
View
@@ -22,7 +22,7 @@ This file is meant to serve as a template or guideline for your own quickstart `
* The first lines in the file after the quickstart name and description (Author:, Level:, etc.) are metadata tags used by the http://www.jboss.org/developer-materials/#!formats=jbossdeveloper_quickstart[JBoss Developer site]. Make sure you include 2 spaces at the end of each of these lines so they also render correctly when rendered as HTML files.
* Make sure you replace the `__QUICKSTART_NAME__` and `__YOUR_NAME__` variables in your `README.adoc` file with the appropriate values.
* Contributor instructions are enclosed within comments `&lt;!-- Contributor: --&gt;`. These instructions are only meant to help you and you should NOT include them in your README file!
* These instructions are only meant to help you and you should NOT include them in your README file!
* Review the other quickstart `README.adoc` files if you need help with formatting or content.
====
@@ -21,7 +21,7 @@ The `websocket-client` quickstart demonstrates how to use the Java API for WebSo
The example is modeled as a relay between a front-end WebSocket server endpoint and a back-end WebSocket client endpoint.
Message Flow: +
`(Browser Javascript WebSocket Client) &lt;-&gt; ({productName} WebSocket Server Endpoint) &lt;-&gt; ({productName} Websocket Client Endpoint) &lt;-&gt; (Remote WebSocket Echo Server)`
`Browser Javascript WebSocket Client` -> `{productName} WebSocket Server Endpoint` -> ``{productName} Websocket Client Endpoint` -> `Remote WebSocket Echo Server`
CDI events are used to pass messages between the front-end and back-end servers. A single back-end WebSocket client endpoint is shared for all front-end clients.
View
@@ -20,8 +20,8 @@ The `xml-jaxp` quickstart is a simple Java EE JAXP example that demonstrates how
This quickstart provides an example XML schema and document file to use when testing this quickstart.
* The XML schema is located here: `QUICKSTART_HOME/src/main/resources/catalog.xsd`
* The XML document is located here: `QUICKSTART_HOME/src/main/resources/catalog.xml`
* The XML schema is located here: `__QUICKSTART_HOME__/src/main/resources/catalog.xsd`
* The XML document is located here: `__QUICKSTART_HOME__/src/main/resources/catalog.xml`
== System Requirements
@@ -64,8 +64,8 @@ The application will be running at the following URL: http://localhost:8080/{art
To test the quickstart, follow these steps.
. Click the `Browse` button and navigate to the `QUICKSTART_HOME/src/main/resources/catalog.xml` file.
. Click the `Upload` button. The XML file content is parsed and displayed on the page.
. Click the *Browse* button and navigate to the `__QUICKSTART_HOME__/src/main/resources/catalog.xml` file.
. Click the *Upload* button. The XML file content is parsed and displayed on the page.
. You should see the following output in the server console that shows the DOMXMLParser was used:
+
[source,options="nowrap"]
@@ -77,8 +77,8 @@ To enable the alternative SAXXMLParser parser:
. Remove the comments that surround the alternate parser element in the `WEB-INF/beans.xml` file.
. Redeploy the application using the instructions above and access the application in a browser at the following URL: http://localhost:8080/{artifactId}/.
. Click the `Browse` button and navigate to the `QUICKSTART_HOME/src/main/resources/catalog.xml` file.
. Click the `Upload` button. The XML file content is parsed and displayed on the page.
. Click the *Browse* button and navigate to the `__QUICKSTART_HOME__/src/main/resources/catalog.xml` file.
. Click the *Upload* button. The XML file content is parsed and displayed on the page.
. You should now see following output in the server console:
+
[source,options="nowrap"]

0 comments on commit 292f166

Please sign in to comment.