activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chir...@apache.org
Subject svn commit: r1103821 - in /activemq/activemq-apollo/trunk: apollo-distro/src/main/descriptors/ apollo-website/ apollo-website/src/ apollo-website/src/community/ apollo-website/src/documentation/
Date Mon, 16 May 2011 18:19:29 GMT
Author: chirino
Date: Mon May 16 18:19:28 2011
New Revision: 1103821

URL: http://svn.apache.org/viewvc?rev=1103821&view=rev
Log:
Integrating the rest api documentation more.

Modified:
    activemq/activemq-apollo/trunk/apollo-distro/src/main/descriptors/common-bin.xml
    activemq/activemq-apollo/trunk/apollo-website/pom.xml
    activemq/activemq-apollo/trunk/apollo-website/src/community/developers.page
    activemq/activemq-apollo/trunk/apollo-website/src/documentation/architecture.md
    activemq/activemq-apollo/trunk/apollo-website/src/documentation/index.page
    activemq/activemq-apollo/trunk/apollo-website/src/documentation/management-api.md
    activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md
    activemq/activemq-apollo/trunk/apollo-website/src/download.page
    activemq/activemq-apollo/trunk/apollo-website/src/index.page

Modified: activemq/activemq-apollo/trunk/apollo-distro/src/main/descriptors/common-bin.xml
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-distro/src/main/descriptors/common-bin.xml?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-distro/src/main/descriptors/common-bin.xml (original)
+++ activemq/activemq-apollo/trunk/apollo-distro/src/main/descriptors/common-bin.xml Mon May
16 18:19:28 2011
@@ -76,28 +76,6 @@
       <outputDirectory>/docs/site</outputDirectory>
     </fileSet>
 
-    <!-- api doco -->
-    <fileSet>
-      <directory>${basedir}/../apollo-broker/target/apidocs</directory>
-      <outputDirectory>/docs/apidocs/apollo-broker</outputDirectory>
-    </fileSet> 
-    <fileSet>
-      <directory>${basedir}/../apollo-store/target/apidocs</directory>
-      <outputDirectory>/docs/apidocs/apollo-store</outputDirectory>
-    </fileSet> 
-    <fileSet>
-      <directory>${basedir}/../apollo-transport/target/apidocs</directory>
-      <outputDirectory>/docs/apidocs/apollo-transport</outputDirectory>
-    </fileSet> 
-    <fileSet>
-      <directory>${basedir}/../apollo-util/target/apidocs</directory>
-      <outputDirectory>/docs/apidocs/apollo-util</outputDirectory>
-    </fileSet> 
-    <fileSet>
-      <directory>${basedir}/../apollo-dto/target/apidocs</directory>
-      <outputDirectory>/docs/apidocs/apollo-dto</outputDirectory>
-    </fileSet> 
-
   </fileSets>
 
 </component>

Modified: activemq/activemq-apollo/trunk/apollo-website/pom.xml
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/pom.xml?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/pom.xml (original)
+++ activemq/activemq-apollo/trunk/apollo-website/pom.xml Mon May 16 18:19:28 2011
@@ -75,6 +75,43 @@
       <scope>test</scope>
     </dependency>
     
+    <!-- To make sure the javadocs get built before this module -->
+    <dependency>
+      <groupId>org.apache.activemq</groupId>
+      <artifactId>apollo-dto</artifactId>
+      <version>1.0-SNAPSHOT</version>
+      <classifier>javadoc</classifier>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.activemq</groupId>
+      <artifactId>apollo-broker</artifactId>
+      <version>1.0-SNAPSHOT</version>
+      <classifier>javadoc</classifier>
+      <scope>test</scope>
+    </dependency>    
+    <dependency>
+      <groupId>org.apache.activemq</groupId>
+      <artifactId>apollo-store</artifactId>
+      <version>1.0-SNAPSHOT</version>
+      <classifier>javadoc</classifier>
+      <scope>test</scope>
+    </dependency>    
+    <dependency>
+      <groupId>org.apache.activemq</groupId>
+      <artifactId>apollo-transport</artifactId>
+      <version>1.0-SNAPSHOT</version>
+      <classifier>javadoc</classifier>
+      <scope>test</scope>
+    </dependency>    
+    <dependency>
+      <groupId>org.apache.activemq</groupId>
+      <artifactId>apollo-util</artifactId>
+      <version>1.0-SNAPSHOT</version>
+      <classifier>javadoc</classifier>
+      <scope>test</scope>
+    </dependency>    
+
   </dependencies>
 
   <build>
@@ -95,6 +132,57 @@
       </plugin>
 
       <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-dependency-plugin</artifactId>
