You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by kw...@apache.org on 2017/10/29 09:34:27 UTC
[6/6] qpid-broker-j git commit: QPID-7985: [Documentation] Update
README and remove content relating to the Qpid JMS AMQP 0-8..0-10 examples
QPID-7985: [Documentation] Update README and remove content relating to the Qpid JMS AMQP 0-8..0-10 examples
Project: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/commit/05112c65
Tree: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/tree/05112c65
Diff: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/diff/05112c65
Branch: refs/heads/master
Commit: 05112c65eb6243d609eff64617be6521b6cf5048
Parents: 7884dc9
Author: Keith Wall <ke...@gmail.com>
Authored: Sun Oct 29 09:31:02 2017 +0000
Committer: Keith Wall <ke...@gmail.com>
Committed: Sun Oct 29 09:33:53 2017 +0000
----------------------------------------------------------------------
README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
README.txt | 42 --------------------------------
2 files changed, 74 insertions(+), 42 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/05112c65/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0bfb188
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+# Apache Qpid Broker-J
+
+The Apache Qpid Broker-J (Broker-J) is a powerful open-source message broker.
+
+* Supports Advanced Message Queuing Protocol (AMQP) versions 0-8, 0-9, 0-91, 0-10 and AMQP 1.0
+* 100% Java implementation.
+* Authentication options include for LDAP, Kerberos, O-AUTH2, TLS client-authentication and more
+* Message storage options include Apache Derby, Oracle BDB JE, and Generic JDBC.
+* Web-management console.
+* Plug-able architecture
+
+Below are some quick pointers you might find useful.
+
+## Building the code
+
+The project requires Maven 3. Some example commands follow.
+
+Clean previous builds output and install all modules to local repository without running the tests:
+
+ mvn clean install -DskipTests
+
+Install all modules to the local repository after running all the tests:
+
+ mvn clean install
+
+## Running the tests
+
+Maven profiles are used to set the test configuration. If no profile is explicitly selected, *java-mms-1.0* is activated
+by default.
+
+ mvn verify
+
+To see all the available profiles.
+
+ mvn help:all-profiles
+
+Profiles whose name follows the form *java-store.n-n* are test configuration profiles. *store* signifies the storage
+module and *n-n* the AMQP protocol version number. For store, the options include:
+
+* *bdb* - Oracle BDB JE
+* *dby* - Apache Derby
+* *mms* - an in-memory store principally used for testing.
+
+For example, to activate a BDB with AMQP 1.0 protocol use:
+
+ mvn verify -P java-bdb.1-0
+
+When activating AMQP 0-8..0-10 profiles, it is also necessary to pass the system property *-DenableAmqp0-x*
+
+ mvn verify -P java-dby.1-0 -DenableAmqp0-x
+
+Perform a subset tests on the packaged release artifacts without installing:
+
+ mvn verify -Dtest=TestNamePattern* -DfailIfNoTests=false
+
+Execute the tests and produce code coverage report:
+
+ mvn clean test jacoco:report
+
+## Documentation
+
+Documentation (in docbook format) is found beneath the *doc* module. The documentation is available in a published
+form at:
+
+http://qpid.apache.org/documentation.html
+
+
+## Distribution assemblies
+
+After packaging, Broker-J distribution distribution assemblies can be found at:
+
+ broker/target
+
+To continue, see the Getting Started documentation in the docbook documentation mentioned above.
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/05112c65/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 1a73525..0000000
--- a/README.txt
+++ /dev/null
@@ -1,42 +0,0 @@
-Documentation for the Qpid components can be accessed on our website at:
-
-http://qpid.apache.org/documentation.html
-
-Some initial helper info can be found below.
-
-
-==== Building the code and running the tests ====
-
-Here are some example Maven build commands that you may find useful.
-
-Clean previous builds output and install all modules to local repository without
-running any of the unit or system tests.
-
- mvn clean install -DskipTests
-
-Clean previous builds output and installs all modules to the local repository
-after running all the tests using the Java BDB 0-10 profile
-
- mvn clean install -Pjava-bdb.0-10
-
-Perform a subset of the QA (int or sys tests) on the packaged release artifacts
-
- mvn verify -Dtest=TestNamePattern* -DfailIfNoTests=false
-
-Execute the unit tests and then produce the code coverage report
-
- mvn test jacoco:report
-
-For more details on how to build see:
-https://cwiki.apache.org/confluence/display/qpid/Qpid+Java+Build+How+To
-
-
-==== Running client examples =====
-
-Use maven to build the modules, and additionally copy the dependencies alongside their output:
-
- mvn clean package dependency:copy-dependencies -DskipTests
-
-Now you can then run the examples as follows:
-
- java -cp "client/example/target/classes/:client/example/target/dependency/*" org.apache.qpid.example.Drain
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org