You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ambari.apache.org by om...@apache.org on 2011/10/28 22:22:10 UTC

svn commit: r1190545 - in /incubator/ambari/trunk: client/src/main/java/org/apache/ambari/common/rest/entities/ controller/src/main/java/org/apache/ambari/components/impl/ controller/src/main/webapps/

Author: omalley
Date: Fri Oct 28 20:22:09 2011
New Revision: 1190545

URL: http://svn.apache.org/viewvc?rev=1190545&view=rev
Log:
AMBARI-111. Minor clean up of site documentation (omalley)

Modified:
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterDefinition.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterInformation.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterState.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Component.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ComponentDefinition.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Configuration.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ConfigurationCategory.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Node.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeAttributes.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeServer.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeState.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Property.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RepositoryKind.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Role.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RoleToNodes.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Stack.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/StackInformation.java
    incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/package.html
    incubator/ambari/trunk/controller/src/main/java/org/apache/ambari/components/impl/XmlComponentDefinition.java
    incubator/ambari/trunk/controller/src/main/webapps/wadl.xsl

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterDefinition.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterDefinition.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterDefinition.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterDefinition.java Fri Oct 28 20:22:09 2011
@@ -29,7 +29,26 @@ import javax.xml.bind.annotation.XmlType
 
 
 /**
- * <p>Java class for ClusterType complex type.
+ * Definition of a cluster.
+ * 
+ * <p>
+ * The schema is:
+ * <pre>
+ * element cluster {
+ *   attribute name { text }?
+ *   attribute description { text }?
+ *   attribute stackName { text }?
+ *   attribute stackRevision { text }?
+ *   attribute goalState { text }?
+ *   attribute nodes { text }?
+ *   element activeServices { text } *
+ *   element roleToNodesMap { 
+ *     attribute role { text }
+ *     attribute node { text }
+ *   } *
+ * }
+ * </pre>
+ * </p>
  * 
  */
 @XmlAccessorType(XmlAccessType.FIELD)
@@ -37,7 +56,7 @@ import javax.xml.bind.annotation.XmlType
     "activeServices",
     "roleToNodesMap"
 })