+        <version>2.2</version>
+        <executions>
+          <execution>
+            <id>unpack</id>
+            <phase>package</phase>
+            <goals>
+              <goal>unpack</goal>
+            </goals>
+            <configuration>
+              <artifactItems>
+                <artifactItem>
+                  <groupId>org.apache.activemq</groupId>
+                  <artifactId>apollo-dto</artifactId>
+                  <classifier>javadoc</classifier> 
+                  <outputDirectory>${basedir}/target/sitegen/documentation/api/apollo-dto</outputDirectory>
+                </artifactItem>
+                <artifactItem>
+                  <groupId>org.apache.activemq</groupId>
+                  <artifactId>apollo-broker</artifactId>
+                  <classifier>javadoc</classifier> 
+                  <outputDirectory>${basedir}/target/sitegen/documentation/api/apollo-broker</outputDirectory>
+                </artifactItem>
+                <artifactItem>
+                  <groupId>org.apache.activemq</groupId>
+                  <artifactId>apollo-store</artifactId>
+                  <classifier>javadoc</classifier> 
+                  <outputDirectory>${basedir}/target/sitegen/documentation/api/apollo-store</outputDirectory>
+                </artifactItem>
+                <artifactItem>
+                  <groupId>org.apache.activemq</groupId>
+                  <artifactId>apollo-transport</artifactId>
+                  <classifier>javadoc</classifier> 
+                  <outputDirectory>${basedir}/target/sitegen/documentation/api/apollo-transport</outputDirectory>
+                </artifactItem>
+                <artifactItem>
+                  <groupId>org.apache.activemq</groupId>
+                  <artifactId>apollo-util</artifactId>
+                  <classifier>javadoc</classifier> 
+                  <outputDirectory>${basedir}/target/sitegen/documentation/api/apollo-util</outputDirectory>
+                </artifactItem>
+                
+              </artifactItems>
+              <!-- other configurations here -->
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+
+      <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
         <version>${maven-surefire-plugin-version}</version>
         <configuration>

