Examples of org.sonar.api.resources.ResourceType

org.sonar.api.resources.ResourceType

Experimental extension to declare types of resources.

Since 3.0, ResourceType object can declare properties that give information about the capabilities of the resource type. Those properties may be used, of instance, to adapt the Web UI according to the type of the resource being displayed.
Currently, the following properties can be defined:

"deletable": if set to "true", then this resource can be deleted/purged.
"supportsMeasureFilters": if set to "true", then this resource can be displayed in measure filters
"modifiable_history": if set to "true", then the history of this resource may be modified (deletion of snapshots, modification of events, ...)
"updatable_key" (since 3.2): if set to "true", then it is possible to update the key of this resource
"supportsGlobalDashboards" (since 3.2): if true, this resource can be displayed in global dashboards
"hasRolePolicy" : if true, roles configuration is available in sidebar
"comparable" (since 3.4) : if true, the resource can be compared to other resources
"configurable" (since 3.6) : if true, the settings page can be displayed on the resource

@since 2.14


  @Test
  public void projects_should_be_available_for_global_widgets() {
    ResourceTypeTree tree = new DefaultResourceTypes().provide();


    ResourceType projectResourceType = tree.getTypes().get(0);


    assertThat(projectResourceType.getQualifier()).isEqualTo(Qualifiers.PROJECT);
    assertThat(projectResourceType.getBooleanProperty("supportsGlobalDashboards")).isTrue();
  }

  public ResourceType getResourceType(String qualifier) {
    return get(ResourceTypes.class).get(qualifier);
  }


  public String getResourceTypeStringProperty(String resourceTypeQualifier, String resourceTypeProperty) {
    ResourceType resourceType = getResourceType(resourceTypeQualifier);
    if (resourceType != null) {
      return resourceType.getStringProperty(resourceTypeProperty);
    }
    return null;
  }

    }
    return qualifiers;
  }


  public Boolean getResourceTypeBooleanProperty(String resourceTypeQualifier, String resourceTypeProperty) {
    ResourceType resourceType = getResourceType(resourceTypeQualifier);
    if (resourceType != null) {
      return resourceType.getBooleanProperty(resourceTypeProperty);
    }
    return null;
  }

Examples of org.sonar.api.resources.ResourceType

Related Classes of org.sonar.api.resources.ResourceType