Package com.xebialabs.deployit.engine.api

Interface MetadataService

  • @Path("/metadata")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
public interface MetadataService
    Provides XL Deploy's metadata: available types, permissions and orchestrators.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.xebialabs.deployit.plugin.api.reflect.Descriptor findDescriptor​(com.xebialabs.deployit.plugin.api.reflect.Type type)
      Gets the Descriptor for a specific type from the XL Deploy Type System.
      java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> inheritance()
      Creates a map of the parent/child relationships of all the types known to the XL Deploy Type System.
      java.util.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor> listDescriptors()
      Lists all the Descriptors of all the types known to the XL Deploy Type System.
      java.util.List<java.lang.String> listOrchestrators()
      Lists all the Orchestrator names that can be used to orchestrate a Deployment done by the DeploymentService.
      java.util.List<Permission> listPermissions()
      Lists all the Permissions that can be granted or revoked.

    • Method Detail

      • listDescriptors

        @GET
@Path("type")
java.util.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor> listDescriptors()
        Lists all the Descriptors of all the types known to the XL Deploy Type System. Hidden properties are not exposed.
        Returns:
        A List of Descriptors

      • inheritance

        @GET
@Path("types/inheritance")
java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> inheritance()
        Creates a map of the parent/child relationships of all the types known to the XL Deploy Type System.
        Returns:
        A Map of descriptor type name to list of children types.

      • findDescriptor

        @GET
@Path("type/{type}")
com.xebialabs.deployit.plugin.api.reflect.Descriptor findDescriptor​(@PathParam("type")
                                                                    com.xebialabs.deployit.plugin.api.reflect.Type type)
        Gets the Descriptor for a specific type from the XL Deploy Type System.
        Parameters:
        type - the type to get the descriptor of.
        Returns:
        The descriptor matching the type

      • listPermissions

        @GET
@Path("permissions")
java.util.List<Permission> listPermissions()
        Lists all the Permissions that can be granted or revoked.
        Returns:
        A List of Permissions

      • listOrchestrators

        @GET
@Path("orchestrators")
java.util.List<java.lang.String> listOrchestrators()
        Lists all the Orchestrator names that can be used to orchestrate a Deployment done by the DeploymentService.
        Returns:
        A List of orchestrator names.