Modified: activemq/activemq-apollo/trunk/apollo-website/src/community/developers.page
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/community/developers.page?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/community/developers.page (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/community/developers.page Mon May 16
18:19:28 2011
@@ -37,4 +37,12 @@ Ready to start hacking on ${project_name
 * [Architecture](../documentation/architecture.html)
 * [Module Organization](../documentation/module-organization.html)
 
+# API Reference
+
+* [`apollo-broker` API](../documentation/api/apollo-broker/index.html)
+* [`apollo-dto` API](../documentation/api/apollo-dto/index.html)
+* [`apollo-store` API](../documentation/api/apollo-store/index.html)
+* [`apollo-transport` API](../documentation/api/apollo-transport/index.html)
+* [`apollo-util` API](../documentation/api/apollo-util/index.html)
+
 Looking for the website documentation of a different ${project_name} [version](${website_base_url}/versions/index.html)?

Modified: activemq/activemq-apollo/trunk/apollo-website/src/documentation/architecture.md
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/documentation/architecture.md?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/documentation/architecture.md (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/documentation/architecture.md Mon May
16 18:19:28 2011
@@ -51,7 +51,7 @@ means that the previous ActiveMQ broker 
 major overhaul. All synchronous broker interfaces had to be changed
 so that they would instead return results via asynchronous callbacks.
 
-### Scala 2.8 Implementation
+### Scala 2.9 Implementation
 
 Even though Apollo started as a fork of ActiveMQ 5.x, the new reactor design
 restrictions required major changes from the network IO handling, to the
@@ -88,11 +88,14 @@ serious limitations:
 * Rich data types are hard to expose
 
 Apollo exposes a rich and detailed state of the sever using REST based JSON
-or XML services.
+services.
 
 * A management client can easily be implemented in any language.
 * There is very little management overhead since there is no special
-  registration with the management system. The JAX-RS based management web
+  registration with the management system. The REST based management web
   application knows how to navigate the internal structure of a broker to
   access all the need status and statistics.
+  
+See the [Management API](management-api.html) documentation for
+details.
 

Modified: activemq/activemq-apollo/trunk/apollo-website/src/documentation/index.page
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/documentation/index.page?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/documentation/index.page (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/documentation/index.page Mon May 16
18:19:28 2011
@@ -25,5 +25,6 @@ ${project_slogan}
 
 * [Getting Started Guide](getting-started.html)
 * [User Manual](user-manual.html)
+* [Management API](management-api.html)
 * [Contributor Documentation](../community/developers.html)
  

Modified: activemq/activemq-apollo/trunk/apollo-website/src/documentation/management-api.md
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/documentation/management-api.md?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/documentation/management-api.md (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/documentation/management-api.md Mon
May 16 18:19:28 2011
@@ -1,4 +1,4 @@
-# Apollo ${project_version} Management REST API
+# Apollo ${project_version} Management API
 
 {:toc:2-5}
 
@@ -54,7 +54,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/
 
-Results in:
+Results in a [Broker Status](./api/apollo-dto/org/apache/activemq/apollo/dto/BrokerStatusDTO.html)
:
 
 {pygmentize:: js}
 {
@@ -86,7 +86,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/connectors/stomp
 
-Results in:
+Results in a [Connector Status](./api/apollo-dto/org/apache/activemq/apollo/dto/ConnectorStatusDTO.html):
 
 {pygmentize:: js}
 {
@@ -112,7 +112,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/connections/5
 
-Results in:
+Results in a [Connection Status](./api/apollo-dto/org/apache/activemq/apollo/dto/ConnectionStatusDTO.html):
 
 {pygmentize:: js}
 {
@@ -153,7 +153,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/virtual-hosts/localhost
 
-Results in:
+Results in a [Virtual Host Status](./api/apollo-dto/org/apache/activemq/apollo/dto/VirtualHostStatusDTO.html):
 
 {pygmentize:: js}
 {
@@ -185,7 +185,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/virtual-hosts/localhost/store
 
-Results in:
+Results in a [Store Status](./api/apollo-dto/org/apache/activemq/apollo/dto/StoreStatusDTO.html):
 
 {pygmentize:: js}
 {
@@ -234,7 +234,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/virtual-hosts/localhost/queues/1
 
-Results in:
+Results in a [Queue Status](./api/apollo-dto/org/apache/activemq/apollo/dto/QueueStatusDTO.html):
 
 {pygmentize:: js}
 {
@@ -318,7 +318,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/virtual-hosts/localhost/topics/1
 
-Results in:
+Results in a [Topic Status](./api/apollo-dto/org/apache/activemq/apollo/dto/TopicStatusDTO.html):
 
 {pygmentize:: js}
 {
@@ -359,7 +359,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/config/runtime
 
-Results in:
+Results in a [Broker Configuration](./api/apollo-dto/org/apache/activemq/apollo/dto/BrokerDTO.html):
 
 {pygmentize:: js}
 {
@@ -459,7 +459,7 @@ Example:
     $ curl -H "Accept: application/json" -u "admin:password" \
     http://localhost:61680/queue-metrics
 
-Results in:
+Results in an [Aggregate of Queue Metrics](./api/apollo-dto/org/apache/activemq/apollo/dto/AggregateQueueMetricsDTO.html):
 
 {pygmentize:: js}
 {

Modified: activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md Mon May
16 18:19:28 2011
@@ -785,6 +785,9 @@ The web interface will display the statu
 attached connections.  It will also allow you to drill into each configured
 virtual host and view the topics and queues being used. 
 
+Please see the [Management API](management-api.html) documentation for more 
+information on how to use the web based interface as a RESTful API.
+
 ### Exporting/Importing Stores
 
 Exporting compresses all the data in a virtual host's message store in a zip

Modified: activemq/activemq-apollo/trunk/apollo-website/src/download.page
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/download.page?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/download.page (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/download.page Mon May 16 18:19:28 2011
@@ -45,7 +45,7 @@ table.download tr td {
 - for( version <- project_versions.headOption )
   :&markdown
     ### #{project_name} #{version} 
-    [Release Notes](blog/releases/release-#{version.replace('.','-')}.html) | [Installation
Instructions](${website_base_url}/versions/#{version}/website/documentation/getting-started.html)
+    [Release Notes](blog/releases/release-#{version.replace('.','-')}.html) | [Installation
Instructions](${website_base_url}/versions/#{version}/website/documentation/getting-started.html)
| [Documentation](${website_base_url}/versions/#{version}/website/documentation/index.html)
     
   table.download
     tr 
@@ -75,7 +75,7 @@ table.download tr td {
   - for( version <- project_versions.drop(1) )
     :&markdown
       ### #{project_name} #{version} 
-      [Release Notes](blog/releases/release-#{version.replace('.','-')}.html) | [Installation
Instructions](${website_base_url}/versions/#{version}/website/documentation/getting-started.html)
+      [Release Notes](blog/releases/release-#{version.replace('.','-')}.html) | [Installation
Instructions](${website_base_url}/versions/#{version}/website/documentation/getting-started.html)
| [Documentation](${website_base_url}/versions/#{version}/website/documentation/index.html)
 
     table.download
       tr 
@@ -106,7 +106,7 @@ table.download tr td {
   build?  **Warnning**: These builds are extremely bleeding edge!
 
   ### #{project_name} #{project_snapshot_version} 
-  [Installation Instructions](${website_base_url}/versions/#{project_snapshot_version}/website/documentation/getting-started.html)
+  [Installation Instructions](${website_base_url}/versions/#{project_snapshot_version}/website/documentation/getting-started.html)
| [Documentation](${website_base_url}/versions/#{project_snapshot_version}/website/documentation/index.html)
 
 table.download
   tr 

Modified: activemq/activemq-apollo/trunk/apollo-website/src/index.page
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/index.page?rev=1103821&r1=1103820&r2=1103821&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/index.page (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/index.page Mon May 16 18:19:28 2011
@@ -48,11 +48,12 @@ ActiveMQ 5.x JMS clients.
 * [JAAS Authentication](documentation/user-manual.html#Authentication)
 * [ACL Authorization](documentation/user-manual.html#Authorization)
 * [SSL/TLS Support](documentation/user-manual.html#Using_SSL_TLS)
-* REST based management
+* [REST Based Management](documentation/architecture.html#REST_Based_Management)
 
 ## Documentation
 
  * [Getting Started Guide](documentation/getting-started.html)
  * [User Manual](documentation/user-manual.html)
+ * [Management API](documentation/management-api.html)
  
 



Mime
View raw message