From ed440c79f3640259a9912e97f29b91284c8c2292 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/qpid@957201 13f79535-47bb-0310-9956-ffa450edef68 --- java/management/client/src/example/README | 69 --------------------------- java/management/client/src/example/README.txt | 69 +++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 69 deletions(-) delete mode 100644 java/management/client/src/example/README create mode 100644 java/management/client/src/example/README.txt (limited to 'java/management/client/src/example') diff --git a/java/management/client/src/example/README b/java/management/client/src/example/README deleted file mode 100644 index 5365a416e5..0000000000 --- a/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/java/management/client/src/example/README.txt b/java/management/client/src/example/README.txt new file mode 100644 index 0000000000..5365a416e5 --- /dev/null +++ b/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 -- cgit v1.2.1