From b4dcf79489661a2713c702b16ec8e9acc45e7d04 Mon Sep 17 00:00:00 2001 From: Jonathan Robie Date: Wed, 23 Jun 2010 13:44:50 +0000 Subject: Changed README to README.txt throughout the project for consistency. Removed gentools/README.txt, which described Velocity. git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@957201 13f79535-47bb-0310-9956-ffa450edef68 --- qpid/java/management/client/README | 42 ------------- qpid/java/management/client/README.txt | 42 +++++++++++++ qpid/java/management/client/src/example/README | 69 ---------------------- qpid/java/management/client/src/example/README.txt | 69 ++++++++++++++++++++++ qpid/java/management/tools/qpid-cli/README | 64 -------------------- qpid/java/management/tools/qpid-cli/README.txt | 64 ++++++++++++++++++++ 6 files changed, 175 insertions(+), 175 deletions(-) delete mode 100644 qpid/java/management/client/README create mode 100644 qpid/java/management/client/README.txt delete mode 100644 qpid/java/management/client/src/example/README create mode 100644 qpid/java/management/client/src/example/README.txt delete mode 100644 qpid/java/management/tools/qpid-cli/README create mode 100644 qpid/java/management/tools/qpid-cli/README.txt (limited to 'qpid/java/management') diff --git a/qpid/java/management/client/README b/qpid/java/management/client/README deleted file mode 100644 index 34a48f1f50..0000000000 --- a/qpid/java/management/client/README +++ /dev/null @@ -1,42 +0,0 @@ -QMan - Qpid JMX & WS-DM Management Bridge ---------------------------------------------------------- - -Documentation --------------- -All of our user documentation for QMan module can be accessed on our wiki at: - -http://cwiki.apache.org/qpid/qman-qpid-management-bridge.html - -This includes a Getting Started and User Guide as well as detailed developer documentation. -However, here's a VERY quick guide to running QMan, once you have installed it somewhere ! - -Running ------------------- - -Once you installed QMan, under the root folder you should have the following structure - -- bin (folder) : contains startup & shutdown scripts; -- app (folder) : contains the web application module; -- etc (folder) : contains configuration files; -- examples (folder) : contains examples (and a nested README as well) -- lib (folder) : contains dependency libraries; -- log (folder) : this is the default log folder. - -To run QMan, - -1) edit the $QMAN_HOME/etc/qman-config.xml file and configure broker connection data (host,port, username, etc...) -2) under the $QMAN_HOME/bin directory run : - -> ./qman-wsdm-start.sh - -now, under $QMAN_HOME/log directory you should see two files : - -1) server.log : contains web server log messages; -2) qman.log : contains qman log messages; - -Administration ------------------------ - -After QMan has been started successfully you can browse its administration console pointing your browser to : - -http://:/qman/admin.jsp \ No newline at end of file diff --git a/qpid/java/management/client/README.txt b/qpid/java/management/client/README.txt new file mode 100644 index 0000000000..34a48f1f50 --- /dev/null +++ b/qpid/java/management/client/README.txt @@ -0,0 +1,42 @@ +QMan - Qpid JMX & WS-DM Management Bridge +--------------------------------------------------------- + +Documentation +-------------- +All of our user documentation for QMan module can be accessed on our wiki at: + +http://cwiki.apache.org/qpid/qman-qpid-management-bridge.html + +This includes a Getting Started and User Guide as well as detailed developer documentation. +However, here's a VERY quick guide to running QMan, once you have installed it somewhere ! + +Running +------------------ + +Once you installed QMan, under the root folder you should have the following structure + +- bin (folder) : contains startup & shutdown scripts; +- app (folder) : contains the web application module; +- etc (folder) : contains configuration files; +- examples (folder) : contains examples (and a nested README as well) +- lib (folder) : contains dependency libraries; +- log (folder) : this is the default log folder. + +To run QMan, + +1) edit the $QMAN_HOME/etc/qman-config.xml file and configure broker connection data (host,port, username, etc...) +2) under the $QMAN_HOME/bin directory run : + +> ./qman-wsdm-start.sh + +now, under $QMAN_HOME/log directory you should see two files : + +1) server.log : contains web server log messages; +2) qman.log : contains qman log messages; + +Administration +----------------------- + +After QMan has been started successfully you can browse its administration console pointing your browser to : + +http://:/qman/admin.jsp \ No newline at end of file diff --git a/qpid/java/management/client/src/example/README b/qpid/java/management/client/src/example/README deleted file mode 100644 index 5365a416e5..0000000000 --- a/qpid/java/management/client/src/example/README +++ /dev/null @@ -1,69 +0,0 @@ -*** QMan WS-DM examples *** - -1) DESCRIPTION -This set of examples shows QMan WS-DM interface capabilities. -Each example is articulated in the following way. -First the name of the example class with a brief description about that is printed out. For example : - - GetWSDLMetadataExample -------------------------------------------------------------------- - -This example shows the usage of WS-DM -GetResourcePropertyRequest / Response on a -Group service. -The target resource is the WS-DM Adapter itself -and the requested property is "ws-rp:Entry". -WS-DM Adapter is a special WS-Resource (is a Group) -that acts as the main entry point for retrieving -all other managed resources. -So clients that want to deal with QMan WS-Resources -must first get resource identifiers sending -a GetResourcePropertyRequest to WS-DM Adapter -with "ws-rp:Entry" as target target property. - -------------------------------------------------------------------- - -Type enter to proceed. - -When you're ready type enter to proceed. Now the example runs and all the exchanged -SOAP messages are printed out on the screen. -If you want, we shipped (under sample_messages folder) several files containing those messages. - -A general note concerning examples...they are all written using java language so what you see is the -"java" usage of WS-DM client API. -The most important thing that you should keep in mind is that what is expected (on QMan side) is a SOAP WS-DM -compliant message so on top of that you don't need to use those java API but feel free to produce those messages -in your preferred way (by hand or using another programming language). - -Another thing : the examples contain a lot of code duplication because each of them is took as independent as possible. -The general idea is that you open an example source file and in the executeExample(...) method you should have a quick -idea of how things are working. -Also, as mentioned before, we provided, under the sample_messages folder, the messages that are part of each example conversation. -Remember : these messages are important, not the way / language you use to produce them. - -2) HOW TO RUN - -2.1) Java -You need JDK 1.5 or higher in order to run and / or compile the examples. - -2.2) Dependencies -You need to set / update the CLASSPATH environment variable with libraries found under $QMAN_HOME/app/qman/WEB-INF/lib. -After that you should be able to run one the shipped examples: - -> java org.apache.qpid.management.example.GetMultipleResourcePropertiesExample -> java org.apache.qpid.management.example.GetQManResourceMembersExample -> java org.apache.qpid.management.example.GetResourceMetadataDescriptorExample -> java org.apache.qpid.management.example.GetResourcePropertyDocumentExample -> java org.apache.qpid.management.example.GetResourcePropertyExample -> java org.apache.qpid.management.example.GetWSDLMetadataExample -> java org.apache.qpid.management.example.SetResourcePropertyExample - -Where - is the host (ip or hostname) where QMan is running; - is the port number where QMan is running; - -2.3) Qpid -You must have a running C++ broker with management enabled. - -2.4) QMan -You must have QMan WS-DM up, running and connected with the broker above. \ No newline at end of file diff --git a/qpid/java/management/client/src/example/README.txt b/qpid/java/management/client/src/example/README.txt new file mode 100644 index 0000000000..5365a416e5 --- /dev/null +++ b/qpid/java/management/client/src/example/README.txt @@ -0,0 +1,69 @@ +*** QMan WS-DM examples *** + +1) DESCRIPTION +This set of examples shows QMan WS-DM interface capabilities. +Each example is articulated in the following way. +First the name of the example class with a brief description about that is printed out. For example : + + GetWSDLMetadataExample +------------------------------------------------------------------- + +This example shows the usage of WS-DM +GetResourcePropertyRequest / Response on a +Group service. +The target resource is the WS-DM Adapter itself +and the requested property is "ws-rp:Entry". +WS-DM Adapter is a special WS-Resource (is a Group) +that acts as the main entry point for retrieving +all other managed resources. +So clients that want to deal with QMan WS-Resources +must first get resource identifiers sending +a GetResourcePropertyRequest to WS-DM Adapter +with "ws-rp:Entry" as target target property. + +------------------------------------------------------------------- + +Type enter to proceed. + +When you're ready type enter to proceed. Now the example runs and all the exchanged +SOAP messages are printed out on the screen. +If you want, we shipped (under sample_messages folder) several files containing those messages. + +A general note concerning examples...they are all written using java language so what you see is the +"java" usage of WS-DM client API. +The most important thing that you should keep in mind is that what is expected (on QMan side) is a SOAP WS-DM +compliant message so on top of that you don't need to use those java API but feel free to produce those messages +in your preferred way (by hand or using another programming language). + +Another thing : the examples contain a lot of code duplication because each of them is took as independent as possible. +The general idea is that you open an example source file and in the executeExample(...) method you should have a quick +idea of how things are working. +Also, as mentioned before, we provided, under the sample_messages folder, the messages that are part of each example conversation. +Remember : these messages are important, not the way / language you use to produce them. + +2) HOW TO RUN + +2.1) Java +You need JDK 1.5 or higher in order to run and / or compile the examples. + +2.2) Dependencies +You need to set / update the CLASSPATH environment variable with libraries found under $QMAN_HOME/app/qman/WEB-INF/lib. +After that you should be able to run one the shipped examples: + +> java org.apache.qpid.management.example.GetMultipleResourcePropertiesExample +> java org.apache.qpid.management.example.GetQManResourceMembersExample +> java org.apache.qpid.management.example.GetResourceMetadataDescriptorExample +> java org.apache.qpid.management.example.GetResourcePropertyDocumentExample +> java org.apache.qpid.management.example.GetResourcePropertyExample +> java org.apache.qpid.management.example.GetWSDLMetadataExample +> java org.apache.qpid.management.example.SetResourcePropertyExample + +Where + is the host (ip or hostname) where QMan is running; + is the port number where QMan is running; + +2.3) Qpid +You must have a running C++ broker with management enabled. + +2.4) QMan +You must have QMan WS-DM up, running and connected with the broker above. \ No newline at end of file diff --git a/qpid/java/management/tools/qpid-cli/README b/qpid/java/management/tools/qpid-cli/README deleted file mode 100644 index 6db439aad0..0000000000 --- a/qpid/java/management/tools/qpid-cli/README +++ /dev/null @@ -1,64 +0,0 @@ -README -n====== - -INSTALL -======= - source - ====== - 1.Set the environment variable QPID_HOME to the root directory of the repository or the release. - - 2.Run these command to build the source - - ant compile OR run the ant build in the parent directory(main ant script) - - 3.To launch the CLI run the script in bin folder with appropriate parameters. - - ex: - - Linux $QPID_HOME/bin/qpid-cli -h 10.8.100.122 -p 8334 - Windows %QPID_HOME%/bin/qpid-cli.bat -h 10.8.100.122 -p 8334 - - -h hostname (default localhost) - -p broker port (default 8999) - - binary - ====== - 1.Set the environment variable QPID_HOME to the root directory of the repository or the release. - - 2.To launch the CLI run the script in bin folder with appropriate parameters. - - ex: - - Linux $QPID_HOME/bin/qpid-cli -h 10.8.100.122 -p 8334 - Windows %QPID_HOME%/bin/qpid-cli.bat -h 10.8.100.122 -p 8334 - - -h hostname (default localhost) - -p broker port (default 8999) - - 3. No test cases are included in the binary version. - -TESTING -======= - -1.Test source is located in the test directory.If you want to run the tests please start the -Qpid java broker and run following ant targets. - - ant compile-tests This compile all the test sources - ant test This runs all the test cases -2.If you want to test with a remote broker please use the source release and change the constants in ConnectionConstants.java -class.(Default values are BROKER_HOSTNAME="localhost" BROKER_PORT="8999") - -For more informations please visit the project home page. - - - - - - - - - - - - - diff --git a/qpid/java/management/tools/qpid-cli/README.txt b/qpid/java/management/tools/qpid-cli/README.txt new file mode 100644 index 0000000000..6db439aad0 --- /dev/null +++ b/qpid/java/management/tools/qpid-cli/README.txt @@ -0,0 +1,64 @@ +README +n====== + +INSTALL +======= + source + ====== + 1.Set the environment variable QPID_HOME to the root directory of the repository or the release. + + 2.Run these command to build the source + + ant compile OR run the ant build in the parent directory(main ant script) + + 3.To launch the CLI run the script in bin folder with appropriate parameters. + + ex: + + Linux $QPID_HOME/bin/qpid-cli -h 10.8.100.122 -p 8334 + Windows %QPID_HOME%/bin/qpid-cli.bat -h 10.8.100.122 -p 8334 + + -h hostname (default localhost) + -p broker port (default 8999) + + binary + ====== + 1.Set the environment variable QPID_HOME to the root directory of the repository or the release. + + 2.To launch the CLI run the script in bin folder with appropriate parameters. + + ex: + + Linux $QPID_HOME/bin/qpid-cli -h 10.8.100.122 -p 8334 + Windows %QPID_HOME%/bin/qpid-cli.bat -h 10.8.100.122 -p 8334 + + -h hostname (default localhost) + -p broker port (default 8999) + + 3. No test cases are included in the binary version. + +TESTING +======= + +1.Test source is located in the test directory.If you want to run the tests please start the +Qpid java broker and run following ant targets. + + ant compile-tests This compile all the test sources + ant test This runs all the test cases +2.If you want to test with a remote broker please use the source release and change the constants in ConnectionConstants.java +class.(Default values are BROKER_HOSTNAME="localhost" BROKER_PORT="8999") + +For more informations please visit the project home page. + + + + + + + + + + + + + -- cgit v1.2.1