AMBARI-21008 fix @Api and @path orders, make property constants consi…

…stent across all affected files Change-Id: Ief645a3bb8267499164756efb94bf2018d05cc8d
apache · Mar 20, 2018 · 3516b29 · 3516b29
1 parent 8aa9e18
commit 3516b29
Show file tree

Hide file tree

Showing 15 changed files with 219 additions and 213 deletions.
diff --git a/...r/src/main/java/org/apache/ambari/server/api/services/views/ViewDataMigrationService.java b/...r/src/main/java/org/apache/ambari/server/api/services/views/ViewDataMigrationService.java
@@ -41,8 +41,8 @@
 /**
  * Service responsible for data migration between view instances.
  */
-@Api(tags = "Views", description = "Endpoint for view specific operations")
 @Path("/views/{viewName}/versions/{version}/instances/{instanceName}/migrate")
+@Api(tags = "Views", description = "Endpoint for view specific operations")
 public class ViewDataMigrationService extends BaseService {
   /**
    * Logger.

diff --git a/...erver/src/main/java/org/apache/ambari/server/api/services/views/ViewPrivilegeService.java b/...erver/src/main/java/org/apache/ambari/server/api/services/views/ViewPrivilegeService.java
@@ -55,8 +55,8 @@
 /**
  *  Service responsible for view privilege resource requests.
  */
-@Api(tags = "Views", description = "Endpoint for view specific operations")
 @Path("/views/{viewName}/versions/{version}/instances/{instanceName}/privileges")
+@Api(tags = "Views", description = "Endpoint for view specific operations")
 public class ViewPrivilegeService extends BaseService {
 
   public static final String PRIVILEGE_INFO_REQUEST_TYPE = "org.apache.ambari.server.controller.ViewPrivilegeResponse.Wrapper";

diff --git a/ambari-server/src/main/java/org/apache/ambari/server/controller/ViewVersionResponse.java b/ambari-server/src/main/java/org/apache/ambari/server/controller/ViewVersionResponse.java
@@ -123,7 +123,7 @@ public String getArchive() {
      * Returns build number
      * @return build number
      */
-    @ApiModelProperty(name = ViewVersionResourceProvider.VIEW_BUILD_PROPERTY_ID)
+    @ApiModelProperty(name = ViewVersionResourceProvider.BUILD_NUMBER_PROPERTY_ID)
     public String getBuildNumber() {
       return buildNumber;
     }
@@ -133,7 +133,7 @@ public String getBuildNumber() {
      * @return {@code true} if cluster is configurable
      *         {@code false} otherwise.
      */
-    @ApiModelProperty(name = ViewVersionResourceProvider.CLUSTER_CONFIG_PROPERTY_ID)
+    @ApiModelProperty(name = ViewVersionResourceProvider.CLUSTER_CONFIGURABLE_PROPERTY_ID)
     public boolean isClusterConfigurable() {
       return clusterConfigurable;
     }
@@ -195,7 +195,7 @@ public List<ParameterConfig> getParameters() {
      * Returns view status
      * @return {@link ViewDefinition.ViewStatus}
      */
-    @ApiModelProperty(name = ViewVersionResourceProvider.VIEW_STATUS_PROPERTY_ID)
+    @ApiModelProperty(name = ViewVersionResourceProvider.STATUS_PROPERTY_ID)
     public ViewDefinition.ViewStatus getStatus() {
       return status;
     }
@@ -204,7 +204,7 @@ public ViewDefinition.ViewStatus getStatus() {
      * Returns views status details
      * @return status details
      */
-    @ApiModelProperty(name = ViewVersionResourceProvider.VIEW_STATUS_DETAIL_PROPERTY_ID)
+    @ApiModelProperty(name = ViewVersionResourceProvider.STATUS_DETAIL_PROPERTY_ID)
     public String getStatusDetail() {
       return statusDetail;
     }
@@ -223,7 +223,7 @@ public boolean isSystem() {
      * Returns view version
      * @return view version
      */
-    @ApiModelProperty(name = ViewVersionResourceProvider.VIEW_VERSION_PROPERTY_ID)
+    @ApiModelProperty(name = ViewVersionResourceProvider.VERSION_PROPERTY_ID)
     public String getVersion() {
       return version;
     }

diff --git a/...in/java/org/apache/ambari/server/controller/internal/AmbariPrivilegeResourceProvider.java b/...in/java/org/apache/ambari/server/controller/internal/AmbariPrivilegeResourceProvider.java
@@ -17,7 +17,7 @@
  */
 package org.apache.ambari.server.controller.internal;
 
-import static org.apache.ambari.server.controller.internal.ClusterPrivilegeResourceProvider.PRIVILEGE_CLUSTER_NAME_PROPERTY_ID;
+import static org.apache.ambari.server.controller.internal.ClusterPrivilegeResourceProvider.CLUSTER_NAME;
 import static org.apache.ambari.server.controller.internal.ViewPrivilegeResourceProvider.INSTANCE_NAME;
 import static org.apache.ambari.server.controller.internal.ViewPrivilegeResourceProvider.VERSION;
 import static org.apache.ambari.server.controller.internal.ViewPrivilegeResourceProvider.VIEW_NAME;
@@ -30,6 +30,7 @@
 
 import org.apache.ambari.server.controller.spi.Predicate;
 import org.apache.ambari.server.controller.spi.Resource;
+import org.apache.ambari.server.controller.utilities.PropertyHelper;
 import org.apache.ambari.server.orm.dao.ClusterDAO;
 import org.apache.ambari.server.orm.entities.ClusterEntity;
 import org.apache.ambari.server.orm.entities.GroupEntity;
@@ -52,7 +53,7 @@
  */
 public class AmbariPrivilegeResourceProvider extends PrivilegeResourceProvider<Object> {
 
-  public static final String PRIVILEGE_TYPE_PROPERTY_ID  = "PrivilegeInfo/type";
+  public static final String TYPE = PrivilegeResourceProvider.PRIVILEGE_INFO + PropertyHelper.EXTERNAL_PATH_SEP + PrivilegeResourceProvider.TYPE_PROPERTY_ID;
 
   /**
    * Data access object used to obtain privilege entities.
@@ -71,8 +72,8 @@ public class AmbariPrivilegeResourceProvider extends PrivilegeResourceProvider<O
       VIEW_NAME,
       VERSION,
       INSTANCE_NAME,
-      PRIVILEGE_CLUSTER_NAME_PROPERTY_ID,
-      PRIVILEGE_TYPE_PROPERTY_ID);
+      CLUSTER_NAME,
+      TYPE);
 
   /**
    * The key property ids for a privilege resource.
@@ -164,7 +165,7 @@ protected Resource toResource(PrivilegeEntity privilegeEntity,
             break;
           case CLUSTER:
             ClusterEntity clusterEntity = (ClusterEntity) resourceEntities.get(resourceEntity.getId());
-            setResourceProperty(resource, PRIVILEGE_CLUSTER_NAME_PROPERTY_ID, clusterEntity.getClusterName(), requestedIds);
+            setResourceProperty(resource, CLUSTER_NAME, clusterEntity.getClusterName(), requestedIds);
             break;
           case VIEW:
             ViewInstanceEntity viewInstanceEntity = (ViewInstanceEntity) resourceEntities.get(resourceEntity.getId());
@@ -176,7 +177,7 @@ protected Resource toResource(PrivilegeEntity privilegeEntity,
             break;
         }
 
-        setResourceProperty(resource, PRIVILEGE_TYPE_PROPERTY_ID, resourceType.name(), requestedIds);
+        setResourceProperty(resource, TYPE, resourceType.name(), requestedIds);
       }
     }
 

diff --git a/...n/java/org/apache/ambari/server/controller/internal/ClusterPrivilegeResourceProvider.java b/...n/java/org/apache/ambari/server/controller/internal/ClusterPrivilegeResourceProvider.java
@@ -50,16 +50,15 @@ public class ClusterPrivilegeResourceProvider extends PrivilegeResourceProvider<
    */
   protected static ClusterDAO clusterDAO;
 
-  /**
-   * Cluster privilege property id constants.
-   */
-  protected static final String PRIVILEGE_CLUSTER_NAME_PROPERTY_ID = PropertyHelper.getPropertyId("PrivilegeInfo", "cluster_name");
+  protected static final String CLUSTER_NAME_PROPERTY_ID = "cluster_name";
+
+  protected static final String CLUSTER_NAME = PrivilegeResourceProvider.PRIVILEGE_INFO + PropertyHelper.EXTERNAL_PATH_SEP + CLUSTER_NAME_PROPERTY_ID;
 
   /**
    * The property ids for a privilege resource.
    */
   private static Set<String> propertyIds = Sets.newHashSet(
-      PRIVILEGE_CLUSTER_NAME_PROPERTY_ID,
+      CLUSTER_NAME,
       PRIVILEGE_ID,
       PERMISSION_NAME,
       PERMISSION_NAME,
@@ -71,7 +70,7 @@ public class ClusterPrivilegeResourceProvider extends PrivilegeResourceProvider<
    * The key property ids for a privilege resource.
    */
   private static Map<Resource.Type, String> keyPropertyIds = ImmutableMap.<Resource.Type, String>builder()
-      .put(Resource.Type.Cluster, PRIVILEGE_CLUSTER_NAME_PROPERTY_ID)
+      .put(Resource.Type.Cluster, CLUSTER_NAME)
       .put(Resource.Type.ClusterPrivilege, PRIVILEGE_ID)
       .build();
 
@@ -116,7 +115,7 @@ public Map<Resource.Type, String> getKeyPropertyIds() {
   @Override
   public Map<Long, ClusterEntity> getResourceEntities(Map<String, Object> properties) {
 
-    String clusterName = (String) properties.get(PRIVILEGE_CLUSTER_NAME_PROPERTY_ID);
+    String clusterName = (String) properties.get(CLUSTER_NAME);
 
     if (clusterName == null) {
       Map<Long, ClusterEntity> resourceEntities = new HashMap<>();
@@ -134,7 +133,7 @@ public Map<Long, ClusterEntity> getResourceEntities(Map<String, Object> properti
 
   @Override
   public Long getResourceEntityId(Predicate predicate) {
-    final String clusterName = getQueryParameterValue(PRIVILEGE_CLUSTER_NAME_PROPERTY_ID, predicate).toString();
+    final String clusterName = getQueryParameterValue(CLUSTER_NAME, predicate).toString();
     final ClusterEntity clusterEntity = clusterDAO.findByName(clusterName);
     return clusterEntity.getResource().getId();
   }
@@ -153,7 +152,7 @@ protected Resource toResource(PrivilegeEntity privilegeEntity,
     Resource resource = super.toResource(privilegeEntity, userEntities, groupEntities, roleEntities, resourceEntities, requestedIds);
     if (resource != null) {
       ClusterEntity clusterEntity = resourceEntities.get(privilegeEntity.getResource().getId());
-      setResourceProperty(resource, PRIVILEGE_CLUSTER_NAME_PROPERTY_ID, clusterEntity.getClusterName(), requestedIds);
+      setResourceProperty(resource, CLUSTER_NAME, clusterEntity.getClusterName(), requestedIds);
     }
     return resource;
   }

diff --git a/...ain/java/org/apache/ambari/server/controller/internal/GroupPrivilegeResourceProvider.java b/...ain/java/org/apache/ambari/server/controller/internal/GroupPrivilegeResourceProvider.java
@@ -33,6 +33,7 @@
 import org.apache.ambari.server.controller.spi.Resource;
 import org.apache.ambari.server.controller.spi.SystemException;
 import org.apache.ambari.server.controller.spi.UnsupportedPropertyException;
+import org.apache.ambari.server.controller.utilities.PropertyHelper;
 import org.apache.ambari.server.orm.dao.ClusterDAO;
 import org.apache.ambari.server.orm.dao.GroupDAO;
 import org.apache.ambari.server.orm.dao.ViewInstanceDAO;
@@ -58,17 +59,19 @@
 @StaticallyInject
 public class GroupPrivilegeResourceProvider extends ReadOnlyResourceProvider {
 
-  protected static final String PRIVILEGE_PRIVILEGE_ID_PROPERTY_ID = PrivilegeResourceProvider.PRIVILEGE_ID;
-  protected static final String PRIVILEGE_PERMISSION_NAME_PROPERTY_ID = PrivilegeResourceProvider.PERMISSION_NAME;
-  protected static final String PRIVILEGE_PERMISSION_LABEL_PROPERTY_ID = PrivilegeResourceProvider.PERMISSION_LABEL;
-  protected static final String PRIVILEGE_PRINCIPAL_NAME_PROPERTY_ID = PrivilegeResourceProvider.PRINCIPAL_NAME;
-  protected static final String PRIVILEGE_PRINCIPAL_TYPE_PROPERTY_ID = PrivilegeResourceProvider.PRINCIPAL_TYPE;
-  protected static final String PRIVILEGE_VIEW_NAME_PROPERTY_ID = ViewPrivilegeResourceProvider.VIEW_NAME;
-  protected static final String PRIVILEGE_VIEW_VERSION_PROPERTY_ID = ViewPrivilegeResourceProvider.VERSION;
-  protected static final String PRIVILEGE_INSTANCE_NAME_PROPERTY_ID = ViewPrivilegeResourceProvider.INSTANCE_NAME;
-  protected static final String PRIVILEGE_CLUSTER_NAME_PROPERTY_ID = ClusterPrivilegeResourceProvider.PRIVILEGE_CLUSTER_NAME_PROPERTY_ID;
-  protected static final String PRIVILEGE_TYPE_PROPERTY_ID = AmbariPrivilegeResourceProvider.PRIVILEGE_TYPE_PROPERTY_ID;
-  protected static final String PRIVILEGE_GROUP_NAME_PROPERTY_ID = "PrivilegeInfo/group_name";
+  protected static final String GROUP_NAME_PROPERTY_ID = "group_name";
+
+  protected static final String PRIVILEGE_ID = PrivilegeResourceProvider.PRIVILEGE_ID;
+  protected static final String PERMISSION_NAME = PrivilegeResourceProvider.PERMISSION_NAME;
+  protected static final String PERMISSION_LABEL = PrivilegeResourceProvider.PERMISSION_LABEL;
+  protected static final String PRINCIPAL_NAME = PrivilegeResourceProvider.PRINCIPAL_NAME;
+  protected static final String PRINCIPAL_TYPE = PrivilegeResourceProvider.PRINCIPAL_TYPE;
+  protected static final String VIEW_NAME = ViewPrivilegeResourceProvider.VIEW_NAME;
+  protected static final String VIEW_VERSION = ViewPrivilegeResourceProvider.VERSION;
+  protected static final String INSTANCE_NAME = ViewPrivilegeResourceProvider.INSTANCE_NAME;
+  protected static final String CLUSTER_NAME = ClusterPrivilegeResourceProvider.CLUSTER_NAME;
+  protected static final String TYPE = AmbariPrivilegeResourceProvider.TYPE;
+  protected static final String GROUP_NAME = PrivilegeResourceProvider.PRIVILEGE_INFO + PropertyHelper.EXTERNAL_PATH_SEP + GROUP_NAME_PROPERTY_ID;
 
   /**
    * Data access object used to obtain cluster entities.
@@ -98,17 +101,17 @@ public class GroupPrivilegeResourceProvider extends ReadOnlyResourceProvider {
    * The property ids for a privilege resource.
    */
   private static Set<String> propertyIds = Sets.newHashSet(
-      PRIVILEGE_PRIVILEGE_ID_PROPERTY_ID,
-      PRIVILEGE_PERMISSION_NAME_PROPERTY_ID,
-      PRIVILEGE_PERMISSION_LABEL_PROPERTY_ID,
-      PRIVILEGE_PRINCIPAL_NAME_PROPERTY_ID,
-      PRIVILEGE_PRINCIPAL_TYPE_PROPERTY_ID,
-      PRIVILEGE_VIEW_NAME_PROPERTY_ID,
-      PRIVILEGE_VIEW_VERSION_PROPERTY_ID,
-      PRIVILEGE_INSTANCE_NAME_PROPERTY_ID,
-      PRIVILEGE_CLUSTER_NAME_PROPERTY_ID,
-      PRIVILEGE_TYPE_PROPERTY_ID,
-      PRIVILEGE_GROUP_NAME_PROPERTY_ID);
+      PRIVILEGE_ID,
+      PERMISSION_NAME,
+      PERMISSION_LABEL,
+      PRINCIPAL_NAME,
+      PRINCIPAL_TYPE,
+      VIEW_NAME,
+      VIEW_VERSION,
+      INSTANCE_NAME,
+      CLUSTER_NAME,
+      TYPE,
+      GROUP_NAME);
 
   /**
    * Static initialization.
@@ -128,16 +131,16 @@ public static void init(ClusterDAO clusterDAO, GroupDAO groupDAO,
   @SuppressWarnings("serial")
   private static Set<String> pkPropertyIds = new HashSet<String>() {
     {
-      add(PRIVILEGE_PRIVILEGE_ID_PROPERTY_ID);
+      add(PRIVILEGE_ID);
     }
   };
 
   /**
    * The key property ids for a privilege resource.
    */
   private static Map<Resource.Type, String> keyPropertyIds = ImmutableMap.<Resource.Type, String>builder()
-      .put(Resource.Type.Group, PRIVILEGE_GROUP_NAME_PROPERTY_ID)
-      .put(Resource.Type.GroupPrivilege, PRIVILEGE_PRIVILEGE_ID_PROPERTY_ID)
+      .put(Resource.Type.Group, GROUP_NAME)
+      .put(Resource.Type.GroupPrivilege, PRIVILEGE_ID)
       .build();
 
 
@@ -174,7 +177,7 @@ public Set<Resource> getResources(Request request, Predicate predicate)
     }
 
     for (Map<String, Object> propertyMap : getPropertyMaps(predicate)) {
-      final String groupName = (String) propertyMap.get(PRIVILEGE_GROUP_NAME_PROPERTY_ID);
+      final String groupName = (String) propertyMap.get(GROUP_NAME);
 
       if (groupName != null) {
         GroupEntity groupEntity = groupDAO.findGroupByName(groupName);
@@ -251,25 +254,25 @@ protected GroupPrivilegeResponse getResponse(PrivilegeEntity privilegeEntity, St
   protected Resource toResource(GroupPrivilegeResponse response, Set<String> requestedIds) {
     final ResourceImpl resource = new ResourceImpl(Resource.Type.GroupPrivilege);
 
-    setResourceProperty(resource, PRIVILEGE_GROUP_NAME_PROPERTY_ID, response.getGroupName(), requestedIds);
-    setResourceProperty(resource, PRIVILEGE_PRIVILEGE_ID_PROPERTY_ID, response.getPrivilegeId(), requestedIds);
-    setResourceProperty(resource, PRIVILEGE_PERMISSION_NAME_PROPERTY_ID, response.getPermissionName(), requestedIds);
-    setResourceProperty(resource, PRIVILEGE_PERMISSION_LABEL_PROPERTY_ID, response.getPermissionLabel(), requestedIds);
-    setResourceProperty(resource, PRIVILEGE_PRINCIPAL_TYPE_PROPERTY_ID, response.getPrincipalType().name(), requestedIds);
+    setResourceProperty(resource, GROUP_NAME, response.getGroupName(), requestedIds);
+    setResourceProperty(resource, PRIVILEGE_ID, response.getPrivilegeId(), requestedIds);
+    setResourceProperty(resource, PERMISSION_NAME, response.getPermissionName(), requestedIds);
+    setResourceProperty(resource, PERMISSION_LABEL, response.getPermissionLabel(), requestedIds);
+    setResourceProperty(resource, PRINCIPAL_TYPE, response.getPrincipalType().name(), requestedIds);
     if (response.getPrincipalName() != null) {
-      setResourceProperty(resource, PRIVILEGE_PRINCIPAL_NAME_PROPERTY_ID, response.getPrincipalName(), requestedIds);
+      setResourceProperty(resource, PRINCIPAL_NAME, response.getPrincipalName(), requestedIds);
     }
 
     if (response.getType() != null) {
-      setResourceProperty(resource, PRIVILEGE_TYPE_PROPERTY_ID, response.getType().name(), requestedIds);
+      setResourceProperty(resource, TYPE, response.getType().name(), requestedIds);
       switch (response.getType()) {
         case CLUSTER:
-          setResourceProperty(resource, PRIVILEGE_CLUSTER_NAME_PROPERTY_ID, response.getClusterName(), requestedIds);
+          setResourceProperty(resource, CLUSTER_NAME, response.getClusterName(), requestedIds);
           break;
         case VIEW:
-          setResourceProperty(resource, PRIVILEGE_VIEW_NAME_PROPERTY_ID, response.getViewName(), requestedIds);
-          setResourceProperty(resource, PRIVILEGE_VIEW_VERSION_PROPERTY_ID, response.getVersion(), requestedIds);
-          setResourceProperty(resource, PRIVILEGE_INSTANCE_NAME_PROPERTY_ID, response.getInstanceName(), requestedIds);
+          setResourceProperty(resource, VIEW_NAME, response.getViewName(), requestedIds);
+          setResourceProperty(resource, VIEW_VERSION, response.getVersion(), requestedIds);
+          setResourceProperty(resource, INSTANCE_NAME, response.getInstanceName(), requestedIds);
           break;
       }