-@XmlRootElement(name = "Cluster")
+@XmlRootElement(name = "cluster")
 public class ClusterDefinition {
         
     public static final String GOAL_STATE_ACTIVE = "ACTIVE";

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterInformation.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterInformation.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterInformation.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterInformation.java Fri Oct 28 20:22:09 2011
@@ -17,19 +17,14 @@
  */
 package org.apache.ambari.common.rest.entities;
 
-import java.util.List;
-
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.bind.annotation.XmlType;
 
-
-
 /**
- * 
+ * Combination of the cluster definition and state.
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "ClusterInformation", propOrder = {

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterState.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterState.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterState.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ClusterState.java Fri Oct 28 20:22:09 2011
@@ -30,8 +30,20 @@ import javax.xml.datatype.XMLGregorianCa
 
 
 /**
- * <p>Java class for ClusterType complex type.
+ * The state of a cluster.
  * 
+ * <p>
+ * The schema looks like:
+ * <pre>
+ * element ClusterState {
+ *   attribute state { text }
+ *   attribute creationTime { text }
+ *   attribute deployTime { text }
+ *   attribute lastUpdateTime { text }
+ *   attribute markForDeletionWhenInAttic { boolean }
+ * }
+ * </pre>
+ * </p>
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlRootElement

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Component.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Component.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Component.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Component.java Fri Oct 28 20:22:09 2011
@@ -27,8 +27,7 @@ import javax.xml.bind.annotation.XmlType
 
 
 /**
- * <p>Java class for CategoryType complex type.
- * 
+ * Metadata information about a given component.
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "CategoryType", propOrder = {

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ComponentDefinition.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ComponentDefinition.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ComponentDefinition.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ComponentDefinition.java Fri Oct 28 20:22:09 2011
@@ -30,18 +30,18 @@ import javax.xml.bind.annotation.XmlRoot
 @XmlRootElement
 public class ComponentDefinition {
   @XmlAttribute
-  protected String group;
+  protected String provider;
   @XmlAttribute
   protected String definition; 
   @XmlAttribute
   protected String version;
   
   /**
-   * Get the group that published the component definition
-   * @return the group name
+   * Get the provider that published the component definition
+   * @return the provider name
    */
-  public String getGroup() {
-    return group;
+  public String getProvider() {
+    return provider;
   }
   
   /**
@@ -61,11 +61,11 @@ public class ComponentDefinition {
   }
   
   /**
-   * Set the group that published the component definition
-   * @param group
+   * Set the provider that published the component definition
+   * @param provider
    */
-  public void setGroup(String group) {
-    this.group = group;
+  public void setProvider(String provider) {
+    this.provider = provider;
   }
   
   /**
@@ -86,7 +86,7 @@ public class ComponentDefinition {
   
   public String toString() {
     StringBuilder buffer = new StringBuilder();
-    buffer.append(group);
+    buffer.append(provider);
     buffer.append('.');
     buffer.append(definition);
     buffer.append('@');

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Configuration.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Configuration.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Configuration.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Configuration.java Fri Oct 28 20:22:09 2011
@@ -28,8 +28,7 @@ import javax.xml.bind.annotation.XmlType
 
 
 /**
- * <p>Java class for ConfigurationType complex type.
- *  
+ * The configuration included in a Stack.
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "Configuration", propOrder = {

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ConfigurationCategory.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ConfigurationCategory.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ConfigurationCategory.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/ConfigurationCategory.java Fri Oct 28 20:22:09 2011
@@ -29,8 +29,7 @@ import javax.xml.bind.annotation.XmlType
 
 
 /**
- * <p>Java class for CategoryType complex type.
- * 
+ * A category in a Configuration.
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "ConfigurationCategory", propOrder = {
@@ -41,12 +40,6 @@ public class ConfigurationCategory {
 
     @XmlAttribute(required = true)
     protected String name;
-    @XmlAttribute(required = true)
-    protected String user;
-    @XmlAttribute(required = true)
-    protected String group;
-    @XmlAttribute(required = true)
-    protected int permission;
     @XmlElements({@XmlElement})
     protected List<Property> property;
 
@@ -103,27 +96,4 @@ public class ConfigurationCategory {
         return this.property;
     }
     
-    public String getUser() {
-    	return user;
-    }
-    
-    public void setUser(String user) {
-    	this.user = user;
-    }
-    
-    public int  getPermission() {
-    	return permission;
-    }
-    
-    public void setPermission(int mode) {
-    	this.permission = mode;
-    }
-
-    public String getGroup() {
-    	return group;
-    }
-    
-    public void setGroup(String group) {
-    	this.group = group;
-    }
 }

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Node.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Node.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Node.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Node.java Fri Oct 28 20:22:09 2011
@@ -25,8 +25,35 @@ import javax.xml.bind.annotation.XmlRoot
 import javax.xml.bind.annotation.XmlType;
 
 /**
- * <p>Java class for NodeType complex type.
+ * The information about each node.
  * 
+ * <p>
+ * The schema is
+ * <pre>
+ * element Node {
+ *   element nodeAttributes {
+ *     attribute cpuType { text }
+ *     attribute cpuUnits { text }
+ *     attribute cpuCores { text }
+ *     attribute ramInGB { text }
+ *     attribute diskSizeInGB { text }
+ *     attribute diskUnits { text }
+ *   }
+ *   element nodeState {
+ *     attribute lastHeartbeat { text }?
+ *     attribute clusterName { text }?
+ *     attribute agentInstalled { boolean }?
+ *     attribute allocatedToCluster { boolean }?
+ *     element nodeRoleNames { text }*
+ *     element nodeServers {
+ *       attribute name { text }
+ *       attribute state { text }
+ *       attribute lastStateUpdateTime { text }
+ *     }*
+ *   }
+ * }
+ * </pre>
+ * </p>
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "Node", propOrder = {

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeAttributes.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeAttributes.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeAttributes.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeAttributes.java Fri Oct 28 20:22:09 2011
@@ -22,8 +22,7 @@ import javax.xml.bind.annotation.XmlAcce
 import javax.xml.bind.annotation.XmlAttribute;
 
 /**
- * <p>Java class for NodeMetricsType complex type. 
- * 
+ * The attributes for each machine included in Node.
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 public class NodeAttributes {

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeServer.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeServer.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeServer.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeServer.java Fri Oct 28 20:22:09 2011
@@ -21,19 +21,18 @@ import java.util.Date;
 import java.util.GregorianCalendar;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlSchemaType;
 import javax.xml.bind.annotation.XmlType;
 import javax.xml.datatype.DatatypeFactory;
 import javax.xml.datatype.XMLGregorianCalendar;
 
-
+/**
+ * The information about a server running on a node, which is included in 
+ * Node.
+ */
 @XmlAccessorType(XmlAccessType.FIELD)
-@XmlType(name = "NodeServer", propOrder = {
-    "name",
-        "state",
-        "lastStateUpdateTime"
-})
+@XmlType
 public class NodeServer {
 
     public static final String NODE_SERVER_STATE_UP = "UP";
@@ -43,13 +42,13 @@ public class NodeServer {
      * name should be component name : role name
      * TODO : May be we can have component and role as two separate attributes instead of name
      */
-    @XmlElement(name = "Name", required = true)
+    @XmlAttribute(required = true)
     protected String name;
     
-    @XmlElement(name = "State", required = true)
+    @XmlAttribute(required = true)
     protected String state;  // UP/DOWN
     
-    @XmlElement(name = "LastStateUpdateTime", required = true)
+    @XmlAttribute(required = true)
     @XmlSchemaType(name = "dateTime")
     protected XMLGregorianCalendar lastStateUpdateTime;
         

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeState.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeState.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeState.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/NodeState.java Fri Oct 28 20:22:09 2011
@@ -23,6 +23,7 @@ import java.util.GregorianCalendar;
 import java.util.List;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.bind.annotation.XmlSchemaType;
@@ -30,20 +31,18 @@ import javax.xml.bind.annotation.XmlType
 import javax.xml.datatype.DatatypeFactory;
 import javax.xml.datatype.XMLGregorianCalendar;
 
-
+/**
+ * Information about the Nodes.
+  */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "NodeState", propOrder = {
-    "clusterName",
-    "allocatedToCluster",
-    "lastHeartbeatTime",
-    "agentInstalled",
-    "nodeRoleNames",
+   "nodeRoleNames",
     "nodeServers"
 })
 @XmlRootElement
 public class NodeState {
 
-    @XmlElement
+    @XmlAttribute
     @XmlSchemaType(name = "dateTime")
     protected XMLGregorianCalendar lastHeartbeatTime;
         
@@ -51,9 +50,24 @@ public class NodeState {
      * Associating the cluster name would reserve the node for a given cluster
      * 
      */
-    @XmlElement
+    @XmlAttribute
     protected String clusterName;
     
+    @XmlAttribute
+    protected Boolean agentInstalled = true;
+
+    @XmlAttribute
+    protected Boolean allocatedToCluster = false;
+        
+    /*
+     * null indicates no roles associated with this node.
+     */
+    @XmlElement
+    protected List<String> nodeRoleNames = null;
+        
+    @XmlElement
+    protected List<NodeServer> nodeServers = new ArrayList<NodeServer>();
+
     /**
      * @return the clusterName
      */
@@ -68,20 +82,6 @@ public class NodeState {
         this.clusterName = clusterName;
     }
 
-    @XmlElement
-    protected Boolean agentInstalled = true;
-
-    @XmlElement
-    protected Boolean allocatedToCluster = false;
-        
-    /*
-     * null indicates no roles associated with this node.
-     */
-    @XmlElement
-    protected List<String> nodeRoleNames = null;
-        
-    @XmlElement
-    protected List<NodeServer> nodeServers = new ArrayList<NodeServer>();
 
     /**
      * @return the nodeRoleNames

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Property.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Property.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Property.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Property.java Fri Oct 28 20:22:09 2011
@@ -23,7 +23,9 @@ import javax.xml.bind.annotation.XmlAttr
 import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.bind.annotation.XmlType;
 
-
+/**
+ * A single key/value pair inside a Configuration.
+ */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "Property", propOrder = {
     "name",

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RepositoryKind.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RepositoryKind.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RepositoryKind.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RepositoryKind.java Fri Oct 28 20:22:09 2011
@@ -28,7 +28,7 @@ import javax.xml.bind.annotation.XmlType
 
 
 /**
- * Entity for defining a list of repositories
+ * Entity for defining a list of repositories inside a Stack.
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "PackageType", propOrder = {

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Role.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Role.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Role.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Role.java Fri Oct 28 20:22:09 2011
@@ -24,7 +24,9 @@ import javax.xml.bind.annotation.XmlElem
 import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.bind.annotation.XmlType;
 
-
+/**
+ * Details of the configuration for a role inside of a Stack.
+ */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "RoleType", propOrder = {
     "name",

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RoleToNodes.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RoleToNodes.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RoleToNodes.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/RoleToNodes.java Fri Oct 28 20:22:09 2011
@@ -23,7 +23,7 @@ import javax.xml.bind.annotation.XmlAttr
 
 
 /**
- * <p>Java class for RoleToNodesMapEntryType complex type.
+ * The nodes associated with a role.
  */
 @XmlAccessorType(XmlAccessType.FIELD)
 public class RoleToNodes {

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Stack.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Stack.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Stack.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/Stack.java Fri Oct 28 20:22:09 2011
@@ -35,7 +35,55 @@ import javax.xml.datatype.XMLGregorianCa
 
 
 /**
- * <p>Java class for Stack type.
+ * Stack definition.
+ * Stacks include the components to deploy and the configuration for the
+ * cluster.
+ * 
+ * <p>
+ * The schema is:
+ * <pre>
+ * grammar {
+ *   start = element stack {
+ *     attribute name { text }?
+ *     attribute revision { text }?
+ *     attribute parentName { text }?
+ *     attribute parentRevision { text }?
+ *     attribute creationTime { text }?
+ *     element repositories {
+ *       attribute name { text }
+ *       element urls { text }*
+ *     }*
+ *     element configuration { Configuration }?
+ *     element components {
+ *       attribute name { text }
+ *       attribute version { text }?
+ *       attribute architecture { text }?
+ *       attribute provider { text }?
+ *       element definition {
+ *         attribute provider { text }?
+ *         attribute definition { text }?
+ *         attribute version { text }?
+ *       }
+ *       element configuration { Configuration }?
+ *       element roles {
+ *         attribute name { text }
+ *         element configuration { Configuration }?
+ *       }*
+ *     }*
+ *   }
+ *   Configuration = element configuration {
+ *     element category {
+ *       attribute name { text }
+ *       element property {
+ *         attribute name { text }
+ *         attribute value { text }
+ *         attribute force { boolean }?
+ *       }*
+ *     }
+ *   }
+ * }
+ * </pre>
+ * </p>
  * 
  */
 @XmlAccessorType(XmlAccessType.FIELD)

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/StackInformation.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/StackInformation.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/StackInformation.java (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/StackInformation.java Fri Oct 28 20:22:09 2011
@@ -28,6 +28,23 @@ import javax.xml.bind.annotation.XmlSche
 import javax.xml.bind.annotation.XmlType;
 import javax.xml.datatype.XMLGregorianCalendar;
 
+/**
+ * Stack metadata information, which is returned when listing stacks.
+ * 
+ * <p>
+ * The schema is:
+ * <pre>
+ * element StackInformation {
+ *   attribute name { text }
+ *   attribute revision { text }
+ *   attribute parentName { text }
+ *   attribute parentRevision { text }
+ *   attribute creationTime { text }
+ *   element component { text }*
+ * }
+ * </pre>
+ * </p>
+ */
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(name = "StackInformation", propOrder = {
     "name",

Modified: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/package.html
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/package.html?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/package.html (original)
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/package.html Fri Oct 28 20:22:09 2011
@@ -18,12 +18,21 @@
 -->
 
 <body>
+<p>
 This package defines the entities (messages) for Ambari's REST
 interface. The primary two are <a href="Stack.html">Stack</a>, which
 defines what needs to be deployed and how it should be configured,
 and <a href="ClusterDefinition.html">ClusterDefinition</a>, which
-binds a set of nodes to a given stack. These entities are defined
+binds a set of nodes to a given stack.
+</p>
+
+<p>
+These entities are defined
 using JAXB and thus can be represented as either XML or JSON with a
-very simple mapping.
+very simple mapping. Each of the top level entity classes in this package 
+have the
+<a href="http://relaxng.org/compact-tutorial-20030326.html">compact RelaxNG</a>
+schemas for their type.
+</p>
 </body>
 </html>

Modified: incubator/ambari/trunk/controller/src/main/java/org/apache/ambari/components/impl/XmlComponentDefinition.java
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/controller/src/main/java/org/apache/ambari/components/impl/XmlComponentDefinition.java?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/controller/src/main/java/org/apache/ambari/components/impl/XmlComponentDefinition.java (original)
+++ incubator/ambari/trunk/controller/src/main/java/org/apache/ambari/components/impl/XmlComponentDefinition.java Fri Oct 28 20:22:09 2011
@@ -296,7 +296,7 @@ public class XmlComponentDefinition exte
   }
 
   private static InputStream getInputStream(ComponentDefinition defn) {
-    String name = defn.getGroup().replace('.', '/') + "/acd/" +
+    String name = defn.getProvider().replace('.', '/') + "/acd/" +
                   defn.getDefinition() + '-' +
                   defn.getVersion() + ".acd";
     InputStream result = ClassLoader.getSystemResourceAsStream(name);
@@ -318,7 +318,7 @@ public class XmlComponentDefinition exte
   public static void main(String[] args) throws Exception {
     ComponentDefinition defn = new ComponentDefinition();
     defn.setDefinition("hadoop-hdfs");
-    defn.setGroup("org.apache.ambari");
+    defn.setProvider("org.apache.ambari");
     defn.setVersion("0.1.0");
     XmlComponentDefinition comp = new XmlComponentDefinition(defn);
     System.out.println(comp.provides);

Modified: incubator/ambari/trunk/controller/src/main/webapps/wadl.xsl
URL: http://svn.apache.org/viewvc/incubator/ambari/trunk/controller/src/main/webapps/wadl.xsl?rev=1190545&r1=1190544&r2=1190545&view=diff
==============================================================================
--- incubator/ambari/trunk/controller/src/main/webapps/wadl.xsl (original)
+++ incubator/ambari/trunk/controller/src/main/webapps/wadl.xsl Fri Oct 28 20:22:09 2011
@@ -382,10 +382,19 @@
     </xsl:for-each>
 </xsl:template>
 
+<xsl:template match="a" mode="copy">
+    <xsl:variable name="href" select="@href"/>
+    <a href="{$href}"><xsl:apply-templates select="node()" mode="copy"/></a>
+</xsl:template>
+
 <xsl:template match="b" mode="copy">
   <b><xsl:apply-templates select="node()" mode="copy"/></b>
 </xsl:template>
 
+<xsl:template match="br" mode="copy">
+  <br><xsl:apply-templates select="node()" mode="copy"/></br>
+</xsl:template>
+
 <xsl:template match="p" mode="copy">
   <p><xsl:apply-templates select="node()" mode="copy"/></p>
 </xsl:template>